├── .eslintignore ├── .eslintrc.cjs ├── .eslintrc.template ├── .gitattributes ├── .github ├── ISSUE_TEMPLATE │ └── bug_report.md └── workflows │ ├── main.yaml │ └── semver-check.yaml ├── .gitignore ├── .npmignore ├── .releaserc.cjs ├── .renovaterc.json ├── .tidelift.yml ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── Contributing.md ├── LICENSE ├── PULL_REQUEST_TEMPLATE.md ├── README.md ├── cli.js ├── crowdin.yml ├── examples ├── abstract.md ├── docs │ ├── README.md │ ├── abstract-definitions-first-properties-foo.md │ ├── abstract-definitions-first-properties-nonfoo.md │ ├── abstract-definitions-first.md │ ├── abstract-definitions-second-properties-bar.md │ ├── abstract-definitions-second.md │ ├── abstract-definitions.md │ ├── abstract.md │ ├── arrays-properties-boollist-items.md │ ├── arrays-properties-boollist.md │ ├── arrays-properties-coordinatelist-items-items.md │ ├── arrays-properties-coordinatelist-items.md │ ├── arrays-properties-coordinatelist.md │ ├── arrays-properties-intlist-items.md │ ├── arrays-properties-intlist.md │ ├── arrays-properties-jointypelist-items-oneof-0-properties-foo.md │ ├── arrays-properties-jointypelist-items-oneof-0.md │ ├── arrays-properties-jointypelist-items-oneof-1-properties-bar.md │ ├── arrays-properties-jointypelist-items-oneof-1.md │ ├── arrays-properties-jointypelist-items.md │ ├── arrays-properties-jointypelist.md │ ├── arrays-properties-list-items.md │ ├── arrays-properties-list.md │ ├── arrays-properties-listlist-items.md │ ├── arrays-properties-listlist.md │ ├── arrays-properties-numlist-items.md │ ├── arrays-properties-numlist.md │ ├── arrays-properties-objectlist-items-properties-a.md │ ├── arrays-properties-objectlist-items-properties-b.md │ ├── arrays-properties-objectlist-items.md │ ├── arrays-properties-objectlist.md │ ├── arrays-properties-stringlistlist-items-items.md │ ├── arrays-properties-stringlistlist-items.md │ ├── arrays-properties-stringlistlist.md │ ├── arrays-properties-tuple-items-negative-integer.md │ ├── arrays-properties-tuple-items-positive-integer.md │ ├── arrays-properties-tuple-zero.md │ ├── arrays-properties-tuple.md │ ├── arrays.md │ ├── complex-additionalproperties.md │ ├── complex-patternproperties-int.md │ ├── complex-patternproperties-str.md │ ├── complex-patternproperties.md │ ├── complex-properties-and-allof-0.md │ ├── complex-properties-and-allof-1.md │ ├── complex-properties-and.md │ ├── complex-properties-or-anyof-0.md │ ├── complex-properties-or-anyof-1.md │ ├── complex-properties-or.md │ ├── complex-properties-reflocalfiledef.md │ ├── complex-properties-refnestedobj-properties-refobj.md │ ├── complex-properties-refnestedobj.md │ ├── complex-properties-refobj.md │ ├── complex-properties-xor-oneof-0.md │ ├── complex-properties-xor-oneof-1.md │ ├── complex-properties-xor.md │ ├── complex.md │ ├── constants-properties-hello.md │ ├── constants.md │ ├── custom-allof-0.md │ ├── custom-allof-1.md │ ├── custom-allof-2.md │ ├── custom-definitions-first-properties-foo.md │ ├── custom-definitions-first-properties.md │ ├── custom-definitions-first.md │ ├── custom-definitions-second-properties-bar.md │ ├── custom-definitions-second-properties.md │ ├── custom-definitions-second.md │ ├── custom-definitions.md │ ├── custom.md │ ├── deepextending-allof-0.md │ ├── deepextending-allof-1.md │ ├── deepextending-allof-3.md │ ├── deepextending-definitions-fourth-properties-hey.md │ ├── deepextending-definitions-fourth-properties.md │ ├── deepextending-definitions-fourth.md │ ├── deepextending-definitions.md │ ├── deepextending.md │ ├── definitions-definitions-myid-properties-id-1.md │ ├── definitions-definitions-myid-properties-id.md │ ├── definitions-definitions-myid-properties-metaid.md │ ├── definitions-definitions-myid-properties.md │ ├── definitions-definitions-myid.md │ ├── definitions-definitions.md │ ├── definitions.md │ ├── enums-properties-enumerated-nested-properties-test.md │ ├── enums-properties-enumerated-nested.md │ ├── enums-properties-hello.md │ ├── enums.md │ ├── example-properties-bar.md │ ├── example-properties-foo.md │ ├── example.md │ ├── examples-properties-bar.md │ ├── examples-properties-foo.md │ ├── examples.md │ ├── extending-definitions-third-properties-baaaz.md │ ├── extending-definitions-third.md │ ├── extending-definitions.md │ ├── extending.md │ ├── extensible-definitions-first-properties-foo.md │ ├── extensible-definitions-first-properties.md │ ├── extensible-definitions-first.md │ ├── extensible-definitions-second-properties-bar.md │ ├── extensible-definitions-second-properties.md │ ├── extensible-definitions-second.md │ ├── extensible-definitions.md │ ├── extensible.md │ ├── identifiable-properties-id.md │ ├── identifiable.md │ ├── join-oneof-0-not-oneof-0-properties-foo.md │ ├── join-oneof-0-not-oneof-0.md │ ├── join-oneof-0-not-oneof-1-properties-bar.md │ ├── join-oneof-0-not-oneof-1.md │ ├── join-oneof-0-not.md │ ├── join-oneof-0.md │ ├── join-oneof-1-allof-0-properties-foo.md │ ├── join-oneof-1-allof-0.md │ ├── join-oneof-1.md │ ├── join-oneof-2-anyof-0-properties-bar.md │ ├── join-oneof-2-anyof-0.md │ ├── join-oneof-2.md │ ├── join.md │ ├── nestedobj-properties-settings-properties-collaborators-patternproperties-.md │ ├── nestedobj-properties-settings-properties-collaborators-patternproperties.md │ ├── nestedobj-properties-settings-properties-collaborators-properties-id.md │ ├── nestedobj-properties-settings-properties-collaborators.md │ ├── nestedobj-properties-settings.md │ ├── nestedobj.md │ ├── pattern-patternproperties-0-9.md │ ├── pattern-patternproperties.md │ ├── pattern.md │ ├── simple-properties-id.md │ ├── simple.md │ ├── simpletypes-properties-integer_threes.md │ ├── simpletypes-properties-interger_constrained.md │ ├── simpletypes-properties-interger_unconstrained.md │ ├── simpletypes-properties-number_constrained.md │ ├── simpletypes-properties-number_unconstrained.md │ ├── simpletypes-properties-string_date.md │ ├── simpletypes-properties-string_email.md │ ├── simpletypes-properties-string_hostname.md │ ├── simpletypes-properties-string_ipv4.md │ ├── simpletypes-properties-string_ipv6.md │ ├── simpletypes-properties-string_length.md │ ├── simpletypes-properties-string_pattern-metaenum.md │ ├── simpletypes-properties-string_pattern.md │ ├── simpletypes-properties-string_pattern_noexample.md │ ├── simpletypes-properties-string_pattern_singleexample.md │ ├── simpletypes-properties-string_unconstrained.md │ ├── simpletypes-properties-string_uri.md │ ├── simpletypes-properties-yesno.md │ ├── simpletypes.md │ ├── stabilizing-properties-id.md │ ├── stabilizing.md │ ├── subdir-allof-0.md │ ├── subdir-definitions-content-properties-id.md │ ├── subdir-definitions-content-properties.md │ ├── subdir-definitions-content.md │ ├── subdir-definitions.md │ ├── subdir.md │ ├── typearrays-properties-null.md │ ├── typearrays-properties-string-or-null.md │ ├── typearrays-properties-string-or-number-null.md │ ├── typearrays-properties-string-or-number.md │ └── typearrays.md ├── docsWithoutHeader │ └── arrays.schema.md ├── generated-schemas │ ├── abstract.schema.json │ ├── arrays.schema.json │ ├── complex.schema.json │ ├── constants.schema.json │ ├── custom.schema.json │ ├── deepextending.schema.json │ ├── definitions.schema.json │ ├── enums.schema.json │ ├── example.schema.json │ ├── examples.schema.json │ ├── extending.schema.json │ ├── extensible.schema.json │ ├── identifiable.schema.json │ ├── join.schema.json │ ├── nestedobj.schema.json │ ├── pattern.schema.json │ ├── simple.schema.json │ ├── simpletypes.schema.json │ ├── stabilizing.schema.json │ ├── subdir.schema.json │ ├── subdir │ │ └── subdir.schema.json │ └── typearrays.schema.json ├── schemas │ ├── abstract.schema.json │ ├── arrays.schema.json │ ├── complex.schema.json │ ├── constants.schema.json │ ├── custom.schema.json │ ├── deepextending.schema.json │ ├── definitions.description.md │ ├── definitions.schema.json │ ├── enums.schema.json │ ├── example.example.1.json │ ├── example.schema.json │ ├── examples.example.1.json │ ├── examples.example.2.json │ ├── examples.schema.json │ ├── extending.schema.json │ ├── extensible.schema.json │ ├── identifiable.schema.json │ ├── join.schema.json │ ├── nestedobj.schema.json │ ├── pattern.schema.json │ ├── simple.schema.json │ ├── simpletypes.schema.json │ ├── stabilizing.schema.json │ ├── subdir │ │ └── subdir.schema.json │ └── typearrays.schema.json └── status.md ├── lib ├── formatInfo.js ├── formattingTools.js ├── index.js ├── keywords.js ├── locales │ ├── de.json │ ├── en_US.json │ ├── nl_NL.json │ └── update.js ├── markdownBuilder.js ├── readmeBuilder.js ├── schemaProxy.js ├── symbols.js ├── traverseSchema.js ├── writeMarkdown.js └── writeSchema.js ├── package-lock.json ├── package.json ├── schemasupport.md ├── test ├── api.test.js ├── cyclicSchemaIntegration.test.js ├── fixtures │ ├── additionalprops │ │ ├── additionalprops.schema.json │ │ └── arrays.schema.json │ ├── arrays │ │ ├── arrays.schema.json │ │ └── tuple.schema.json │ ├── content │ │ ├── html.schema.json │ │ ├── jwt.schema.json │ │ └── png.schema.json │ ├── cyclic │ │ ├── one.description.md │ │ ├── one.example.1.json │ │ ├── one.schema.json │ │ ├── three.schema.json │ │ └── two.schema.json │ ├── deadref │ │ └── deadref.schema.json │ ├── enums │ │ ├── arrayenums.schema.json │ │ ├── enum-meta-enum.schema.json │ │ └── enums.schema.json │ ├── example │ │ ├── api.schema.json │ │ ├── proxy.schema.json │ │ └── traverse.schema.json │ ├── format │ │ └── format.schema.json │ ├── identifiable │ │ └── identifiable.schema.json │ ├── not │ │ └── not.schema.json │ ├── null │ │ └── null.schema.json │ ├── nullable │ │ └── array.schema.json │ ├── readme-1 │ │ ├── abstract.schema.json │ │ ├── complex.schema.json │ │ └── simple.schema.json │ ├── skipproperties │ │ └── complete.schema.json │ ├── stringformats │ │ └── simpletypes.schema.json │ ├── title │ │ └── meta.schema.json │ ├── type │ │ ├── button.schema.json │ │ └── type.schema.json │ └── types │ │ ├── merged.schema.json │ │ ├── object.schema.json │ │ ├── objectorarray.schema.json │ │ ├── undefined.schema.json │ │ └── wrong.schema.json ├── formatting.test.js ├── markdownBuilder.test.js ├── readmeBuilder.test.js ├── schemaProxy.test.js ├── testUtils.js ├── testintegration.test.js ├── traverseSchema.test.js └── zSchemaCoverage.test.js ├── tsconfig.json └── types ├── api.d.ts ├── formatInfo.d.ts ├── formattingTools.d.ts ├── index.d.ts ├── keywords.d.ts ├── markdownBuilder.d.ts ├── readmeBuilder.d.ts ├── schemaProxy.d.ts ├── symbols.d.ts ├── traverseSchema.d.ts ├── writeMarkdown.d.ts └── writeSchema.d.ts /.eslintignore: -------------------------------------------------------------------------------- 1 | .vscode/* 2 | coverage/* 3 | -------------------------------------------------------------------------------- /.eslintrc.cjs: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Adobe. All rights reserved. 3 | * This file is licensed to you under the Apache License, Version 2.0 (the "License"); 4 | * you may not use this file except in compliance with the License. You may obtain a copy 5 | * of the License at http://www.apache.org/licenses/LICENSE-2.0 6 | * 7 | * Unless required by applicable law or agreed to in writing, software distributed under 8 | * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS 9 | * OF ANY KIND, either express or implied. See the License for the specific language 10 | * governing permissions and limitations under the License. 11 | */ 12 | 13 | module.exports = { 14 | root: true, 15 | extends: '@adobe/helix', 16 | rules: { 17 | strict: 0, 18 | 19 | // Forbid multiple statements in one line 20 | 'max-statements-per-line': ['error', { max: 1 }], 21 | 22 | // Allow for-of loops 23 | 'no-restricted-syntax': ['error', 'ForInStatement', 'LabeledStatement', 'WithStatement'], 24 | 25 | // Allow return before else & redundant else statements 26 | 'no-else-return': 'off', 27 | 28 | // allow dangling underscores for 'fields' 29 | 'no-underscore-dangle': 'off', 30 | 31 | // Allow marking variables unused using a underscore at the start 32 | 'no-unused-vars': ['error', { 33 | varsIgnorePattern: '^_.*$', 34 | argsIgnorePattern: '^_.*$', 35 | caughtErrorsIgnorePattern: '^_.*$', 36 | }], 37 | 38 | 'import/no-named-as-default-member': 0, 39 | 'default-param-last': 0, 40 | }, 41 | }; 42 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | *.* eol=lf 2 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | ## What did you do 2 | 3 | ## What did you expect to happen 4 | 5 | ## What happened 6 | 7 | ## What's your environment 8 | 9 | * Operating System: 10 | * node.js version: 11 | 12 | ## Do you have example files: 13 | 14 | For this schema 15 | ```json 16 | 17 | ``` 18 | 19 | I'm getting following Markdown 20 | 21 | ```markdown 22 | 23 | ``` -------------------------------------------------------------------------------- /.github/workflows/main.yaml: -------------------------------------------------------------------------------- 1 | name: Build 2 | on: [push] 3 | 4 | env: 5 | CI_BUILD_NUM: ${{ github.run_id }} 6 | CI_BRANCH: ${{ github.ref_name }} 7 | CIRCLE_REPOSITORY_URL: dummy-url 8 | 9 | jobs: 10 | build: 11 | name: Test 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v4 15 | - name: Use Node.js 20.x 16 | uses: actions/setup-node@v4 17 | with: 18 | node-version: '20.x' 19 | - run: npm install 20 | - run: git config --global user.email "test@project-helix.io" && git config --global user.name "Test Build" 21 | - run: npm test 22 | - uses: codecov/codecov-action@v4 23 | with: 24 | token: ${{ secrets.CODECOV_TOKEN }} 25 | 26 | build_win: 27 | name: Test (Windows) 28 | runs-on: windows-latest 29 | steps: 30 | - run: git config --global core.autocrlf false 31 | - uses: actions/checkout@v4 32 | - name: Use Node.js 20.x 33 | uses: actions/setup-node@v4 34 | with: 35 | node-version: '20.x' 36 | - run: npm install 37 | - run: git config --global user.email "test@project-helix.io" && git config --global user.name "Test Build" 38 | - run: npm test 39 | 40 | release: 41 | name: Release 42 | runs-on: ubuntu-latest 43 | if: github.ref == 'refs/heads/main' 44 | needs: [build, build_win] 45 | steps: 46 | - uses: actions/checkout@v4 47 | with: 48 | persist-credentials: false 49 | - name: Use Node.js 20.x 50 | uses: actions/setup-node@v4 51 | with: 52 | node-version: '20.x' 53 | - run: npm install 54 | - run: npm run semantic-release 55 | env: 56 | GITHUB_TOKEN: ${{ secrets.MY_GITHUB_TOKEN }} 57 | NPM_TOKEN: ${{ secrets.ADOBE_BOT_NPM_TOKEN }} 58 | -------------------------------------------------------------------------------- /.github/workflows/semver-check.yaml: -------------------------------------------------------------------------------- 1 | on: 2 | push: 3 | branches-ignore: 4 | - 'main' 5 | 6 | jobs: 7 | ci_trigger: 8 | runs-on: ubuntu-latest 9 | name: Comment Semantic Release Status 10 | steps: 11 | - name: Comment 12 | id: comment 13 | uses: adobe-rnd/github-semantic-release-comment-action@main 14 | with: 15 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 16 | 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | out/ 2 | tmp/ 3 | *.tgz 4 | *.zip 5 | 6 | # ide files 7 | .project 8 | .settings 9 | .idea/ 10 | /.vscode 11 | *.iml 12 | 13 | # node specific files 14 | node_modules/ 15 | lib-cov 16 | *.seed 17 | *.log 18 | *.csv 19 | *.dat 20 | *.out 21 | *.pid 22 | *.gz 23 | pids 24 | logs 25 | results 26 | npm-debug.log 27 | 28 | # mac files 29 | .DS_Store 30 | 31 | .tool-versions 32 | 33 | # instanbul code coverage… 34 | .nyc_output/ 35 | coverage/ 36 | /examples/tmp-docs 37 | junit/ 38 | test/fixtures/cyclic-out/ 39 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | out/ 2 | tmp/ 3 | *.tgz 4 | *.zip 5 | 6 | # ide files 7 | .project 8 | .settings 9 | .idea/ 10 | .vscode/ 11 | *.iml 12 | 13 | # node specific files 14 | node_modules/ 15 | lib-cov 16 | *.seed 17 | *.log 18 | *.csv 19 | *.dat 20 | *.out 21 | *.pid 22 | *.gz 23 | pids 24 | logs 25 | results 26 | npm-debug.log 27 | 28 | # mac files 29 | .DS_Store 30 | 31 | .tool-versions 32 | 33 | # instanbul code coverage… 34 | .nyc_output/ 35 | coverage/ 36 | /examples/ 37 | junit/ 38 | test/ 39 | tsconfig.json 40 | 41 | # CI/CD 42 | .circleci/ 43 | .github/ 44 | .renovaterc.json 45 | .tidelift.yml 46 | crowdin.yml 47 | -------------------------------------------------------------------------------- /.releaserc.cjs: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | plugins: [ 3 | "@semantic-release/commit-analyzer", 4 | "@semantic-release/release-notes-generator", 5 | ["@semantic-release/github", {}], 6 | ["@semantic-release/changelog", { 7 | "changelogFile": "CHANGELOG.md", 8 | }], 9 | "@semantic-release/git", 10 | "@semantic-release/npm", 11 | ], 12 | branches: ['main'], 13 | }; 14 | -------------------------------------------------------------------------------- /.renovaterc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": ["github>adobe/helix-shared"] 3 | } 4 | -------------------------------------------------------------------------------- /.tidelift.yml: -------------------------------------------------------------------------------- 1 | licensing: 2 | disallowed: 3 | - AGPL-1.0-only 4 | - AGPL-1.0-or-later 5 | - AGPL-3.0-only 6 | - AGPL-3.0-or-later 7 | - AGPL-1.0 8 | - AGPL-3.0 9 | - CC-BY-NC-ND-1.0 10 | - CC-BY-NC-ND-2.0 11 | - CC-BY-NC-ND-2.5 12 | - CC-BY-NC-ND-3.0 13 | - CC-BY-NC-ND-4.0 14 | - CC-BY-NC-SA-1.0 15 | - CC-BY-NC-SA-2.0 16 | - CC-BY-NC-SA-2.5 17 | - CC-BY-NC-SA-3.0 18 | - CC-BY-NC-SA-4.0 19 | - CC-BY-SA-1.0 20 | - CC-BY-SA-2.0 21 | - CC-BY-SA-2.5 22 | - CC-BY-SA-3.0 23 | - CC-BY-SA-4.0 24 | - GPL-1.0-only 25 | - GPL-1.0-or-later 26 | - GPL-2.0-only 27 | - GPL-2.0-or-later 28 | - GPL-3.0-only 29 | - GPL-3.0-or-later 30 | - SSPL-1.0 31 | - Sleepycat 32 | - Facebook -------------------------------------------------------------------------------- /PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Please mention the issue #… in the pull request. 2 | 3 | Please remember to follow the documented [commit process](https://github.com/adobe/jsonschema2md/blob/master/Contributing.md#commit-message-format), specifcally commit using `npm run commit` which will construct the commit template required for automated semantic releases. 4 | -------------------------------------------------------------------------------- /cli.js: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env node 2 | /* 3 | * Copyright 2019 Adobe. All rights reserved. 4 | * This file is licensed to you under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. You may obtain a copy 6 | * of the License at http://www.apache.org/licenses/LICENSE-2.0 7 | * 8 | * Unless required by applicable law or agreed to in writing, software distributed under 9 | * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS 10 | * OF ANY KIND, either express or implied. See the License for the specific language 11 | * governing permissions and limitations under the License. 12 | */ 13 | 14 | import { main } from './lib/index.js'; 15 | 16 | main(process.argv); 17 | -------------------------------------------------------------------------------- /crowdin.yml: -------------------------------------------------------------------------------- 1 | commit_message: "fix(i18n): update localization" 2 | files: 3 | - source: /lib/locales/en_US.json 4 | translation: /lib/locales/%two_letters_code%.json 5 | -------------------------------------------------------------------------------- /examples/abstract.md: -------------------------------------------------------------------------------- 1 | # What is Abstract? 2 | 3 | Something that cannot be instantiated. 4 | -------------------------------------------------------------------------------- /examples/docs/abstract-definitions-first-properties-foo.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Abstract Schema 2 | 3 | ```txt 4 | https://example.com/schemas/abstract#/definitions/first/properties/foo 5 | ``` 6 | 7 | A unique identifier given to every addressable thing. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [abstract.schema.json*](../generated-schemas/abstract.schema.json "open original schema") | 12 | 13 | ## foo Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/abstract-definitions-first-properties-nonfoo.md: -------------------------------------------------------------------------------- 1 | # Untitled boolean in Abstract Schema 2 | 3 | ```txt 4 | https://example.com/schemas/abstract#/definitions/first/properties/nonfoo 5 | ``` 6 | 7 | This is not foo. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [abstract.schema.json*](../generated-schemas/abstract.schema.json "open original schema") | 12 | 13 | ## nonfoo Type 14 | 15 | `boolean` 16 | 17 | ## nonfoo Constraints 18 | 19 | **constant**: the value of this property must be equal to: 20 | 21 | ```json 22 | false 23 | ``` 24 | -------------------------------------------------------------------------------- /examples/docs/abstract-definitions-second-properties-bar.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Abstract Schema 2 | 3 | ```txt 4 | https://example.com/schemas/abstract#/definitions/second/properties/bar 5 | ``` 6 | 7 | A unique identifier given to every addressable thing. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [abstract.schema.json*](../generated-schemas/abstract.schema.json "open original schema") | 12 | 13 | ## bar Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/abstract-definitions.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Abstract Schema 2 | 3 | ```txt 4 | https://example.com/schemas/abstract#/definitions 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [abstract.schema.json*](../generated-schemas/abstract.schema.json "open original schema") | 12 | 13 | ## definitions Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-boollist-items.md: -------------------------------------------------------------------------------- 1 | # Untitled boolean in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/boollist/items 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## items Type 14 | 15 | `boolean` 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-boollist.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/boollist 5 | ``` 6 | 7 | This is an array 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## boollist Type 14 | 15 | `boolean[]` 16 | 17 | ## boollist Constraints 18 | 19 | **minimum number of items**: the minimum number of items for this array is: `1` 20 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-coordinatelist-items-items.md: -------------------------------------------------------------------------------- 1 | # Untitled number in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/coordinatelist/items/items 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## items Type 14 | 15 | `number` 16 | 17 | ## items Constraints 18 | 19 | **maximum**: the value of this number must smaller than or equal to: `10` 20 | 21 | **minimum**: the value of this number must greater than or equal to: `0` 22 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-coordinatelist-items.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/coordinatelist/items 5 | ``` 6 | 7 | A coordinate, specified by `x`, `y`, and `z` values 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## items Type 14 | 15 | `number[]` 16 | 17 | ## items Constraints 18 | 19 | **maximum number of items**: the maximum number of items for this array is: `3` 20 | 21 | **minimum number of items**: the minimum number of items for this array is: `3` 22 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-coordinatelist.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/coordinatelist 5 | ``` 6 | 7 | This is an array of coordinates in three-dimensional space. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## coordinatelist Type 14 | 15 | `number[][]` 16 | 17 | ## coordinatelist Constraints 18 | 19 | **maximum number of items**: the maximum number of items for this array is: `10` 20 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-intlist-items.md: -------------------------------------------------------------------------------- 1 | # Untitled integer in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/intlist/items 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## items Type 14 | 15 | `integer` 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-intlist.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/intlist 5 | ``` 6 | 7 | This is an array 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## intlist Type 14 | 15 | `integer[]` 16 | 17 | ## intlist Constraints 18 | 19 | **maximum number of items**: the maximum number of items for this array is: `10` 20 | 21 | **minimum number of items**: the minimum number of items for this array is: `1` 22 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-jointypelist-items-oneof-0-properties-foo.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/JoinTypelist/items/oneOf/0/properties/foo 5 | ``` 6 | 7 | A simple string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## foo Type 14 | 15 | `string` 16 | 17 | ## foo Examples 18 | 19 | ```json 20 | "hello" 21 | ``` 22 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-jointypelist-items-oneof-1-properties-bar.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/JoinTypelist/items/oneOf/1/properties/bar 5 | ``` 6 | 7 | A simple string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## bar Type 14 | 15 | `string` 16 | 17 | ## bar Examples 18 | 19 | ```json 20 | "world" 21 | ``` 22 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-jointypelist-items.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/JoinTypelist/items 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## items Type 14 | 15 | merged type ([Details](arrays-properties-jointypelist-items.md)) 16 | 17 | one (and only one) of 18 | 19 | * [Untitled object in Arrays](arrays-properties-jointypelist-items-oneof-0.md "check type definition") 20 | 21 | * [Untitled object in Arrays](arrays-properties-jointypelist-items-oneof-1.md "check type definition") 22 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-jointypelist.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/JoinTypelist 5 | ``` 6 | 7 | An array of simple objects 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## JoinTypelist Type 14 | 15 | an array of merged types ([Details](arrays-properties-jointypelist-items.md)) 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-list-items.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/list/items 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## items Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-list.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/list 5 | ``` 6 | 7 | This is an array 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## list Type 14 | 15 | `string[]` 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-listlist-items.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/listlist/items 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## items Type 14 | 15 | `array` 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-listlist.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/listlist 5 | ``` 6 | 7 | This is an array of arrays 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## listlist Type 14 | 15 | `array[]` 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-numlist-items.md: -------------------------------------------------------------------------------- 1 | # Untitled number in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/numlist/items 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## items Type 14 | 15 | `number` 16 | 17 | ## items Constraints 18 | 19 | **minimum**: the value of this number must greater than or equal to: `10` 20 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-numlist.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/numlist 5 | ``` 6 | 7 | This is an array 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## numlist Type 14 | 15 | `number[]` 16 | 17 | ## numlist Constraints 18 | 19 | **maximum number of items**: the maximum number of items for this array is: `10` 20 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-objectlist-items-properties-a.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/objectlist/items/properties/a 5 | ``` 6 | 7 | The a property 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## a Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-objectlist-items-properties-b.md: -------------------------------------------------------------------------------- 1 | # Untitled integer in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/objectlist/items/properties/b 5 | ``` 6 | 7 | The b property 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## b Type 14 | 15 | `integer` 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-objectlist.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/objectlist 5 | ``` 6 | 7 | An array of simple objects 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## objectlist Type 14 | 15 | `object[]` ([Details](arrays-properties-objectlist-items.md)) 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-stringlistlist-items-items.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/stringlistlist/items/items 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## items Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-stringlistlist-items.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/stringlistlist/items 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## items Type 14 | 15 | `string[]` 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-stringlistlist.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/stringlistlist 5 | ``` 6 | 7 | This is an array of arrays of strings 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## stringlistlist Type 14 | 15 | `string[][]` 16 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-tuple-items-negative-integer.md: -------------------------------------------------------------------------------- 1 | # Negative Integer Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/tuple/items/1 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## 1 Type 14 | 15 | `integer` ([Negative Integer](arrays-properties-tuple-items-negative-integer.md)) 16 | 17 | ## 1 Constraints 18 | 19 | **maximum**: the value of this number must smaller than or equal to: `0` 20 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-tuple-items-positive-integer.md: -------------------------------------------------------------------------------- 1 | # Positive Integer Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/tuple/items/0 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## 0 Type 14 | 15 | `integer` ([Positive Integer](arrays-properties-tuple-items-positive-integer.md)) 16 | 17 | ## 0 Constraints 18 | 19 | **minimum**: the value of this number must greater than or equal to: `0` 20 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-tuple-zero.md: -------------------------------------------------------------------------------- 1 | # Zero Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/tuple/additionalItems 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## additionalItems Type 14 | 15 | unknown ([Zero](arrays-properties-tuple-zero.md)) 16 | 17 | ## additionalItems Constraints 18 | 19 | **constant**: the value of this property must be equal to: 20 | 21 | ```json 22 | 0 23 | ``` 24 | -------------------------------------------------------------------------------- /examples/docs/arrays-properties-tuple.md: -------------------------------------------------------------------------------- 1 | # Untitled array in Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/arrays#/properties/tuple 5 | ``` 6 | 7 | This is an array of two values, one positive, one negative. All additional values must be 0. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [arrays.schema.json*](../generated-schemas/arrays.schema.json "open original schema") | 12 | 13 | ## tuple Type 14 | 15 | an array where each item follows the corresponding schema in the following list: 16 | 17 | 1. [Positive Integer](arrays-properties-tuple-items-positive-integer.md "check type definition") 18 | 19 | 2. [Negative Integer](arrays-properties-tuple-items-negative-integer.md "check type definition") 20 | 21 | 3. and all following items must follow the schema: [Zero](arrays-properties-tuple-zero.md "check type definition") 22 | -------------------------------------------------------------------------------- /examples/docs/complex-additionalproperties.md: -------------------------------------------------------------------------------- 1 | # Untitled boolean in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/additionalProperties 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## additionalProperties Type 14 | 15 | `boolean` 16 | -------------------------------------------------------------------------------- /examples/docs/complex-patternproperties-int.md: -------------------------------------------------------------------------------- 1 | # Untitled integer in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/patternProperties/int.* 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## int.\* Type 14 | 15 | `integer` 16 | -------------------------------------------------------------------------------- /examples/docs/complex-patternproperties-str.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/patternProperties/str.* 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## str.\* Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/complex-patternproperties.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/patternProperties 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## patternProperties Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/complex-properties-and-allof-0.md: -------------------------------------------------------------------------------- 1 | # Untitled number in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/properties/and/allOf/0 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## 0 Type 14 | 15 | `number` 16 | 17 | ## 0 Constraints 18 | 19 | **maximum**: the value of this number must smaller than or equal to: `10` 20 | -------------------------------------------------------------------------------- /examples/docs/complex-properties-and-allof-1.md: -------------------------------------------------------------------------------- 1 | # Untitled number in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/properties/and/allOf/1 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## 1 Type 14 | 15 | `number` 16 | 17 | ## 1 Constraints 18 | 19 | **minimum**: the value of this number must greater than or equal to: `0` 20 | -------------------------------------------------------------------------------- /examples/docs/complex-properties-and.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/properties/and 5 | ``` 6 | 7 | Number in a range 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## and Type 14 | 15 | merged type ([Details](complex-properties-and.md)) 16 | 17 | all of 18 | 19 | * [Untitled number in Complex References](complex-properties-and-allof-0.md "check type definition") 20 | 21 | * [Untitled number in Complex References](complex-properties-and-allof-1.md "check type definition") 22 | -------------------------------------------------------------------------------- /examples/docs/complex-properties-or-anyof-0.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/properties/or/anyOf/0 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## 0 Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/complex-properties-or-anyof-1.md: -------------------------------------------------------------------------------- 1 | # Untitled number in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/properties/or/anyOf/1 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## 1 Type 14 | 15 | `number` 16 | 17 | ## 1 Constraints 18 | 19 | **minimum**: the value of this number must greater than or equal to: `0` 20 | -------------------------------------------------------------------------------- /examples/docs/complex-properties-or.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/properties/or 5 | ``` 6 | 7 | String or number… 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## or Type 14 | 15 | merged type ([Details](complex-properties-or.md)) 16 | 17 | any of 18 | 19 | * [Untitled string in Complex References](complex-properties-or-anyof-0.md "check type definition") 20 | 21 | * [Untitled number in Complex References](complex-properties-or-anyof-1.md "check type definition") 22 | -------------------------------------------------------------------------------- /examples/docs/complex-properties-xor-oneof-0.md: -------------------------------------------------------------------------------- 1 | # Untitled number in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/properties/xor/oneOf/0 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## 0 Type 14 | 15 | `number` 16 | 17 | ## 0 Constraints 18 | 19 | **maximum**: the value of this number must smaller than or equal to: `0` 20 | -------------------------------------------------------------------------------- /examples/docs/complex-properties-xor-oneof-1.md: -------------------------------------------------------------------------------- 1 | # Untitled number in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/properties/xor/oneOf/1 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## 1 Type 14 | 15 | `number` 16 | 17 | ## 1 Constraints 18 | 19 | **minimum**: the value of this number must greater than or equal to: `10` 20 | -------------------------------------------------------------------------------- /examples/docs/complex-properties-xor.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Complex References Schema 2 | 3 | ```txt 4 | https://example.com/schemas/complex#/properties/xor 5 | ``` 6 | 7 | Exclusive choice. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [complex.schema.json*](../generated-schemas/complex.schema.json "open original schema") | 12 | 13 | ## xor Type 14 | 15 | merged type ([Details](complex-properties-xor.md)) 16 | 17 | one (and only one) of 18 | 19 | * [Untitled number in Complex References](complex-properties-xor-oneof-0.md "check type definition") 20 | 21 | * [Untitled number in Complex References](complex-properties-xor-oneof-1.md "check type definition") 22 | -------------------------------------------------------------------------------- /examples/docs/constants-properties-hello.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Constant Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/constants#/properties/hello 5 | ``` 6 | 7 | A simple string, without strong constraints. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [constants.schema.json*](../generated-schemas/constants.schema.json "open original schema") | 12 | 13 | ## hello Type 14 | 15 | `string` 16 | 17 | ## hello Constraints 18 | 19 | **constant**: the value of this property must be equal to: 20 | 21 | ```json 22 | "World" 23 | ``` 24 | -------------------------------------------------------------------------------- /examples/docs/custom-allof-0.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Custom Schema 2 | 3 | ```txt 4 | https://example.com/schemas/custom#/allOf/0 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [custom.schema.json*](../generated-schemas/custom.schema.json "open original schema") | 12 | 13 | ## 0 Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/custom-allof-1.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Custom Schema 2 | 3 | ```txt 4 | https://example.com/schemas/custom#/allOf/1 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [custom.schema.json*](../generated-schemas/custom.schema.json "open original schema") | 12 | 13 | ## 1 Type 14 | 15 | unknown 16 | 17 | # 1 Properties 18 | 19 | | Property | Type | Required | Nullable | Defined by | 20 | | :---------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------- | 21 | | [foo](#foo) | `string` | Optional | cannot be null | [Custom](custom-definitions-first-properties-foo.md "https://example.com/schemas/custom#/definitions/first/properties/foo") | 22 | 23 | ## foo 24 | 25 | A unique identifier given to every addressable thing. 26 | 27 | `foo` 28 | 29 | * is optional 30 | 31 | * Type: `string` 32 | 33 | * cannot be null 34 | 35 | * defined in: [Custom](custom-definitions-first-properties-foo.md "https://example.com/schemas/custom#/definitions/first/properties/foo") 36 | 37 | ### foo Type 38 | 39 | `string` 40 | -------------------------------------------------------------------------------- /examples/docs/custom-allof-2.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Custom Schema 2 | 3 | ```txt 4 | https://example.com/schemas/custom#/allOf/2 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [custom.schema.json*](../generated-schemas/custom.schema.json "open original schema") | 12 | 13 | ## 2 Type 14 | 15 | unknown 16 | 17 | # 2 Properties 18 | 19 | | Property | Type | Required | Nullable | Defined by | 20 | | :---------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------- | 21 | | [bar](#bar) | `string` | Optional | cannot be null | [Custom](custom-definitions-second-properties-bar.md "https://example.com/schemas/custom#/definitions/second/properties/bar") | 22 | 23 | ## bar 24 | 25 | A unique identifier given to every addressable thing. 26 | 27 | `bar` 28 | 29 | * is optional 30 | 31 | * Type: `string` 32 | 33 | * cannot be null 34 | 35 | * defined in: [Custom](custom-definitions-second-properties-bar.md "https://example.com/schemas/custom#/definitions/second/properties/bar") 36 | 37 | ### bar Type 38 | 39 | `string` 40 | -------------------------------------------------------------------------------- /examples/docs/custom-definitions-first-properties-foo.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Custom Schema 2 | 3 | ```txt 4 | https://example.com/schemas/custom#/definitions/first/properties/foo 5 | ``` 6 | 7 | A unique identifier given to every addressable thing. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [custom.schema.json*](../generated-schemas/custom.schema.json "open original schema") | 12 | 13 | ## foo Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/custom-definitions-first-properties.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Custom Schema 2 | 3 | ```txt 4 | https://example.com/schemas/custom#/definitions/first/properties 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [custom.schema.json*](../generated-schemas/custom.schema.json "open original schema") | 12 | 13 | ## properties Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/custom-definitions-first.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Custom Schema 2 | 3 | ```txt 4 | https://example.com/schemas/custom#/definitions/first 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [custom.schema.json*](../generated-schemas/custom.schema.json "open original schema") | 12 | 13 | ## first Type 14 | 15 | unknown 16 | 17 | # first Properties 18 | 19 | | Property | Type | Required | Nullable | Defined by | 20 | | :---------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------- | 21 | | [foo](#foo) | `string` | Optional | cannot be null | [Custom](custom-definitions-first-properties-foo.md "https://example.com/schemas/custom#/definitions/first/properties/foo") | 22 | 23 | ## foo 24 | 25 | A unique identifier given to every addressable thing. 26 | 27 | `foo` 28 | 29 | * is optional 30 | 31 | * Type: `string` 32 | 33 | * cannot be null 34 | 35 | * defined in: [Custom](custom-definitions-first-properties-foo.md "https://example.com/schemas/custom#/definitions/first/properties/foo") 36 | 37 | ### foo Type 38 | 39 | `string` 40 | -------------------------------------------------------------------------------- /examples/docs/custom-definitions-second-properties-bar.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Custom Schema 2 | 3 | ```txt 4 | https://example.com/schemas/custom#/definitions/second/properties/bar 5 | ``` 6 | 7 | A unique identifier given to every addressable thing. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [custom.schema.json*](../generated-schemas/custom.schema.json "open original schema") | 12 | 13 | ## bar Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/custom-definitions-second-properties.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Custom Schema 2 | 3 | ```txt 4 | https://example.com/schemas/custom#/definitions/second/properties 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [custom.schema.json*](../generated-schemas/custom.schema.json "open original schema") | 12 | 13 | ## properties Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/custom-definitions-second.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Custom Schema 2 | 3 | ```txt 4 | https://example.com/schemas/custom#/definitions/second 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [custom.schema.json*](../generated-schemas/custom.schema.json "open original schema") | 12 | 13 | ## second Type 14 | 15 | unknown 16 | 17 | # second Properties 18 | 19 | | Property | Type | Required | Nullable | Defined by | 20 | | :---------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------- | 21 | | [bar](#bar) | `string` | Optional | cannot be null | [Custom](custom-definitions-second-properties-bar.md "https://example.com/schemas/custom#/definitions/second/properties/bar") | 22 | 23 | ## bar 24 | 25 | A unique identifier given to every addressable thing. 26 | 27 | `bar` 28 | 29 | * is optional 30 | 31 | * Type: `string` 32 | 33 | * cannot be null 34 | 35 | * defined in: [Custom](custom-definitions-second-properties-bar.md "https://example.com/schemas/custom#/definitions/second/properties/bar") 36 | 37 | ### bar Type 38 | 39 | `string` 40 | -------------------------------------------------------------------------------- /examples/docs/custom-definitions.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Custom Schema 2 | 3 | ```txt 4 | https://example.com/schemas/custom#/definitions 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [custom.schema.json*](../generated-schemas/custom.schema.json "open original schema") | 12 | 13 | ## definitions Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/deepextending-definitions-fourth-properties-hey.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Deeply Extending Schema 2 | 3 | ```txt 4 | https://example.com/schemas/deepextending#/definitions/fourth/properties/hey 5 | ``` 6 | 7 | A unique identifier given to every addressable thing. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [deepextending.schema.json*](../generated-schemas/deepextending.schema.json "open original schema") | 12 | 13 | ## hey Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/deepextending-definitions-fourth-properties.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Deeply Extending Schema 2 | 3 | ```txt 4 | https://example.com/schemas/deepextending#/definitions/fourth/properties 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [deepextending.schema.json*](../generated-schemas/deepextending.schema.json "open original schema") | 12 | 13 | ## properties Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/deepextending-definitions.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Deeply Extending Schema 2 | 3 | ```txt 4 | https://example.com/schemas/deepextending#/definitions 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [deepextending.schema.json*](../generated-schemas/deepextending.schema.json "open original schema") | 12 | 13 | ## definitions Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/definitions-definitions-myid-properties-id-1.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Definitions Schema 2 | 3 | ```txt 4 | https://example.com/schemas/definitions#/definitions/myid/properties/@id 5 | ``` 6 | 7 | An `id` with an `@` in front of it. The `@` stands for "dot com" 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [definitions.schema.json*](../generated-schemas/definitions.schema.json "open original schema") | 12 | 13 | ## @id Type 14 | 15 | `string` 16 | 17 | ## @id Constraints 18 | 19 | **URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/definitions-definitions-myid-properties-id.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Definitions Schema 2 | 3 | ```txt 4 | https://example.com/schemas/definitions#/definitions/myid/properties/id 5 | ``` 6 | 7 | A unique identifier given to every addressable thing. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [definitions.schema.json*](../generated-schemas/definitions.schema.json "open original schema") | 12 | 13 | ## id Type 14 | 15 | `string` 16 | 17 | ## id Constraints 18 | 19 | **URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc3986 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/definitions-definitions-myid-properties-metaid.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Definitions Schema 2 | 3 | ```txt 4 | https://example.com/schemas/definitions#/definitions/myid/properties/meta:id 5 | ``` 6 | 7 | An about ids. It is meta. If you are confused, send an email to the address specified in this property value. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [definitions.schema.json*](../generated-schemas/definitions.schema.json "open original schema") | 12 | 13 | ## meta:id Type 14 | 15 | `string` 16 | 17 | ## meta:id Constraints 18 | 19 | **email**: the string must be an email address, according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/definitions-definitions-myid-properties.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Definitions Schema 2 | 3 | ```txt 4 | https://example.com/schemas/definitions#/definitions/myid/properties 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [definitions.schema.json*](../generated-schemas/definitions.schema.json "open original schema") | 12 | 13 | ## properties Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/definitions-definitions.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Definitions Schema 2 | 3 | ```txt 4 | https://example.com/schemas/definitions#/definitions 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [definitions.schema.json*](../generated-schemas/definitions.schema.json "open original schema") | 12 | 13 | ## definitions Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/enums-properties-enumerated-nested-properties-test.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Enumerated Schema 2 | 3 | ```txt 4 | https://example.com/schemas/enums#/properties/nested/properties/test 5 | ``` 6 | 7 | A simple string. Pick a value. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [enums.schema.json*](../generated-schemas/enums.schema.json "open original schema") | 12 | 13 | ## test Type 14 | 15 | `string` 16 | 17 | ## test Constraints 18 | 19 | **enum**: the value of this property must be equal to one of the following values: 20 | 21 | | Value | Explanation | 22 | | :--------- | :---------- | 23 | | `"nested"` | | 24 | | `"object"` | | 25 | | `"works"` | | 26 | -------------------------------------------------------------------------------- /examples/docs/enums-properties-hello.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Enumerated Schema 2 | 3 | ```txt 4 | https://example.com/schemas/enums#/properties/hello 5 | ``` 6 | 7 | A simple string. Pick a value. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [enums.schema.json*](../generated-schemas/enums.schema.json "open original schema") | 12 | 13 | ## hello Type 14 | 15 | `string` 16 | 17 | ## hello Constraints 18 | 19 | **enum**: the value of this property must be equal to one of the following values: 20 | 21 | | Value | Explanation | 22 | | :-------- | :---------- | 23 | | `"World"` | | 24 | | `"Welt"` | | 25 | -------------------------------------------------------------------------------- /examples/docs/example-properties-bar.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Example Schema 2 | 3 | ```txt 4 | https://example.com/schemas/example#/properties/bar 5 | ``` 6 | 7 | A simple string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [example.schema.json*](../generated-schemas/example.schema.json "open original schema") | 12 | 13 | ## bar Type 14 | 15 | `string` 16 | 17 | ## bar Examples 18 | 19 | ```json 20 | "bar" 21 | ``` 22 | 23 | ```json 24 | "baz" 25 | ``` 26 | -------------------------------------------------------------------------------- /examples/docs/example-properties-foo.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Example Schema 2 | 3 | ```txt 4 | https://example.com/schemas/example#/properties/foo 5 | ``` 6 | 7 | A simple string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [example.schema.json*](../generated-schemas/example.schema.json "open original schema") | 12 | 13 | ## foo Type 14 | 15 | `string` 16 | 17 | ## foo Examples 18 | 19 | ```json 20 | "bar" 21 | ``` 22 | -------------------------------------------------------------------------------- /examples/docs/examples-properties-bar.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Examples Schema 2 | 3 | ```txt 4 | https://example.com/schemas/examples#/properties/bar 5 | ``` 6 | 7 | A simple string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [examples.schema.json*](../generated-schemas/examples.schema.json "open original schema") | 12 | 13 | ## bar Type 14 | 15 | `string` 16 | 17 | ## bar Examples 18 | 19 | ```json 20 | "bar" 21 | ``` 22 | 23 | ```json 24 | "baz" 25 | ``` 26 | -------------------------------------------------------------------------------- /examples/docs/examples-properties-foo.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Examples Schema 2 | 3 | ```txt 4 | https://example.com/schemas/examples#/properties/foo 5 | ``` 6 | 7 | A simple string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [examples.schema.json*](../generated-schemas/examples.schema.json "open original schema") | 12 | 13 | ## foo Type 14 | 15 | `string` 16 | 17 | ## foo Examples 18 | 19 | ```json 20 | "bar" 21 | ``` 22 | -------------------------------------------------------------------------------- /examples/docs/extending-definitions-third-properties-baaaz.md: -------------------------------------------------------------------------------- 1 | # BAAAZ! Schema 2 | 3 | ```txt 4 | https://example.com/schemas/extending#/definitions/third/properties/baz 5 | ``` 6 | 7 | This property has a unique name to demonstrate it's uniqueness. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [extending.schema.json*](../generated-schemas/extending.schema.json "open original schema") | 12 | 13 | ## baz Type 14 | 15 | `string` ([BAAAZ!](extending-definitions-third-properties-baaaz.md)) 16 | 17 | ## baz Examples 18 | 19 | ```json 20 | "I'm just a humble example" 21 | ``` 22 | -------------------------------------------------------------------------------- /examples/docs/extending-definitions.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Extending Schema 2 | 3 | ```txt 4 | https://example.com/schemas/extending#/definitions 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [extending.schema.json*](../generated-schemas/extending.schema.json "open original schema") | 12 | 13 | ## definitions Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/extensible-definitions-first-properties-foo.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Extensible Schema 2 | 3 | ```txt 4 | https://example.com/schemas/extensible#/definitions/first/properties/foo 5 | ``` 6 | 7 | A unique identifier given to every addressable thing. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [extensible.schema.json*](../generated-schemas/extensible.schema.json "open original schema") | 12 | 13 | ## foo Type 14 | 15 | `string` 16 | 17 | ## foo Examples 18 | 19 | ```json 20 | "bar" 21 | ``` 22 | -------------------------------------------------------------------------------- /examples/docs/extensible-definitions-first-properties.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Extensible Schema 2 | 3 | ```txt 4 | https://example.com/schemas/extensible#/definitions/first/properties 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [extensible.schema.json*](../generated-schemas/extensible.schema.json "open original schema") | 12 | 13 | ## properties Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/extensible-definitions-second-properties-bar.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Extensible Schema 2 | 3 | ```txt 4 | https://example.com/schemas/extensible#/definitions/second/properties/bar 5 | ``` 6 | 7 | A horse walks into it. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [extensible.schema.json*](../generated-schemas/extensible.schema.json "open original schema") | 12 | 13 | ## bar Type 14 | 15 | `string` 16 | 17 | ## bar Examples 18 | 19 | ```json 20 | "whoo" 21 | ``` 22 | 23 | ```json 24 | "hoo" 25 | ``` 26 | -------------------------------------------------------------------------------- /examples/docs/extensible-definitions-second-properties.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Extensible Schema 2 | 3 | ```txt 4 | https://example.com/schemas/extensible#/definitions/second/properties 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [extensible.schema.json*](../generated-schemas/extensible.schema.json "open original schema") | 12 | 13 | ## properties Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/extensible-definitions.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Extensible Schema 2 | 3 | ```txt 4 | https://example.com/schemas/extensible#/definitions 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [extensible.schema.json*](../generated-schemas/extensible.schema.json "open original schema") | 12 | 13 | ## definitions Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/identifiable-properties-id.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Identifiable Schema 2 | 3 | ```txt 4 | https://example.com/schemas/identifiable#/properties/@id 5 | ``` 6 | 7 | A unique identifier given to every addressable thing. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [identifiable.schema.json*](../generated-schemas/identifiable.schema.json "open original schema") | 12 | 13 | ## @id Type 14 | 15 | `string` 16 | 17 | ## @id Constraints 18 | 19 | **URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/join-oneof-0-not-oneof-0-properties-foo.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Join Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/join#/oneOf/0/not/oneOf/0/properties/foo 5 | ``` 6 | 7 | A simple string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [join.schema.json*](../generated-schemas/join.schema.json "open original schema") | 12 | 13 | ## foo Type 14 | 15 | `string` 16 | 17 | ## foo Examples 18 | 19 | ```json 20 | "hello" 21 | ``` 22 | -------------------------------------------------------------------------------- /examples/docs/join-oneof-0-not-oneof-1-properties-bar.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Join Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/join#/oneOf/0/not/oneOf/1/properties/bar 5 | ``` 6 | 7 | A simple string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [join.schema.json*](../generated-schemas/join.schema.json "open original schema") | 12 | 13 | ## bar Type 14 | 15 | `string` 16 | 17 | ## bar Examples 18 | 19 | ```json 20 | "world" 21 | ``` 22 | -------------------------------------------------------------------------------- /examples/docs/join-oneof-0-not.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Join Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/join#/oneOf/0/not 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [join.schema.json*](../generated-schemas/join.schema.json "open original schema") | 12 | 13 | ## not Type 14 | 15 | merged type ([Details](join-oneof-0-not.md)) 16 | 17 | one (and only one) of 18 | 19 | * [Untitled object in Join Types](join-oneof-0-not-oneof-0.md "check type definition") 20 | 21 | * [Untitled object in Join Types](join-oneof-0-not-oneof-1.md "check type definition") 22 | -------------------------------------------------------------------------------- /examples/docs/join-oneof-0.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Join Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/join#/oneOf/0 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [join.schema.json*](../generated-schemas/join.schema.json "open original schema") | 12 | 13 | ## 0 Type 14 | 15 | merged type ([Details](join-oneof-0.md)) 16 | 17 | not 18 | 19 | * one (and only one) of 20 | 21 | * [Untitled object in Join Types](join-oneof-0-not-oneof-0.md "check type definition") 22 | 23 | * [Untitled object in Join Types](join-oneof-0-not-oneof-1.md "check type definition") 24 | -------------------------------------------------------------------------------- /examples/docs/join-oneof-1-allof-0-properties-foo.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Join Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/join#/oneOf/1/allOf/0/properties/foo 5 | ``` 6 | 7 | A simple string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [join.schema.json*](../generated-schemas/join.schema.json "open original schema") | 12 | 13 | ## foo Type 14 | 15 | `string` 16 | 17 | ## foo Examples 18 | 19 | ```json 20 | "hello" 21 | ``` 22 | -------------------------------------------------------------------------------- /examples/docs/join-oneof-1.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Join Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/join#/oneOf/1 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [join.schema.json*](../generated-schemas/join.schema.json "open original schema") | 12 | 13 | ## 1 Type 14 | 15 | merged type ([Details](join-oneof-1.md)) 16 | 17 | all of 18 | 19 | * [Untitled object in Join Types](join-oneof-1-allof-0.md "check type definition") 20 | -------------------------------------------------------------------------------- /examples/docs/join-oneof-2-anyof-0-properties-bar.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Join Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/join#/oneOf/2/anyOf/0/properties/bar 5 | ``` 6 | 7 | A simple string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [join.schema.json*](../generated-schemas/join.schema.json "open original schema") | 12 | 13 | ## bar Type 14 | 15 | `string` 16 | 17 | ## bar Examples 18 | 19 | ```json 20 | "world" 21 | ``` 22 | -------------------------------------------------------------------------------- /examples/docs/join-oneof-2.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Join Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/join#/oneOf/2 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [join.schema.json*](../generated-schemas/join.schema.json "open original schema") | 12 | 13 | ## 2 Type 14 | 15 | merged type ([Details](join-oneof-2.md)) 16 | 17 | any of 18 | 19 | * [Untitled object in Join Types](join-oneof-2-anyof-0.md "check type definition") 20 | -------------------------------------------------------------------------------- /examples/docs/join.md: -------------------------------------------------------------------------------- 1 | # Join Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/join 5 | ``` 6 | 7 | This is an example of a JSON schema with only a join type key. Here a 'oneOf'. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [join.schema.json](../generated-schemas/join.schema.json "open original schema") | 12 | 13 | ## Join Types Type 14 | 15 | merged type ([Join Types](join.md)) 16 | 17 | one (and only one) of 18 | 19 | * not 20 | 21 | * one (and only one) of 22 | 23 | * [Untitled object in Join Types](join-oneof-0-not-oneof-0.md "check type definition") 24 | 25 | * [Untitled object in Join Types](join-oneof-0-not-oneof-1.md "check type definition") 26 | 27 | * all of 28 | 29 | * [Untitled object in Join Types](join-oneof-1-allof-0.md "check type definition") 30 | 31 | * any of 32 | 33 | * [Untitled object in Join Types](join-oneof-2-anyof-0.md "check type definition") 34 | -------------------------------------------------------------------------------- /examples/docs/nestedobj-properties-settings-properties-collaborators-patternproperties-.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Nested Object Schema 2 | 3 | ```txt 4 | https://example.com/schemas/nestedobject#/properties/settings/properties/collaborators/patternProperties/.* 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [nestedobj.schema.json*](../generated-schemas/nestedobj.schema.json "open original schema") | 12 | 13 | ## .\* Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/nestedobj-properties-settings-properties-collaborators-patternproperties.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Nested Object Schema 2 | 3 | ```txt 4 | https://example.com/schemas/nestedobject#/properties/settings/properties/collaborators/patternProperties 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [nestedobj.schema.json*](../generated-schemas/nestedobj.schema.json "open original schema") | 12 | 13 | ## patternProperties Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/nestedobj-properties-settings-properties-collaborators-properties-id.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Nested Object Schema 2 | 3 | ```txt 4 | https://example.com/schemas/nestedobject#/properties/settings/properties/collaborators/properties/id 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [nestedobj.schema.json*](../generated-schemas/nestedobj.schema.json "open original schema") | 12 | 13 | ## id Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/pattern-patternproperties-0-9.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Pattern Properties Schema 2 | 3 | ```txt 4 | https://example.com/schemas/pattern#/patternProperties/[0-9] 5 | ``` 6 | 7 | A simple string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [pattern.schema.json*](../generated-schemas/pattern.schema.json "open original schema") | 12 | 13 | ## \[0-9] Type 14 | 15 | `string` 16 | 17 | ## \[0-9] Examples 18 | 19 | ```json 20 | "bar" 21 | ``` 22 | -------------------------------------------------------------------------------- /examples/docs/pattern-patternproperties.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Pattern Properties Schema 2 | 3 | ```txt 4 | https://example.com/schemas/pattern#/patternProperties 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [pattern.schema.json*](../generated-schemas/pattern.schema.json "open original schema") | 12 | 13 | ## patternProperties Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/simple-properties-id.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Simple Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simple#/properties/id 5 | ``` 6 | 7 | A unique identifier given to every addressable thing. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------ | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simple.schema.json*](../generated-schemas/simple.schema.json "open original schema") | 12 | 13 | ## id Type 14 | 15 | `string` 16 | 17 | ## id Constraints 18 | 19 | **URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-integer_threes.md: -------------------------------------------------------------------------------- 1 | # Untitled integer in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/integer_threes 5 | ``` 6 | 7 | Guess what number is valid 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## integer_threes Type 14 | 15 | `integer` 16 | 17 | ## integer_threes Constraints 18 | 19 | **multiple of**: the value of this number must be a multiple of: `3` 20 | 21 | **maximum**: the value of this number must smaller than or equal to: `4` 22 | 23 | **minimum**: the value of this number must greater than or equal to: `2` 24 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-interger_constrained.md: -------------------------------------------------------------------------------- 1 | # Untitled integer in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/interger_constrained 5 | ``` 6 | 7 | Just a whole number. I don't like fractions. Don't get too small 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## interger_constrained Type 14 | 15 | `integer` 16 | 17 | ## interger_constrained Constraints 18 | 19 | **minimum**: the value of this number must greater than or equal to: `10` 20 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-interger_unconstrained.md: -------------------------------------------------------------------------------- 1 | # Untitled integer in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/interger_unconstrained 5 | ``` 6 | 7 | Just a whole number. I don't like fractions. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## interger_unconstrained Type 14 | 15 | `integer` 16 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-number_constrained.md: -------------------------------------------------------------------------------- 1 | # Untitled number in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/number_constrained 5 | ``` 6 | 7 | Just a number. Don't get too big. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## number_constrained Type 14 | 15 | `number` 16 | 17 | ## number_constrained Constraints 18 | 19 | **maximum (exclusive)**: the value of this number must be smaller than: `10` 20 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-number_unconstrained.md: -------------------------------------------------------------------------------- 1 | # Untitled number in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/number_unconstrained 5 | ``` 6 | 7 | Just a number 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## number_unconstrained Type 14 | 15 | `number` 16 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-string_date.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/string_date 5 | ``` 6 | 7 | A date-like string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## string_date Type 14 | 15 | `string` 16 | 17 | ## string_date Constraints 18 | 19 | **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-string_email.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/string_email 5 | ``` 6 | 7 | An email-like string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## string_email Type 14 | 15 | `string` 16 | 17 | ## string_email Constraints 18 | 19 | **email**: the string must be an email address, according to [RFC 5322, section 3.4.1](https://tools.ietf.org/html/rfc5322 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-string_hostname.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/string_hostname 5 | ``` 6 | 7 | A hostname-like string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## string_hostname Type 14 | 15 | `string` 16 | 17 | ## string_hostname Constraints 18 | 19 | **hostname**: the string must be a hostname, according to [RFC 1123, section 2.1](https://tools.ietf.org/html/rfc1123 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-string_ipv4.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/string_ipv4 5 | ``` 6 | 7 | An IPv4-like string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## string_ipv4 Type 14 | 15 | `string` 16 | 17 | ## string_ipv4 Constraints 18 | 19 | **IPv4**: the string must be an IPv4 address (dotted quad), according to [RFC 2673, section 3.2](https://tools.ietf.org/html/rfc2673 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-string_ipv6.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/string_ipv6 5 | ``` 6 | 7 | An IPv6-like string. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## string_ipv6 Type 14 | 15 | `string` 16 | 17 | ## string_ipv6 Constraints 18 | 19 | **IPv6**: the string must be an IPv6 address, according to [RFC 4291, section 2.2](https://tools.ietf.org/html/rfc4291 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-string_length.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/string_length 5 | ``` 6 | 7 | A string with minumum and maximum length 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## string_length Type 14 | 15 | `string` 16 | 17 | ## string_length Constraints 18 | 19 | **maximum length**: the maximum number of characters for this string is: `3` 20 | 21 | **minimum length**: the minimum number of characters for this string is: `3` 22 | 23 | ## string_length Examples 24 | 25 | ```json 26 | "bar" 27 | ``` 28 | 29 | ```json 30 | "baz" 31 | ``` 32 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-string_pattern-metaenum.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/string_pattern/meta:enum 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## meta:enum Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-string_pattern.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/string_pattern 5 | ``` 6 | 7 | A string following a regular expression 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## string_pattern Type 14 | 15 | `string` 16 | 17 | ## string_pattern Constraints 18 | 19 | **pattern**: the string must match the following regular expression: 20 | 21 | ```regexp 22 | ^ba.$ 23 | ``` 24 | 25 | [try pattern](https://regexr.com/?expression=%5Eba.%24 "try regular expression with regexr.com") 26 | 27 | ## string_pattern Examples 28 | 29 | ```json 30 | "bar" 31 | ``` 32 | 33 | ```json 34 | "baz" 35 | ``` 36 | 37 | ```json 38 | "bat" 39 | ``` 40 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-string_pattern_noexample.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/string_pattern_noexample 5 | ``` 6 | 7 | A string following a regular expression 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## string_pattern_noexample Type 14 | 15 | `string` 16 | 17 | ## string_pattern_noexample Constraints 18 | 19 | **pattern**: the string must match the following regular expression: 20 | 21 | ```regexp 22 | ^ba.$ 23 | ``` 24 | 25 | [try pattern](https://regexr.com/?expression=%5Eba.%24 "try regular expression with regexr.com") 26 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-string_pattern_singleexample.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/string_pattern_singleexample 5 | ``` 6 | 7 | A string following a regular expression 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## string_pattern_singleexample Type 14 | 15 | `string` 16 | 17 | ## string_pattern_singleexample Constraints 18 | 19 | **pattern**: the string must match the following regular expression: 20 | 21 | ```regexp 22 | ^ba.$ 23 | ``` 24 | 25 | [try pattern](https://regexr.com/?expression=%5Eba.%24 "try regular expression with regexr.com") 26 | 27 | ## string_pattern_singleexample Examples 28 | 29 | ```json 30 | "bar" 31 | ``` 32 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-string_unconstrained.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/string_unconstrained 5 | ``` 6 | 7 | A simple string, without any constraints. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## string_unconstrained Type 14 | 15 | `string` 16 | 17 | ## string_unconstrained Examples 18 | 19 | ```json 20 | "bar" 21 | ``` 22 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-string_uri.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/string_uri 5 | ``` 6 | 7 | A URI. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## string_uri Type 14 | 15 | `string` 16 | 17 | ## string_uri Constraints 18 | 19 | **URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/simpletypes-properties-yesno.md: -------------------------------------------------------------------------------- 1 | # Untitled boolean in Simple Types Schema 2 | 3 | ```txt 4 | https://example.com/schemas/simpletypes#/properties/yesno 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [simpletypes.schema.json*](../generated-schemas/simpletypes.schema.json "open original schema") | 12 | 13 | ## yesno Type 14 | 15 | `boolean` 16 | -------------------------------------------------------------------------------- /examples/docs/stabilizing-properties-id.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Stabilizing Schema 2 | 3 | ```txt 4 | https://example.com/schemas/stabilizing#/properties/id 5 | ``` 6 | 7 | A unique identifier given to every addressable thing. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [stabilizing.schema.json*](../generated-schemas/stabilizing.schema.json "open original schema") | 12 | 13 | ## id Type 14 | 15 | `string` 16 | 17 | ## id Constraints 18 | 19 | **URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/subdir-definitions-content-properties-id.md: -------------------------------------------------------------------------------- 1 | # Untitled string in Subdir Schema 2 | 3 | ```txt 4 | https://example.com/schemas/subdir/subdir#/definitions/content/properties/id 5 | ``` 6 | 7 | A unique identifier given to every addressable thing. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [subdir.schema.json*](../generated-schemas/subdir/subdir.schema.json "open original schema") | 12 | 13 | ## id Type 14 | 15 | `string` 16 | 17 | ## id Constraints 18 | 19 | **URI**: the string must be a URI, according to [RFC 3986](https://tools.ietf.org/html/rfc3986 "check the specification") 20 | -------------------------------------------------------------------------------- /examples/docs/subdir-definitions-content-properties.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Subdir Schema 2 | 3 | ```txt 4 | https://example.com/schemas/subdir/subdir#/definitions/content/properties 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [subdir.schema.json*](../generated-schemas/subdir/subdir.schema.json "open original schema") | 12 | 13 | ## properties Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/subdir-definitions.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Subdir Schema 2 | 3 | ```txt 4 | https://example.com/schemas/subdir/subdir#/definitions 5 | ``` 6 | 7 | 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [subdir.schema.json*](../generated-schemas/subdir/subdir.schema.json "open original schema") | 12 | 13 | ## definitions Type 14 | 15 | unknown 16 | -------------------------------------------------------------------------------- /examples/docs/typearrays-properties-null.md: -------------------------------------------------------------------------------- 1 | # Untitled null in Type Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/typearrays#/properties/null 5 | ``` 6 | 7 | This is just nothing 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [typearrays.schema.json*](../generated-schemas/typearrays.schema.json "open original schema") | 12 | 13 | ## null Type 14 | 15 | `null`, the value must be null 16 | -------------------------------------------------------------------------------- /examples/docs/typearrays-properties-string-or-null.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Type Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/typearrays#/properties/string-or-null 5 | ``` 6 | 7 | Nullable string 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [typearrays.schema.json*](../generated-schemas/typearrays.schema.json "open original schema") | 12 | 13 | ## string-or-null Type 14 | 15 | `string` 16 | -------------------------------------------------------------------------------- /examples/docs/typearrays-properties-string-or-number-null.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Type Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/typearrays#/properties/string-or-number-null 5 | ``` 6 | 7 | Types can be many things, even nothing at all. 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [typearrays.schema.json*](../generated-schemas/typearrays.schema.json "open original schema") | 12 | 13 | ## string-or-number-null Type 14 | 15 | any of the following: `string` or `number` ([Details](typearrays-properties-string-or-number-null.md)) 16 | -------------------------------------------------------------------------------- /examples/docs/typearrays-properties-string-or-number.md: -------------------------------------------------------------------------------- 1 | # Untitled undefined type in Type Arrays Schema 2 | 3 | ```txt 4 | https://example.com/schemas/typearrays#/properties/string-or-number 5 | ``` 6 | 7 | Types can be many things 8 | 9 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | 10 | | :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :-------------------------------------------------------------------------------------------- | 11 | | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [typearrays.schema.json*](../generated-schemas/typearrays.schema.json "open original schema") | 12 | 13 | ## string-or-number Type 14 | 15 | any of the following: `string` or `number` ([Details](typearrays-properties-string-or-number.md)) 16 | -------------------------------------------------------------------------------- /examples/generated-schemas/abstract.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/abstract","title":"Abstract","description":"This is an abstract schema. It has `definitions`, but does not declare any properties","type":"object","definitions":{"first":{"type":"object","properties":{"foo":{"type":"string","description":"A unique identifier given to every addressable thing.","version":"1.0.0","testProperty":"test"},"nonfoo":{"type":"boolean","const":false,"description":"This is not foo.","version":"1.0.0","testProperty":"test"}}},"second":{"type":"object","properties":{"bar":{"type":"string","description":"A unique identifier given to every addressable thing.","version":"1.0.0","testProperty":"test"}}}}} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/constants.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/constants","title":"Constant Types","type":"object","description":"This is an example schema with examples for properties with constant values","properties":{"hello":{"type":"string","const":"World","description":"A simple string, without strong constraints.","version":"1.0.0","testProperty":"test"}},"required":["hello"]} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/custom.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/custom","title":"Custom","description":"This is an extensible schema. It has `definitions`, that can be used in other schemas. Additionally, it allows custom properties.","type":"object","meta:extensible":true,"definitions":{"first":{"properties":{"foo":{"type":"string","description":"A unique identifier given to every addressable thing.","version":"1.0.0","testProperty":"test"}}},"second":{"properties":{"bar":{"type":"string","description":"A unique identifier given to every addressable thing.","version":"1.0.0","testProperty":"test"}}}},"allOf":[{"$ref":"https://ns.adobe.com/xdm/common/extensible.schema.json#/definitions/@context"},{"$ref":"#/definitions/first"},{"$ref":"#/definitions/second"}]} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/deepextending.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/deepextending","title":"Deeply Extending","description":"This is an extending schema. It is extending another extending schema. It pulls `definitions` from other schemas.","type":"object","meta:extensible":true,"meta:extends":["https://example.com/schemas/definitions","https://example.com/schemas/extensible","https://example.com/schemas/extending"],"definitions":{"fourth":{"properties":{"hey":{"type":"string","description":"A unique identifier given to every addressable thing.","version":"1.0.0","testProperty":"test"}}}},"allOf":[{"$ref":"https://example.com/schemas/extensible#/definitions/second"},{"$ref":"https://example.com/schemas/definitions#/definitions/myid"},{"$ref":"https://example.com/schemas/extending#/definitions/third"},{"$ref":"#/definitions/fourth"}]} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/definitions.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/definitions","title":"Definitions","type":"object","definitions":{"myid":{"properties":{"id":{"type":"string","format":"uri-reference","description":"A unique identifier given to every addressable thing.","version":"1.0.0","testProperty":"test"},"@id":{"type":"string","format":"uri","description":"An `id` with an `@` in front of it. The `@` stands for \"dot com\"","version":"1.0.0","testProperty":"test"},"meta:id":{"type":"string","format":"email","description":"An about ids. It is meta. If you are confused, send an email to the address specified in this property value.","version":"1.0.0","testProperty":"test"}},"required":["@id"]}},"allOf":[{"$ref":"#/definitions/myid"}],"required":["id"],"description":"This is an example of using a `definitions` object within a schema.\n\nIt is imported using `allOf` and `$ref`.\n\nAnd the description has line breaks.\n\nSo.\n\nMany.\n\nLine.\n\nBre-\n\naks.\n\n> Everything is better with a quote.\n"} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/enums.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/enums","title":"Enumerated ","type":"object","description":"This is an example schema with examples for properties with enum values","properties":{"hello":{"type":"string","enum":["World","Welt"],"description":"A simple string. Pick a value.","version":"1.0.0","testProperty":"test"},"nested":{"title":"Enumerated (Nested)","description":"This is an example schema with examples for properties of nested objects with enum values","type":"object","properties":{"test":{"type":"string","enum":["nested","object","works"],"description":"A simple string. Pick a value.","version":"1.0.0","testProperty":"test"}},"version":"1.0.0","testProperty":"test"}},"required":["hello"]} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/example.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/example","title":"Example","type":"object","description":"This is an example schema with examples. Too many examples? There can never be too many examples!","properties":{"foo":{"type":"string","description":"A simple string.","examples":["bar"],"version":"1.0.0","testProperty":"test"},"bar":{"type":"string","description":"A simple string.","examples":["bar","baz"],"version":"1.0.0","testProperty":"test"}},"examples":[{"foo":"bar","bar":"baz"}]} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/examples.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/examples","title":"Examples","type":"object","description":"This is an example schema with *multiple* examples. Too many examples? There can never be too many examples!","properties":{"foo":{"type":"string","description":"A simple string.","examples":["bar"],"version":"1.0.0","testProperty":"test"},"bar":{"type":"string","description":"A simple string.","examples":["bar","baz"],"version":"1.0.0","testProperty":"test"}},"required":["bar"],"examples":[{"foo":"bi","bar":"bu"},{"foo":"zip","bar":"zap"}]} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/extending.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/extending","title":"Extending","description":"This is an extending schema. It pulls `definitions` from other schemas.","type":"object","meta:extensible":true,"meta:extends":["https://example.com/schemas/definitions","https://example.com/schemas/extensible"],"definitions":{"third":{"type":"object","properties":{"baz":{"type":"string","title":"BAAAZ!","examples":["I'm just a humble example"],"description":"This property has a unique name to demonstrate it's uniqueness.","version":"1.0.0","testProperty":"test"}}}},"allOf":[{"$ref":"https://example.com/schemas/extensible#/definitions/second"},{"$ref":"https://example.com/schemas/definitions#/definitions/myid"},{"$ref":"#/definitions/third"}]} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/extensible.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/extensible","title":"Extensible","description":"This is an extensible schema. It has `definitions`, that can be used in other schemas","type":"object","meta:extensible":true,"definitions":{"first":{"properties":{"foo":{"type":"string","examples":["bar"],"description":"A unique identifier given to every addressable thing.","version":"1.0.0","testProperty":"test"}}},"second":{"properties":{"bar":{"type":"string","examples":["whoo","hoo"],"description":"A horse walks into it.","version":"1.0.0","testProperty":"test"}}}}} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/identifiable.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/identifiable","title":"Identifiable","description":"This is a *very* simple example of a JSON schema. There is only one property.","type":"object","properties":{"@id":{"type":"string","format":"uri","description":"A unique identifier given to every addressable thing.","version":"1.0.0","testProperty":"test"}}} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/join.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/join","title":"Join Types","description":"This is an example of a JSON schema with only a join type key. Here a 'oneOf'.","oneOf":[{"not":{"oneOf":[{"type":"object","description":"A simple string.","properties":{"foo":{"type":"string","description":"A simple string.","examples":["hello"],"version":"1.0.0","testProperty":"test"}}},{"type":"object","description":"Another simple string.","properties":{"bar":{"type":"string","description":"A simple string.","examples":["world"],"version":"1.0.0","testProperty":"test"}}}]}},{"allOf":[{"type":"object","description":"A simple string.","properties":{"foo":{"type":"string","description":"A simple string.","examples":["hello"],"version":"1.0.0","testProperty":"test"}}}]},{"anyOf":[{"type":"object","description":"Another simple string.","properties":{"bar":{"type":"string","description":"A simple string.","examples":["world"],"version":"1.0.0","testProperty":"test"}}}]}]} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/nestedobj.schema.json: -------------------------------------------------------------------------------- 1 | {"$id":"https://example.com/schemas/nestedobject","$schema":"http://json-schema.org/draft-07/schema","title":"Nested Object","type":"object","properties":{"settings":{"description":"settings","type":"object","properties":{"collaborators":{"description":"collaborators","type":"object","patternProperties":{".*":{"type":"string"}},"properties":{"id":{"type":"string","version":"1.0.0","testProperty":"test"}},"version":"1.0.0","testProperty":"test"}},"version":"1.0.0","testProperty":"test"}},"additionalProperties":false} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/pattern.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/pattern","title":"Pattern Properties","description":"This is an example of a JSON schema with only a `patternProperties` key.","patternProperties":{"[0-9]":{"type":"string","description":"A simple string.","examples":["bar"],"version":"1.0.0","testProperty":"test"}}} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/simple.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/simple","title":"Simple","description":"This is a *very* simple example of a JSON schema. There is only one property.","type":"object","properties":{"id":{"type":"string","format":"uri","description":"A unique identifier given to every addressable thing.","version":"1.0.0","testProperty":"test"}}} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/stabilizing.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/stabilizing","title":"Stabilizing","description":"This is a schema which is currently in the `stabilizing` status.","meta:status":"stabilizing","type":"object","properties":{"id":{"type":"string","format":"uri","description":"A unique identifier given to every addressable thing.","version":"1.0.0","testProperty":"test"}}} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/subdir.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/subdir/subdir","title":"Subdir","type":"object","description":"A schema in a sub directory","definitions":{"content":{"properties":{"id":{"type":"string","format":"uri","description":"A unique identifier given to every addressable thing.","version":"1.0.0","testProperty":"test"}}}},"allOf":[{"$ref":"#/definitions/content"}]} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/subdir/subdir.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/subdir/subdir","title":"Subdir","type":"object","description":"A schema in a sub directory","definitions":{"content":{"properties":{"id":{"type":"string","format":"uri","description":"A unique identifier given to every addressable thing.","version":"1.0.0","testProperty":"test"}}}},"allOf":[{"$ref":"#/definitions/content"}]} 2 | -------------------------------------------------------------------------------- /examples/generated-schemas/typearrays.schema.json: -------------------------------------------------------------------------------- 1 | {"meta:license":["Copyright 2017 Adobe Systems Incorporated. All rights reserved.","This file is licensed to you under the Apache License, Version 2.0 (the 'License');","you may not use this file except in compliance with the License. You may obtain a copy","of the License at http://www.apache.org/licenses/LICENSE-2.0"],"$schema":"http://json-schema.org/draft-06/schema#","$id":"https://example.com/schemas/typearrays","title":"Type Arrays","description":"This schema test type arrays and nullable types","type":"object","properties":{"null":{"type":"null","description":"This is just nothing","version":"1.0.0","testProperty":"test"},"string-or-null":{"type":["string","null"],"description":"Nullable string","version":"1.0.0","testProperty":"test"},"string-or-number":{"type":["string","number"],"description":"Types can be many things","version":"1.0.0","testProperty":"test"},"string-or-number-null":{"type":["string","number","null"],"description":"Types can be many things, even nothing at all.","version":"1.0.0","testProperty":"test"}}} 2 | -------------------------------------------------------------------------------- /examples/schemas/abstract.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/abstract", 10 | "title": "Abstract", 11 | "description": "This is an abstract schema. It has `definitions`, but does not declare any properties", 12 | "type": "object", 13 | "definitions": { 14 | "first": { 15 | "type": "object", 16 | "properties": { 17 | "foo": { 18 | "type": "string", 19 | "description": "A unique identifier given to every addressable thing.", 20 | "version": "1.0.0", 21 | "testProperty": "test" 22 | }, 23 | "nonfoo": { 24 | "type": "boolean", 25 | "const": false, 26 | "description": "This is not foo.", 27 | "version": "1.0.0", 28 | "testProperty": "test" 29 | } 30 | } 31 | }, 32 | "second": { 33 | "type":"object", 34 | "properties": { 35 | "bar": { 36 | "type": "string", 37 | "description": "A unique identifier given to every addressable thing.", 38 | "version": "1.0.0", 39 | "testProperty": "test" 40 | } 41 | } 42 | } 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /examples/schemas/constants.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/constants", 10 | "title": "Constant Types", 11 | "type": "object", 12 | "description": "This is an example schema with examples for properties with constant values", 13 | "properties": { 14 | "hello": { 15 | "type": "string", 16 | "const": "World", 17 | "description": "A simple string, without strong constraints.", 18 | "version": "1.0.0", 19 | "testProperty": "test" 20 | } 21 | }, 22 | "required": [ 23 | "hello" 24 | ] 25 | } 26 | -------------------------------------------------------------------------------- /examples/schemas/custom.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/custom", 10 | "title": "Custom", 11 | "description": "This is an extensible schema. It has `definitions`, that can be used in other schemas. Additionally, it allows custom properties.", 12 | "type": "object", 13 | "meta:extensible": true, 14 | "definitions": { 15 | "first": { 16 | "properties": { 17 | "foo": { 18 | "type": "string", 19 | "description": "A unique identifier given to every addressable thing.", 20 | "version": "1.0.0", 21 | "testProperty": "test" 22 | } 23 | } 24 | }, 25 | "second": { 26 | "properties": { 27 | "bar": { 28 | "type": "string", 29 | "description": "A unique identifier given to every addressable thing.", 30 | "version": "1.0.0", 31 | "testProperty": "test" 32 | } 33 | } 34 | } 35 | }, 36 | "allOf": [ 37 | { "$ref": "https://ns.adobe.com/xdm/common/extensible.schema.json#/definitions/@context"}, 38 | { "$ref": "#/definitions/first" }, 39 | { "$ref": "#/definitions/second" } 40 | ] 41 | } -------------------------------------------------------------------------------- /examples/schemas/deepextending.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/deepextending", 10 | "title": "Deeply Extending", 11 | "description": "This is an extending schema. It is extending another extending schema. It pulls `definitions` from other schemas.", 12 | "type": "object", 13 | "meta:extensible": true, 14 | "meta:extends": [ 15 | "https://example.com/schemas/definitions", 16 | "https://example.com/schemas/extensible", 17 | "https://example.com/schemas/extending" 18 | ], 19 | "definitions": { 20 | "fourth": { 21 | "properties": { 22 | "hey": { 23 | "type": "string", 24 | "description": "A unique identifier given to every addressable thing.", 25 | "version": "1.0.0", 26 | "testProperty": "test" 27 | } 28 | } 29 | } 30 | }, 31 | "allOf": [ 32 | { "$ref": "https://example.com/schemas/extensible#/definitions/second"}, 33 | { "$ref": "https://example.com/schemas/definitions#/definitions/myid" }, 34 | { "$ref": "https://example.com/schemas/extending#/definitions/third" }, 35 | { "$ref": "#/definitions/fourth" } 36 | ] 37 | } -------------------------------------------------------------------------------- /examples/schemas/definitions.description.md: -------------------------------------------------------------------------------- 1 | This is an example of using a `definitions` object within a schema. 2 | 3 | It is imported using `allOf` and `$ref`. 4 | 5 | And the description has line breaks. 6 | 7 | So. 8 | 9 | Many. 10 | 11 | Line. 12 | 13 | Bre- 14 | 15 | aks. 16 | 17 | > Everything is better with a quote. 18 | -------------------------------------------------------------------------------- /examples/schemas/definitions.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/definitions", 10 | "title": "Definitions", 11 | "type": "object", 12 | "definitions": { 13 | "myid": { 14 | "properties": { 15 | "id": { 16 | "type": "string", 17 | "format": "uri-reference", 18 | "description": "A unique identifier given to every addressable thing.", 19 | "version": "1.0.0", 20 | "testProperty": "test" 21 | }, 22 | "@id": { 23 | "type": "string", 24 | "format": "uri", 25 | "description": "An `id` with an `@` in front of it. The `@` stands for \"dot com\"", 26 | "version": "1.0.0", 27 | "testProperty": "test" 28 | }, 29 | "meta:id": { 30 | "type": "string", 31 | "format": "email", 32 | "description": "An about ids. It is meta. If you are confused, send an email to the address specified in this property value.", 33 | "version": "1.0.0", 34 | "testProperty": "test" 35 | } 36 | }, 37 | "required": ["@id"] 38 | } 39 | }, 40 | "allOf": [ 41 | {"$ref": "#/definitions/myid"} 42 | ], 43 | "required": [ 44 | "id" 45 | ] 46 | } 47 | -------------------------------------------------------------------------------- /examples/schemas/enums.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/enums", 10 | "title": "Enumerated ", 11 | "type": "object", 12 | "description": "This is an example schema with examples for properties with enum values", 13 | "properties": { 14 | "hello": { 15 | "type": "string", 16 | "enum": ["World", "Welt"], 17 | "description": "A simple string. Pick a value.", 18 | "version": "1.0.0", 19 | "testProperty": "test" 20 | }, 21 | 22 | "nested": { 23 | "title": "Enumerated (Nested)", 24 | "description": "This is an example schema with examples for properties of nested objects with enum values", 25 | "type": "object", 26 | "properties": { 27 | "test": { 28 | "type": "string", 29 | "enum": ["nested", "object", "works"], 30 | "description": "A simple string. Pick a value.", 31 | "version": "1.0.0", 32 | "testProperty": "test" 33 | } 34 | }, 35 | "version": "1.0.0", 36 | "testProperty": "test" 37 | } 38 | }, 39 | "required": [ 40 | "hello" 41 | ] 42 | } 43 | -------------------------------------------------------------------------------- /examples/schemas/example.example.1.json: -------------------------------------------------------------------------------- 1 | { 2 | "foo": "bar", 3 | "bar": "baz" 4 | } -------------------------------------------------------------------------------- /examples/schemas/example.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/example", 10 | "title": "Example", 11 | "type": "object", 12 | "description": "This is an example schema with examples. Too many examples? There can never be too many examples!", 13 | "properties": { 14 | "foo": { 15 | "type": "string", 16 | "description": "A simple string.", 17 | "examples": ["bar"], 18 | "version": "1.0.0", 19 | "testProperty": "test" 20 | }, 21 | "bar": { 22 | "type": "string", 23 | "description": "A simple string.", 24 | "examples": ["bar", "baz"], 25 | "version": "1.0.0", 26 | "testProperty": "test" 27 | } 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /examples/schemas/examples.example.1.json: -------------------------------------------------------------------------------- 1 | { 2 | "foo": "bi", 3 | "bar": "bu" 4 | } -------------------------------------------------------------------------------- /examples/schemas/examples.example.2.json: -------------------------------------------------------------------------------- 1 | { 2 | "foo": "zip", 3 | "bar": "zap" 4 | } -------------------------------------------------------------------------------- /examples/schemas/examples.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/examples", 10 | "title": "Examples", 11 | "type": "object", 12 | "description": "This is an example schema with *multiple* examples. Too many examples? There can never be too many examples!", 13 | "properties": { 14 | "foo": { 15 | "type": "string", 16 | "description": "A simple string.", 17 | "examples": ["bar"], 18 | "version": "1.0.0", 19 | "testProperty": "test" 20 | }, 21 | "bar": { 22 | "type": "string", 23 | "description": "A simple string.", 24 | "examples": ["bar", "baz"], 25 | "version": "1.0.0", 26 | "testProperty": "test" 27 | } 28 | }, 29 | "required": [ 30 | "bar" 31 | ] 32 | } 33 | -------------------------------------------------------------------------------- /examples/schemas/extending.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/extending", 10 | "title": "Extending", 11 | "description": "This is an extending schema. It pulls `definitions` from other schemas.", 12 | "type": "object", 13 | "meta:extensible": true, 14 | "meta:extends": [ 15 | "https://example.com/schemas/definitions", 16 | "https://example.com/schemas/extensible" 17 | ], 18 | "definitions": { 19 | "third": { 20 | "type": "object", 21 | "properties": { 22 | "baz": { 23 | "type": "string", 24 | "title": "BAAAZ!", 25 | "examples": ["I'm just a humble example"], 26 | "description": "This property has a unique name to demonstrate it's uniqueness.", 27 | "version": "1.0.0", 28 | "testProperty": "test" 29 | } 30 | } 31 | } 32 | }, 33 | "allOf": [ 34 | { "$ref": "https://example.com/schemas/extensible#/definitions/second"}, 35 | { "$ref": "https://example.com/schemas/definitions#/definitions/myid" }, 36 | { "$ref": "#/definitions/third" } 37 | ] 38 | } 39 | -------------------------------------------------------------------------------- /examples/schemas/extensible.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/extensible", 10 | "title": "Extensible", 11 | "description": "This is an extensible schema. It has `definitions`, that can be used in other schemas", 12 | "type": "object", 13 | "meta:extensible": true, 14 | "definitions": { 15 | "first": { 16 | "properties": { 17 | "foo": { 18 | "type": "string", 19 | "examples": ["bar"], 20 | "description": "A unique identifier given to every addressable thing.", 21 | "version": "1.0.0", 22 | "testProperty": "test" 23 | } 24 | } 25 | }, 26 | "second": { 27 | "properties": { 28 | "bar": { 29 | "type": "string", 30 | "examples": [ "whoo", "hoo"], 31 | "description": "A horse walks into it.", 32 | "version": "1.0.0", 33 | "testProperty": "test" 34 | } 35 | } 36 | } 37 | } 38 | } -------------------------------------------------------------------------------- /examples/schemas/identifiable.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/identifiable", 10 | "title": "Identifiable", 11 | "description": "This is a *very* simple example of a JSON schema. There is only one property.", 12 | "type": "object", 13 | "properties": { 14 | "@id": { 15 | "type": "string", 16 | "format": "uri", 17 | "description": "A unique identifier given to every addressable thing.", 18 | "version": "1.0.0", 19 | "testProperty": "test" 20 | } 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /examples/schemas/nestedobj.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "$id": "https://example.com/schemas/nestedobject", 3 | "$schema": "http://json-schema.org/draft-07/schema", 4 | "title": "Nested Object", 5 | "type": "object", 6 | "properties": { 7 | "settings": { 8 | "description": "settings", 9 | "type": "object", 10 | "properties": { 11 | "collaborators": { 12 | "description": "collaborators", 13 | "type": "object", 14 | "patternProperties": { 15 | ".*": { 16 | "type": "string" 17 | } 18 | }, 19 | "properties": { 20 | "id": { 21 | "type": "string", 22 | "version": "1.0.0", 23 | "testProperty": "test" 24 | } 25 | }, 26 | "version": "1.0.0", 27 | "testProperty": "test" 28 | } 29 | }, 30 | "version": "1.0.0", 31 | "testProperty": "test" 32 | } 33 | }, 34 | "additionalProperties": false 35 | } 36 | -------------------------------------------------------------------------------- /examples/schemas/pattern.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/pattern", 10 | "title": "Pattern Properties", 11 | "description": "This is an example of a JSON schema with only a `patternProperties` key.", 12 | "patternProperties": { 13 | "[0-9]": { 14 | "type": "string", 15 | "description": "A simple string.", 16 | "examples": ["bar"], 17 | "version": "1.0.0", 18 | "testProperty": "test" 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /examples/schemas/simple.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/simple", 10 | "title": "Simple", 11 | "description": "This is a *very* simple example of a JSON schema. There is only one property.", 12 | "type": "object", 13 | "properties": { 14 | "id": { 15 | "type": "string", 16 | "format": "uri", 17 | "description": "A unique identifier given to every addressable thing.", 18 | "version": "1.0.0", 19 | "testProperty": "test" 20 | } 21 | } 22 | } -------------------------------------------------------------------------------- /examples/schemas/stabilizing.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/stabilizing", 10 | "title": "Stabilizing", 11 | "description": "This is a schema which is currently in the `stabilizing` status.", 12 | "meta:status": "stabilizing", 13 | "type": "object", 14 | "properties": { 15 | "id": { 16 | "type": "string", 17 | "format": "uri", 18 | "description": "A unique identifier given to every addressable thing.", 19 | "version": "1.0.0", 20 | "testProperty": "test" 21 | } 22 | } 23 | } -------------------------------------------------------------------------------- /examples/schemas/subdir/subdir.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/subdir/subdir", 10 | "title": "Subdir", 11 | "type": "object", 12 | "description": "A schema in a sub directory", 13 | "definitions": { 14 | "content": { 15 | "properties": { 16 | "id": { 17 | "type": "string", 18 | "format": "uri", 19 | "description": "A unique identifier given to every addressable thing.", 20 | "version": "1.0.0", 21 | "testProperty": "test" 22 | } 23 | } 24 | } 25 | }, 26 | "allOf": [ 27 | {"$ref": "#/definitions/content"} 28 | ] 29 | } -------------------------------------------------------------------------------- /examples/schemas/typearrays.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/typearrays", 10 | "title": "Type Arrays", 11 | "description": "This schema test type arrays and nullable types", 12 | "type": "object", 13 | "properties": { 14 | "null": { 15 | "type": "null", 16 | "description": "This is just nothing", 17 | "version": "1.0.0", 18 | "testProperty": "test" 19 | }, 20 | "string-or-null": { 21 | "type": ["string", "null"], 22 | "description": "Nullable string", 23 | "version": "1.0.0", 24 | "testProperty": "test" 25 | }, 26 | "string-or-number": { 27 | "type": ["string", "number"], 28 | "description": "Types can be many things", 29 | "version": "1.0.0", 30 | "testProperty": "test" 31 | }, 32 | "string-or-number-null": { 33 | "type": ["string", "number", "null"], 34 | "description": "Types can be many things, even nothing at all.", 35 | "version": "1.0.0", 36 | "testProperty": "test" 37 | } 38 | } 39 | } -------------------------------------------------------------------------------- /examples/status.md: -------------------------------------------------------------------------------- 1 | # Status 2 | 3 | We know multiple stati 4 | -------------------------------------------------------------------------------- /lib/formattingTools.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Adobe. All rights reserved. 3 | * This file is licensed to you under the Apache License, Version 2.0 (the "License"); 4 | * you may not use this file except in compliance with the License. You may obtain a copy 5 | * of the License at http://www.apache.org/licenses/LICENSE-2.0 6 | * 7 | * Unless required by applicable law or agreed to in writing, software distributed under 8 | * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS 9 | * OF ANY KIND, either express or implied. See the License for the specific language 10 | * governing permissions and limitations under the License. 11 | */ 12 | import i from 'es2015-i18n-tag'; 13 | import s from './symbols.js'; 14 | 15 | const { default: i18n } = i; 16 | 17 | export function gentitle(titles, type) { 18 | if (!Array.isArray(titles)) { 19 | return i18n`Untitled schema`; 20 | } 21 | const [firsttitle] = titles; 22 | const lasttitle = [...titles].pop(); 23 | 24 | if (titles.length === 1 && firsttitle !== undefined) { 25 | return firsttitle; 26 | } 27 | if (lasttitle) { 28 | return lasttitle; 29 | } 30 | if (typeof type === 'string') { 31 | return i18n`Untitled ${type} in ${String(firsttitle)}`; 32 | } 33 | if (firsttitle === undefined) { 34 | return i18n`Untitled schema`; 35 | } 36 | return i18n`Untitled undefined type in ${firsttitle}`; 37 | } 38 | 39 | export function gendescription(schema) { 40 | return (schema && schema[s.meta]) ? schema[s.meta].shortdescription : ''; 41 | } 42 | -------------------------------------------------------------------------------- /lib/keywords.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Adobe. All rights reserved. 3 | * This file is licensed to you under the Apache License, Version 2.0 (the "License"); 4 | * you may not use this file except in compliance with the License. You may obtain a copy 5 | * of the License at http://www.apache.org/licenses/LICENSE-2.0 6 | * 7 | * Unless required by applicable law or agreed to in writing, software distributed under 8 | * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS 9 | * OF ANY KIND, either express or implied. See the License for the specific language 10 | * governing permissions and limitations under the License. 11 | */ 12 | const used = new Set(); 13 | 14 | export function keyword(str) { 15 | used.add(str[0]); 16 | return str.join(''); 17 | } 18 | 19 | export function report() { 20 | return used; 21 | } 22 | -------------------------------------------------------------------------------- /lib/locales/update.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Adobe. All rights reserved. 3 | * This file is licensed to you under the Apache License, Version 2.0 (the "License"); 4 | * you may not use this file except in compliance with the License. You may obtain a copy 5 | * of the License at http://www.apache.org/licenses/LICENSE-2.0 6 | * 7 | * Unless required by applicable law or agreed to in writing, software distributed under 8 | * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS 9 | * OF ANY KIND, either express or implied. See the License for the specific language 10 | * governing permissions and limitations under the License. 11 | */ 12 | // eslint-disable-next-line import/no-extraneous-dependencies 13 | import { exportTranslationKeys } from 'i18n-tag-schema'; 14 | import fs from 'fs-extra'; 15 | 16 | exportTranslationKeys({ rootPath: './lib' }) 17 | .then((result) => { 18 | const translations = fs.readJsonSync('./lib/locales/en_US.json'); 19 | 20 | translations.translations = result.reduce((transl, key) => { 21 | if (!transl[key]) { 22 | // eslint-disable-next-line no-param-reassign 23 | transl[key] = key; 24 | } 25 | return transl; 26 | }, translations.translations); 27 | 28 | fs.writeJsonSync('./lib/locales/en_US.json', translations, { spaces: 2 }); 29 | }) 30 | .catch((err) => { 31 | console.error(err.message); 32 | }); 33 | -------------------------------------------------------------------------------- /lib/symbols.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Adobe. All rights reserved. 3 | * This file is licensed to you under the Apache License, Version 2.0 (the "License"); 4 | * you may not use this file except in compliance with the License. You may obtain a copy 5 | * of the License at http://www.apache.org/licenses/LICENSE-2.0 6 | * 7 | * Unless required by applicable law or agreed to in writing, software distributed under 8 | * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS 9 | * OF ANY KIND, either express or implied. See the License for the specific language 10 | * governing permissions and limitations under the License. 11 | */ 12 | 13 | /** 14 | * @typedef {import("../types/api").UniqueSymbols} UniqueSymbols 15 | */ 16 | 17 | export const filename = Symbol('filename'); 18 | export const fullpath = Symbol('fullpath'); 19 | 20 | /** 21 | * @type {UniqueSymbols} 22 | * */ 23 | const symbols = { 24 | pointer: Symbol('pointer'), 25 | filename, 26 | fullpath, 27 | id: Symbol('id'), 28 | titles: Symbol('titles'), 29 | resolve: Symbol('resolve'), 30 | slug: Symbol('slug'), 31 | meta: Symbol('meta'), 32 | parent: Symbol('parent'), 33 | }; 34 | 35 | export default symbols; 36 | -------------------------------------------------------------------------------- /test/fixtures/additionalprops/additionalprops.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "object", 3 | "additionalProperties": true, 4 | "minProperties": 10, 5 | "maxProperties": 99 6 | } -------------------------------------------------------------------------------- /test/fixtures/additionalprops/arrays.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "array", 3 | "uniqueItems": true, 4 | "minContains": 1, 5 | "maxContains": 9, 6 | "contains": { 7 | "type": "boolean" 8 | } 9 | } -------------------------------------------------------------------------------- /test/fixtures/arrays/tuple.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/arrays", 10 | "title": "Arrays", 11 | "type": "object", 12 | "description": "This is an example schema with examples for multiple array types and their constraints.", 13 | "properties": { 14 | "tuple": { 15 | "type": "array", 16 | "description": "This is an array of two values, one positive, one negative. All additional values must be 0.", 17 | "items": [ 18 | { 19 | "title": "Positive Integer", 20 | "type": "integer", 21 | "minimum": 0 22 | }, 23 | { 24 | "title": "Negative Integer", 25 | "type": "integer", 26 | "maximum": 0 27 | } 28 | ], 29 | "additionalItems": { 30 | "title": "Zero", 31 | "const": 0 32 | } 33 | } 34 | } 35 | } -------------------------------------------------------------------------------- /test/fixtures/content/html.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "string", 3 | "title": "HTML", 4 | "contentMediaType": "text/html" 5 | } -------------------------------------------------------------------------------- /test/fixtures/content/jwt.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "string", 3 | "title": "JWT", 4 | "contentMediaType": "application/jwt", 5 | "contentSchema": { 6 | "title": "JSON Web Token", 7 | "type": "array", 8 | "minItems": 2, 9 | "items": [ 10 | { 11 | "const": { 12 | "typ": "JWT", 13 | "alg": "HS256" 14 | } 15 | }, 16 | { 17 | "type": "object", 18 | "required": ["iss", "exp"], 19 | "properties": { 20 | "iss": {"type": "string"}, 21 | "exp": {"type": "integer"} 22 | } 23 | } 24 | ] 25 | } 26 | } -------------------------------------------------------------------------------- /test/fixtures/content/png.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "string", 3 | "title": "PNG", 4 | "contentEncoding": "base64", 5 | "contentMediaType": "image/png" 6 | } -------------------------------------------------------------------------------- /test/fixtures/cyclic/one.description.md: -------------------------------------------------------------------------------- 1 | The first schema in the cycle (or is it the last?) -------------------------------------------------------------------------------- /test/fixtures/cyclic/one.example.1.json: -------------------------------------------------------------------------------- 1 | {} -------------------------------------------------------------------------------- /test/fixtures/cyclic/one.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "http://json-schema.org/draft-04/schema#", 3 | "$id": "http://example.com/schemas/one", 4 | 5 | "type": "object", 6 | "properties": { 7 | "children": { 8 | "type": "array", 9 | "items": { 10 | "anyOf": [ 11 | { "$ref": "http://example.com/schemas/three" }, 12 | { "$ref": "http://example.com/schemas/two" } 13 | ] 14 | } 15 | } 16 | } 17 | } -------------------------------------------------------------------------------- /test/fixtures/cyclic/three.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "http://json-schema.org/draft-04/schema#", 3 | "$id": "http://example.com/schemas/three", 4 | 5 | "type": "object", 6 | "properties": { 7 | "children": { 8 | "type": "array", 9 | "items": { 10 | "anyOf": [ 11 | { "$ref": "http://example.com/schemas/one" }, 12 | { "$ref": "http://example.com/schemas/two" } 13 | ] 14 | } 15 | } 16 | } 17 | } -------------------------------------------------------------------------------- /test/fixtures/cyclic/two.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "http://json-schema.org/draft-04/schema#", 3 | "$id": "http://example.com/schemas/two", 4 | 5 | "type": "object", 6 | "properties": { 7 | "children": { 8 | "type": "array", 9 | "items": { 10 | "anyOf": [ 11 | { "$ref": "http://example.com/schemas/one" }, 12 | { "$ref": "http://example.com/schemas/three" } 13 | ] 14 | } 15 | } 16 | } 17 | } -------------------------------------------------------------------------------- /test/fixtures/deadref/deadref.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "object", 3 | "properties": { 4 | "foo": { "$ref": "http://unknown-ref"} 5 | } 6 | } -------------------------------------------------------------------------------- /test/fixtures/enums/arrayenums.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "http://json-schema.org/draft-07/schema", 3 | "$id": "file://foo/mod.json", 4 | "title": "MI", 5 | "description": "Specification for input JSON", 6 | "type": "object", 7 | "properties": { 8 | "columns": { 9 | "title": "Columns", 10 | "meta:enum": { 11 | "[\"P\",\"M\"]": "Post Meridiem?" 12 | }, 13 | "enum": [ 14 | [ 15 | "P", 16 | "M" 17 | ], 18 | [ 19 | "M", 20 | "P" 21 | ] 22 | ], 23 | "type": "array" 24 | } 25 | }, 26 | "required": [ 27 | "columns" 28 | ] 29 | } -------------------------------------------------------------------------------- /test/fixtures/enums/enums.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "object", 3 | "properties": { 4 | "withmeta": { 5 | "foo": "bar", 6 | "enum": [ 7 | "baa", "bad", "bag", "bah", "bam", "ban", "bap", "bas", "bat", "bay" 8 | ], 9 | "meta:enum": { 10 | "baa": "the sounds of sheeps", 11 | "bad": "German bathroom", 12 | "bag": "holding device", 13 | "bah": "humbug!", 14 | "bam": "a loud sound", 15 | "ban": "don't do this", 16 | "bap": "a British soft bread roll", 17 | "bas": "from ancient Egyptian religion, an aspect of the soul", 18 | "bat": "…out of hell", 19 | "bay": ", sitting by the dock of the" 20 | } 21 | }, 22 | "withoutmeta": { 23 | "bar": "foo", 24 | "enum": [ 25 | "baa", "bad", "bag", "bah", "bam", "ban", "bap", "bas", "bat", "bay" 26 | ] 27 | } 28 | } 29 | } -------------------------------------------------------------------------------- /test/fixtures/example/proxy.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license":[ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema":"http://json-schema.org/draft-06/schema#", 9 | "$id":"https://example.com/schemas/example-proxy", 10 | "title":"Example Proxy", 11 | "type":"object", 12 | "description":"This is an example schema with examples. Too many examples? There can never be too many examples!", 13 | "properties":{ 14 | "foo":{ 15 | "type":"string", 16 | "description":"A simple string.", 17 | "examples":[ 18 | "bar" 19 | ], 20 | "version":"1.0.0", 21 | "testProperty":"test" 22 | }, 23 | "bar":{ 24 | "type":"string", 25 | "description":"A simple string.", 26 | "examples":[ 27 | "bar", 28 | "baz" 29 | ], 30 | "version":"1.0.0", 31 | "testProperty":"test" 32 | }, 33 | "zip":{ 34 | "type":"object", 35 | "title":"An object" 36 | }, 37 | "zup":{ 38 | "type":"object", 39 | "title":"An object" 40 | }, 41 | "baz":{ 42 | "anyOf":[ 43 | { 44 | "$ref":"#/properties/foo" 45 | }, 46 | { 47 | "$ref":"#/properties/bar" 48 | } 49 | ] 50 | } 51 | } 52 | } 53 | -------------------------------------------------------------------------------- /test/fixtures/format/format.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "object", 3 | "title": "Properties", 4 | "description": "Properties of Datepicker.", 5 | 6 | "additionalProperties": false, 7 | "properties": { 8 | "format": { 9 | "type": "string", 10 | "title": "Format", 11 | "description": "Formatting used to display the date." 12 | }, 13 | "value": { 14 | "type": "string", 15 | "title": "Value", 16 | "description": "Date to be displayed." 17 | } 18 | }, 19 | "examples": [ 20 | { 21 | "format": "Coolness", 22 | "value": "Maximum" 23 | } 24 | ] 25 | } -------------------------------------------------------------------------------- /test/fixtures/identifiable/identifiable.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/identifiable", 10 | "title": "Identifiable", 11 | "description": "This is a *very* simple example of a JSON schema. There is only one property.", 12 | "type": "object", 13 | "properties": { 14 | "@id": { 15 | "type": "string", 16 | "format": "uri", 17 | "description": "A unique identifier given to every addressable thing.", 18 | "version": "1.0.0", 19 | "testProperty": "test" 20 | } 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /test/fixtures/not/not.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Not true", 3 | "not": { 4 | "const": true, 5 | "title": "True" 6 | } 7 | } -------------------------------------------------------------------------------- /test/fixtures/null/null.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "object", 3 | "properties": { 4 | "may": { 5 | "type": ["null", "boolean"] 6 | }, 7 | "must": { 8 | "type": "null" 9 | }, 10 | "constant": { 11 | "const": null 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /test/fixtures/nullable/array.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "http://json-schema.org/draft-07/schema", 3 | "$id": "http://example.com/type-array-repro.json", 4 | "type": "object", 5 | "title": "Type Array Repro", 6 | "description": "Type Array Issue Reproduction", 7 | "required": [ 8 | "sampleProp" 9 | ], 10 | "additionalProperties": false, 11 | "properties": { 12 | "sampleProp": { 13 | "type": ["string", "null"], 14 | "title": "Sample Property" 15 | } 16 | } 17 | } -------------------------------------------------------------------------------- /test/fixtures/readme-1/abstract.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/abstract", 10 | "title": "Abstract", 11 | "readOnly": true, 12 | "writeOnly": true, 13 | "description": "This is an abstract schema. It has `definitions`, but does not declare any properties", 14 | "type": "object", 15 | "$defs": { 16 | "first": { 17 | "type": "object", 18 | "properties": { 19 | "foo": { 20 | "type": "string", 21 | "description": "A unique identifier given to every addressable thing.", 22 | "version": "1.0.0", 23 | "testProperty": "test", 24 | "readOnly": true 25 | }, 26 | "nonfoo": { 27 | "type": "boolean", 28 | "const": false, 29 | "description": "This is not foo.", 30 | "version": "1.0.0", 31 | "testProperty": "test", 32 | "writeOnly": true 33 | } 34 | } 35 | }, 36 | "second": { 37 | "type":"object", 38 | "properties": { 39 | "bar": { 40 | "type": "string", 41 | "description": "A unique identifier given to every addressable thing.", 42 | "version": "1.0.0", 43 | "testProperty": "test", 44 | "readOnly": true, 45 | "writeOnly": true 46 | } 47 | } 48 | } 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /test/fixtures/readme-1/simple.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "meta:license": [ 3 | "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", 4 | "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", 5 | "you may not use this file except in compliance with the License. You may obtain a copy", 6 | "of the License at http://www.apache.org/licenses/LICENSE-2.0" 7 | ], 8 | "$schema": "http://json-schema.org/draft-06/schema#", 9 | "$id": "https://example.com/schemas/simple", 10 | "title": "Simple", 11 | "$comment": "I'm just a simple schema, living a simple life.", 12 | "deprecated": true, 13 | "writeOnly": true, 14 | "description": "This is a *very* simple example of a JSON schema. There is only one property.", 15 | "type": "object", 16 | "properties": { 17 | "id": { 18 | "type": "string", 19 | "format": "uri", 20 | "description": "A unique identifier given to every addressable thing.", 21 | "version": "1.0.0", 22 | "testProperty": "test" 23 | }, 24 | "name": { 25 | "type": "string", 26 | "default": "Simply Untitled", 27 | "$comment": "This should be here" 28 | } 29 | } 30 | } -------------------------------------------------------------------------------- /test/fixtures/skipproperties/complete.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "http://json-schema.org/draft-07/schema#", 3 | "title": "Complete JSON Schema", 4 | "description": "Testing for skipped props", 5 | "type": "object", 6 | "properties": { 7 | "foo": { 8 | "type": "string" 9 | }, 10 | "bar": { 11 | "description": "Configures the bar property", 12 | "type": "boolean", 13 | "default": "true" 14 | }, 15 | "foobar": { 16 | "description": "Overwrite the bar value", 17 | "examples":[{ 18 | "bar": "true", 19 | "foobar": "no" 20 | }], 21 | "type": "string", 22 | "format": "yes/no" 23 | } 24 | }, 25 | "additionalProperties": false, 26 | "required": [ 27 | "bar" 28 | ] 29 | } 30 | -------------------------------------------------------------------------------- /test/fixtures/type/button.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "http://json-schema.org/draft-04/schema#", 3 | "$id": "http://www.example.com/schemas/components/Button.json", 4 | "type": "object", 5 | "title": "Button", 6 | "description": "Renders a Button.", 7 | "additionalProperties": false, 8 | "properties": { 9 | "properties": { 10 | "type": "object", 11 | "title": "Properties", 12 | "description": "Properties of Button.", 13 | "additionalProperties": false, 14 | "properties": { 15 | "type": { 16 | "type": "string", 17 | "enum": [ 18 | "button", 19 | "submit", 20 | "reset" 21 | ], 22 | "title": "Type", 23 | "description": "The type of the Button (not used for anchors)." 24 | } 25 | } 26 | } 27 | } 28 | } -------------------------------------------------------------------------------- /test/fixtures/type/type.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "object", 3 | "title": "Properties", 4 | "description": "Properties of Button.", 5 | 6 | "additionalProperties": false, 7 | "properties": { 8 | "value": { 9 | "type": "string", 10 | "title": "Value", 11 | "description": "The value of the Button." 12 | }, 13 | "type": { 14 | "type": "string", 15 | "enum": ["button", "submit", "reset"], 16 | "title": "Type", 17 | "description": "The type of the Button (not used for anchors)." 18 | } 19 | } 20 | } -------------------------------------------------------------------------------- /test/fixtures/types/merged.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "oneOf": [ 3 | { 4 | "type": "string" 5 | }, 6 | { 7 | "type": "array" 8 | } 9 | ] 10 | } -------------------------------------------------------------------------------- /test/fixtures/types/object.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "object" 3 | } -------------------------------------------------------------------------------- /test/fixtures/types/objectorarray.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": ["object", "array"] 3 | } -------------------------------------------------------------------------------- /test/fixtures/types/undefined.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "You don't know what I am" 3 | } -------------------------------------------------------------------------------- /test/fixtures/types/wrong.schema.json: -------------------------------------------------------------------------------- 1 | { 2 | "$id": "https://example.com/ns/wrong", 3 | "type": { 4 | "this": "is wrong" 5 | } 6 | } -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es6", 4 | "module": "commonjs", 5 | "moduleResolution": "node", 6 | "allowJs": true, 7 | "declaration": true, 8 | "emitDeclarationOnly": true, 9 | "removeComments": false, 10 | "outDir": "types" 11 | }, 12 | "include": ["lib/index.js"], 13 | "exclude": ["**/locales/**/*"] 14 | } 15 | -------------------------------------------------------------------------------- /types/formatInfo.d.ts: -------------------------------------------------------------------------------- 1 | export default function formatmeta(schema: any): { 2 | longcomment: import("mdast").Root; 3 | shortcomment: any; 4 | comment: string; 5 | longdescription: import("mdast").Root; 6 | shortdescription: any; 7 | description: any; 8 | abstract: boolean; 9 | extensible: boolean; 10 | status: any; 11 | identifiable: string; 12 | custom: boolean; 13 | additional: boolean; 14 | definedin: { 15 | text: any; 16 | link: any; 17 | }; 18 | restrictions: string; 19 | }; 20 | -------------------------------------------------------------------------------- /types/formattingTools.d.ts: -------------------------------------------------------------------------------- 1 | export function gentitle(titles: any, type: any): any; 2 | export function gendescription(schema: any): any; 3 | -------------------------------------------------------------------------------- /types/keywords.d.ts: -------------------------------------------------------------------------------- 1 | export function keyword(str: any): any; 2 | export function report(): Set; 3 | -------------------------------------------------------------------------------- /types/markdownBuilder.d.ts: -------------------------------------------------------------------------------- 1 | export default function build({ header, links, includeProperties, rewritelinks, exampleFormat, skipProperties, }?: { 2 | header: any; 3 | links?: {}; 4 | includeProperties?: any[]; 5 | rewritelinks?: (x: any) => any; 6 | exampleFormat?: string; 7 | skipProperties?: any[]; 8 | }): (schemas: any) => any; 9 | -------------------------------------------------------------------------------- /types/readmeBuilder.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Generate the README.md 3 | * @param {object} opts 4 | */ 5 | export default function build({ readme }: object): (schemas: any) => import("unist").Parent, import("unist").Data>; 6 | -------------------------------------------------------------------------------- /types/schemaProxy.d.ts: -------------------------------------------------------------------------------- 1 | export default function loader(): (name: string, schema: any) => any; 2 | -------------------------------------------------------------------------------- /types/symbols.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * @typedef {import("../types/api").UniqueSymbols} UniqueSymbols 3 | */ 4 | export const filename: unique symbol; 5 | export const fullpath: unique symbol; 6 | export default symbols; 7 | export type UniqueSymbols = import("../types/api").UniqueSymbols; 8 | /** 9 | * @type {UniqueSymbols} 10 | * */ 11 | declare const symbols: UniqueSymbols; 12 | -------------------------------------------------------------------------------- /types/traverseSchema.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Traverses a Schema node (containing a JSON Schema) to find sub-schemas, 3 | * which are then emitted as asequence. 4 | * @param {Schema} node 5 | */ 6 | export default function traverse(schemas: any): any[]; 7 | -------------------------------------------------------------------------------- /types/writeSchema.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * @typedef {import("../types/api").ExtendedJsonSchema} ExtendedJsonSchema 3 | */ 4 | /** 5 | * @typedef {import("../types/api").SchemaContent} SchemaContent 6 | */ 7 | /** 8 | * Write the JSON Schemas to filesystem or an object 9 | * @param {Object} options 10 | * @param {string} [options.schemadir] - (optional) Directory where the files will be saved 11 | * @param {string} [options.origindir] - (optional) Directory where the files were loaded from 12 | * @returns {(schemas: ExtendedJsonSchema[]) => SchemaContent[]} 13 | */ 14 | export default function writeSchema({ schemadir, origindir }: { 15 | schemadir?: string; 16 | origindir?: string; 17 | }): (schemas: ExtendedJsonSchema[]) => SchemaContent[]; 18 | export type ExtendedJsonSchema = import("../types/api").ExtendedJsonSchema; 19 | export type SchemaContent = import("../types/api").SchemaContent; 20 | --------------------------------------------------------------------------------