SchemaTypes.h

浏览该文件的文档.

#pragma once
 
#include "common/Export.h"
 
#include <cstddef>
#include <map>
#include <memory>
#include <optional>
#include <ostream>
#include <string>
#include <vector>
 
namespace eve::schema {
 
enum class ValueType { Any, Null, Boolean, Integer, Number, String, Object, Array };
 
enum class SchemaRegistrationStatus { Registered, Replaced, Conflict, Invalid };
 
EVENGINE_API_FOUNDATION const char* schemaRegistrationStatusName(SchemaRegistrationStatus status);
 
inline std::ostream& operator<<(std::ostream& stream, SchemaRegistrationStatus status) {
    return stream << schemaRegistrationStatusName(status);
}
 
EVENGINE_API_FOUNDATION std::optional<ValueType> valueTypeFromString(const std::string& name);
 
EVENGINE_API_FOUNDATION const char* valueTypeName(ValueType type);
 
struct SchemaDefinition;
 
struct EVENGINE_API_FOUNDATION_INLINE SchemaNode {
    ValueType type = ValueType::Any;
    ValueType elementType = ValueType::Any;
    std::string ref;
    int refVersion = 0;
    std::shared_ptr<const SchemaDefinition> objectSchema;
    std::shared_ptr<const SchemaNode> itemSchema;
    std::vector<SchemaNode> variants;
    std::string discriminator;
    std::map<std::string, std::string> discriminatorMapping;
    std::vector<std::string> enumValues;
    std::optional<double>    minimum;
    std::optional<double>    maximum;
    std::optional<int>       minLength;
    std::optional<int>       maxLength;
    std::optional<int>       minItems;
    std::optional<int>       maxItems;
};
 
struct EVENGINE_API_FOUNDATION_INLINE FieldDefinition : SchemaNode {
    std::string name;
    bool        required = false;
    std::string title;
    std::string description;
    std::string reference;
    std::string defaultJson;
};
 
struct EVENGINE_API_FOUNDATION_INLINE SchemaDefinition {
    std::string                  id;
    int                          version = 1;
    std::string                  title;
    std::string                  description;
    bool                         additionalProperties = true;
    std::vector<FieldDefinition> fields;
};
 
struct EVENGINE_API_FOUNDATION_INLINE ValidationError {
    std::string path;
    std::string code;
    std::string message;
};
 
}  // namespace eve::schema