Vocabulary.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2025 nfx
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

 
#pragma once
 
#include <string_view>
 
namespace nfx::serialization::json::vocabulary
{
    //=====================================================================
    // JSON Schema Draft URIs
    //=====================================================================

    inline constexpr std::string_view SCHEMA_DRAFT_2020_12{ "https://json-schema.org/draft/2020-12/schema" };

    inline constexpr std::string_view SCHEMA_DRAFT_2019_09{ "https://json-schema.org/draft/2019-09/schema" };

    inline constexpr std::string_view SCHEMA_DRAFT_07{ "http://json-schema.org/draft-07/schema#" };

    inline constexpr std::string_view SCHEMA_DRAFT_06{ "http://json-schema.org/draft-06/schema#" };

    inline constexpr std::string_view SCHEMA_DRAFT_04{ "http://json-schema.org/draft-04/schema#" };
 
    //=====================================================================
    // JSON vocabulary
    //=====================================================================
 
    //----------------------------------------------
    // Core
    //----------------------------------------------

    inline constexpr std::string_view CORE_ID{ "$id" };

    inline constexpr std::string_view CORE_SCHEMA{ "$schema" };

    inline constexpr std::string_view CORE_REF{ "$ref" };

    inline constexpr std::string_view CORE_COMMENT{ "$comment" };

    inline constexpr std::string_view CORE_DEFS{ "$defs" };

    inline constexpr std::string_view CORE_ANCHOR{ "$anchor" };

    inline constexpr std::string_view CORE_DYNAMIC_ANCHOR{ "$dynamicAnchor" };

    inline constexpr std::string_view CORE_DYNAMIC_REF{ "$dynamicRef" };

    inline constexpr std::string_view CORE_VOCABULARY{ "$vocabulary" };
 
    //----------------------------------------------
    // Applicator
    //----------------------------------------------

    inline constexpr std::string_view APPLICATOR_ALL_OF{ "allOf" };

    inline constexpr std::string_view APPLICATOR_ANY_OF{ "anyOf" };

    inline constexpr std::string_view APPLICATOR_ONE_OF{ "oneOf" };

    inline constexpr std::string_view APPLICATOR_IF{ "if" };

    inline constexpr std::string_view APPLICATOR_THEN{ "then" };

    inline constexpr std::string_view APPLICATOR_ELSE{ "else" };

    inline constexpr std::string_view APPLICATOR_NOT{ "not" };

    inline constexpr std::string_view APPLICATOR_PROPERTIES{ "properties" };

    inline constexpr std::string_view APPLICATOR_ADDITIONAL_PROPERTIES{ "additionalProperties" };

    inline constexpr std::string_view APPLICATOR_PATTERN_PROPERTIES{ "patternProperties" };

    inline constexpr std::string_view APPLICATOR_DEPENDENT_SCHEMAS{ "dependentSchemas" };

    inline constexpr std::string_view APPLICATOR_PROPERTY_NAMES{ "propertyNames" };

    inline constexpr std::string_view APPLICATOR_CONTAINS{ "contains" };

    inline constexpr std::string_view APPLICATOR_ITEMS{ "items" };

    inline constexpr std::string_view APPLICATOR_PREFIX_ITEMS{ "prefixItems" };
 
    //----------------------------------------------
    // Defined formats (JSON Schema Draft 2020-12 Section 7.3)
    //----------------------------------------------
 
    //-----------------------------
    // Dates, Times, and Duration (RFC 3339)
    //-----------------------------

    inline constexpr std::string_view FORMAT_DATETIME{ "date-time" };

    inline constexpr std::string_view FORMAT_DATE{ "date" };

    inline constexpr std::string_view FORMAT_TIME{ "time" };

    inline constexpr std::string_view FORMAT_DURATION{ "duration" };
 
    //-----------------------------
    // Email Addresses (RFC 5321/6531)
    //-----------------------------

    inline constexpr std::string_view FORMAT_EMAIL{ "email" };

    inline constexpr std::string_view FORMAT_IDN_EMAIL{ "idn-email" };
 
    //-----------------------------
    // Hostnames (RFC 1123/5890)
    //-----------------------------

    inline constexpr std::string_view FORMAT_HOSTNAME{ "hostname" };

    inline constexpr std::string_view FORMAT_IDN_HOSTNAME{ "idn-hostname" };
 
    //-----------------------------
    // IP Addresses (RFC 2673/4291)
    //-----------------------------

    inline constexpr std::string_view FORMAT_IPV4{ "ipv4" };

    inline constexpr std::string_view FORMAT_IPV6{ "ipv6" };
 
    //-----------------------------
    // Resource Identifiers (RFC 3986/3987/4122)
    //-----------------------------

    inline constexpr std::string_view FORMAT_URI{ "uri" };

    inline constexpr std::string_view FORMAT_URI_REFERENCE{ "uri-reference" };

