Skip to content
Snippets Groups Projects
Commit 1e5ba4f1 authored by Lars Trieloff's avatar Lars Trieloff
Browse files

Include example for an identifiable schema

parent f7249ae8
Branches
Tags
No related merge requests found
...@@ -3,3 +3,26 @@ ...@@ -3,3 +3,26 @@
# Readme # Readme
## /
* [Abstract](./abstract.schema.md)`https://example.com/schemas/abstract`
* [Arrays](./arrays.schema.md)`https://example.com/schemas/arrays`
* [Complex References ](./complex.schema.md)`https://example.com/schemas/complex`
* [Constant Types](./constants.schema.md)`https://example.com/schemas/constants`
* [Custom](./custom.schema.md)`https://example.com/schemas/custom`
* [Deeply Extending](./deepextending.schema.md)`https://example.com/schemas/deepextending`
* [Definitions](./definitions.schema.md)`https://example.com/schemas/definitions`
* [Enumerated ](./enums.schema.md)`https://example.com/schemas/enums`
* [Example](./example.schema.md)`https://example.com/schemas/example`
* [Examples](./examples.schema.md)`https://example.com/schemas/examples`
* [Extending](./extending.schema.md)`https://example.com/schemas/extending`
* [Extensible](./extensible.schema.md)`https://example.com/schemas/extensible`
* [Identifiable](./identifiable.schema.md)`https://example.com/schemas/identifiable`
* [Simple](./simple.schema.md)`https://example.com/schemas/simple`
* [Simple Types](./simpletypes.schema.md)`https://example.com/schemas/simpletypes`
* [Stabilizing](./stabilizing.schema.md)`https://example.com/schemas/stabilizing`
## /subdir/
* [Subdir](./subdir/subdir.schema.md)`https://example.com/schemas/subdir/subdir`
---
template: reference
foo: bar
---
# Identifiable Schema
```
https://example.com/schemas/identifiable
```
This is a *very* simple example of a JSON schema. There is only one property.
| [Abstract](../abstract.md) | Extensible | [Status](../status.md) | Identifiable | Custom Properties | Additional Properties | Defined In |
|----------------------------|------------|------------------------|--------------|-------------------|-----------------------|------------|
| Can be instantiated | No | Experimental | Yes | Forbidden | Permitted | [identifiable.schema.json](identifiable.schema.json) |
# Identifiable Properties
| Property | Type | Required | Defined by |
|----------|------|----------|------------|
| [@id](#@id) | `string` | Optional | Identifiable (this schema) |
| `*` | any | Additional | this schema *allows* additional properties |
## @id
A unique identifier given to every addressable thing.
`@id`
* is optional
* type: `string`
* defined in this schema
### @id Type
`string`
* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986))
{
"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",
"allOf": [
{
"$ref": "#/definitions/id"
}
],
"properties": {
"@id": {
"type": "string",
"format": "uri",
"description": "A unique identifier given to every addressable thing."
}
}
}
\ No newline at end of file
{
"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",
"allOf": [
{
"$ref": "#/definitions/id"
}
],
"properties": {
"@id": {
"type": "string",
"format": "uri",
"description": "A unique identifier given to every addressable thing."
}
}
}
---
template: reference
foo: bar
---
# Identifiable Schema
```
https://example.com/schemas/identifiable
```
This is a *very* simple example of a JSON schema. There is only one property.
| [Abstract](../abstract.md) | Extensible | [Status](../status.md) | Identifiable | Custom Properties | Additional Properties | Defined In |
|----------------------------|------------|------------------------|--------------|-------------------|-----------------------|------------|
| Can be instantiated | No | Experimental | Yes | Forbidden | Permitted | [identifiable.schema.json](identifiable.schema.json) |
# Identifiable Properties
| Property | Type | Required | Defined by |
|----------|------|----------|------------|
| [@id](#@id) | `string` | Optional | Identifiable (this schema) |
| `*` | any | Additional | this schema *allows* additional properties |
## @id
A unique identifier given to every addressable thing.
`@id`
* is optional
* type: `string`
* defined in this schema
### @id Type
`string`
* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986))
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment