{% from "macro_restriction.html" import restriction with context %} {%- macro tabbed_section(operator, current_node) -%} {% include "tabbed_section.html" %} {%- endmacro -%} {%- macro content(schema, description="") -%} {% set keys = schema.keywords %} {%- set description = (schema | get_description) if not description else description -%} {%- if schema.should_be_a_link(config) -%} {# There can be a description next to $ref, so let's display it. Fallback to description of referenced element #} {% include "section_description.html" %} Same definition as {{ schema.refers_to.html_id }} {%- elif schema.refers_to -%} {{ content(schema.refers_to, description) }} {%- else -%} {# Handle having oneOf or allOf with only one condition #} {%- if "allOf" in keys and (keys["allOf"].array_items | length) == 1 -%} {% include "section_description.html" %} {{ content(keys["allOf"].array_items[0]) }} {%- elif "anyOf" in keys and (keys["anyOf"].array_items | length) == 1 -%} {% include "section_description.html" %} {{ content(keys["anyOf"].array_items[0]) }} {%- else -%} {# Resolve type #} {%- set type_name = schema | get_type_name -%} {# Display type #} {%- if not schema is combining -%} Type: {{ type_name }} {%- endif -%} {%- if "default" in keys -%} {{ " " }}Default: {{ schema | get_default }} {%- endif -%} {% include "section_description.html" %} {# Combining: allOf, anyOf, oneOf, not #} {%- if "allOf" in keys -%} {% set current_node = keys["allOf"] %}
{{ tabbed_section("allOf", current_node) }}
{%- endif -%} {%- if "anyOf" in keys -%} {% set current_node = keys["anyOf"] %}
{{ tabbed_section("anyOf", current_node) }}
{%- endif -%} {%- if "oneOf" in keys -%} {% set current_node = keys["oneOf"] %}
{{ tabbed_section("oneOf", current_node) }}
{%- endif -%} {%- if "not" in keys -%} {% include "section_not.html" %} {%- endif -%} {# Enum and const #} {%- if "enum" in keys -%}

Must be one of:

{%- endif -%} {%- if "const" in keys -%} Specific value: {{ keys["const"].literal | python_to_json }} {%- endif -%} {# Pattern (Regular Expression) #} {%- if "pattern" in keys -%} Must match regular expression: {{ keys["pattern"].literal | escape }} {%- endif -%} {# Conditional subschema, or if-then-else section #} {%- if "if" in keys and ("then" in keys or "else" in keys) -%} {% include "section_conditional_subschema.html" %} {%- endif -%} {# Required properties that are not defined under "properties". They will only be listed #} {% include "section_undocumented_required_properties.html" %} {# Show the requested type(s) #} {% include "badge_type.html" %} {# Show array restrictions #} {%- if type_name.startswith("array") -%} {% include "section_array.html" %} {%- endif -%} {# Display examples #} {%- set examples = (keys.get("examples") or []) -%} {%- if examples -%} {% include "section_examples.html" %} {%- endif -%} {%- set required_properties = schema | get_required_properties -%} {%- if "properties" in keys -%} {% set is_pattern_property = False %} {%- for sub_property_name, sub_property in keys["properties"].keywords.items() -%} {% include "section_properties.html" %} {%- endfor -%} {%- endif -%} {%- if "patternProperties" in keys -%} {% set is_pattern_property = True %} {%- for sub_property_name, sub_property in keys["patternProperties"].keywords.items() -%} {% include "section_properties.html" %} {%- endfor -%} {%- endif -%} {%- endif -%} {%- endif -%} {%- endmacro -%}