    inline constexpr std::string_view FORMAT_IRI{ "iri" };

    inline constexpr std::string_view FORMAT_IRI_REFERENCE{ "iri-reference" };

    inline constexpr std::string_view FORMAT_UUID{ "uuid" };
 
    //-----------------------------
    // URI Template (RFC 6570)
    //-----------------------------

    inline constexpr std::string_view FORMAT_URI_TEMPLATE{ "uri-template" };
 
    //-----------------------------
    // JSON Pointers (RFC 6901)
    //-----------------------------

    inline constexpr std::string_view FORMAT_JSON_POINTER{ "json-pointer" };

    inline constexpr std::string_view FORMAT_RELATIVE_JSON_POINTER{ "relative-json-pointer" };
 
    //-----------------------------
    // Regex (ECMA-262)
    //-----------------------------

    inline constexpr std::string_view FORMAT_REGEX{ "regex" };
 
    //----------------------------------------------
    // Validation
    //----------------------------------------------
 
    //-----------------------------
    // General validation
    //-----------------------------

    inline constexpr std::string_view VALIDATION_TYPE{ "type" };

    inline constexpr std::string_view VALIDATION_ENUM{ "enum" };

    inline constexpr std::string_view VALIDATION_CONST{ "const" };
 
    //-----------------------------
    //-----------------------------

    inline constexpr std::string_view VALIDATION_MAX_LENGTH{ "maxLength" };

    inline constexpr std::string_view VALIDATION_MIN_LENGTH{ "minLength" };

    inline constexpr std::string_view VALIDATION_PATTERN{ "pattern" };
 
    //-----------------------------
    //-----------------------------

    inline constexpr std::string_view VALIDATION_MAXIMUM{ "maximum" };

    inline constexpr std::string_view VALIDATION_MINIMUM{ "minimum" };

    inline constexpr std::string_view VALIDATION_EXCLUSIVE_MAXIMUM{ "exclusiveMaximum" };

    inline constexpr std::string_view VALIDATION_EXCLUSIVE_MINIMUM{ "exclusiveMinimum" };

    inline constexpr std::string_view VALIDATION_MULTIPLE_OF{ "multipleOf" };
 
    //-----------------------------
    //-----------------------------

    inline constexpr std::string_view VALIDATION_MAX_PROPERTIES{ "maxProperties" };

    inline constexpr std::string_view VALIDATION_MIN_PROPERTIES{ "minProperties" };

    inline constexpr std::string_view VALIDATION_REQUIRED{ "required" };

    inline constexpr std::string_view VALIDATION_DEPENDENT_REQUIRED{ "dependentRequired" };
 
    //-----------------------------
    //-----------------------------

    inline constexpr std::string_view VALIDATION_MAX_ITEMS{ "maxItems" };

    inline constexpr std::string_view VALIDATION_MIN_ITEMS{ "minItems" };

    inline constexpr std::string_view VALIDATION_MAX_CONTAINS{ "maxContains" };

    inline constexpr std::string_view VALIDATION_MIN_CONTAINS{ "minContains" };

    inline constexpr std::string_view VALIDATION_UNIQUE_ITEMS{ "uniqueItems" };
 
    //----------------------------------------------
    // Meta data
    //----------------------------------------------

    inline constexpr std::string_view METADATA_TITLE{ "title" };

    inline constexpr std::string_view METADATA_DESCRIPTION{ "description" };

    inline constexpr std::string_view METADATA_DEFAULT{ "default" };

    inline constexpr std::string_view METADATA_DEPRECATED{ "deprecated" };

    inline constexpr std::string_view METADATA_EXAMPLES{ "examples" };

    inline constexpr std::string_view METADATA_READ_ONLY{ "readOnly" };

    inline constexpr std::string_view METADATA_WRITE_ONLY{ "writeOnly" };
 
    //----------------------------------------------
    // Format annotation
    //----------------------------------------------

    inline constexpr std::string_view FORMAT_ANNOTATION{ "format" };
 
    //----------------------------------------------
    // Content
    //----------------------------------------------

    inline constexpr std::string_view CONTENT_ENCODING{ "contentEncoding" };

    inline constexpr std::string_view CONTENT_MEDIA_TYPE{ "contentMediaType" };

    inline constexpr std::string_view CONTENT_SCHEMA{ "contentSchema" };
 
    //----------------------------------------------
    // Unevaluated
    //----------------------------------------------

    inline constexpr std::string_view UNEVALUATED_ITEMS{ "unevaluatedItems" };

    inline constexpr std::string_view UNEVALUATED_PROPERTIES{ "unevaluatedProperties" };
 
    //----------------------------------------------
    // Format assertion
    //----------------------------------------------

    inline constexpr std::string_view FORMAT_ASSERTION{ "format" };
} // namespace nfx::serialization::json::vocabulary