340873bd12
An extra "http://" in the rst format for the link to JSON Schema web page has been removed. The link when documents are rendered should now work as intended. Change-Id: I4da9c9301db055a62679c4ca1da73ae728220e88 Closes-Bug: #1488903
161 lines
5.0 KiB
ReStructuredText
161 lines
5.0 KiB
ReStructuredText
..
|
|
Licensed 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
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
=============================
|
|
Mapping Schema for Federation
|
|
=============================
|
|
|
|
Description
|
|
-----------
|
|
|
|
The schema for mapping is a description of how a mapping should be created.
|
|
It shows all the requirements and possibilities for a JSON to be used for mapping.
|
|
|
|
Mapping schema is validated with `JSON Schema
|
|
<http://json-schema.org/documentation.html>`__
|
|
|
|
Mapping Schema
|
|
--------------
|
|
|
|
The rules supported must use the following schema:
|
|
|
|
.. code-block:: javascript
|
|
|
|
{
|
|
"type": "object",
|
|
"required": ['rules'],
|
|
"properties": {
|
|
"rules": {
|
|
"minItems": 1,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"required": ['local', 'remote'],
|
|
"additionalProperties": False,
|
|
"properties": {
|
|
"local": {
|
|
"type": "array"
|
|
},
|
|
"remote": {
|
|
"minItems": 1,
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"oneOf": [
|
|
{"$ref": "#/definitions/empty"},
|
|
{"$ref": "#/definitions/any_one_of"},
|
|
{"$ref": "#/definitions/not_any_of"},
|
|
{"$ref": "#/definitions/blacklist"},
|
|
{"$ref": "#/definitions/whitelist"}
|
|
],
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"empty": {
|
|
"type": "object",
|
|
"required": ['type'],
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
},
|
|
"additionalProperties": False,
|
|
},
|
|
"any_one_of": {
|
|
"type": "object",
|
|
"additionalProperties": False,
|
|
"required": ['type', 'any_one_of'],
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"any_one_of": {
|
|
"type": "array"
|
|
},
|
|
"regex": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"not_any_of": {
|
|
"type": "object",
|
|
"additionalProperties": False,
|
|
"required": ['type', 'not_any_of'],
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"not_any_of": {
|
|
"type": "array"
|
|
},
|
|
"regex": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"blacklist": {
|
|
"type": "object",
|
|
"additionalProperties": False,
|
|
"required": ['type', 'blacklist'],
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"blacklist": {
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"whitelist": {
|
|
"type": "object",
|
|
"additionalProperties": False,
|
|
"required": ['type', 'whitelist'],
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"whitelist": {
|
|
"type": "array"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
.. NOTE::
|
|
|
|
``"additionalProperties": False``, shows that only the properties shown can be displayed.
|
|
|
|
.. code-block:: javascript
|
|
|
|
"whitelist": {
|
|
"type": "object",
|
|
"additionalProperties": False,
|
|
"required": ['type', 'whitelist'],
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"whitelist": {
|
|
"type": "array"
|
|
}
|
|
}
|
|
}
|
|
|
|
Keystone will not accept any other keys in the JSON mapping other than ``type``, and
|
|
``whitelist``.
|