Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Latest commit

 

History

History
96 lines (76 loc) · 3.52 KB

File metadata and controls

96 lines (76 loc) · 3.52 KB

File

org.openapijsonschematools.client.components.schemas.File.java public class File

A class that contains necessary nested schema classes, and classes to store validated list and map payloads

Nested Class Summary

Modifier and Type Class and Description
static class File.File1
schema class
static class File.FileMap
output class for Map payloads
static class File.SourceURI
schema class

File1

public static class File1
extends JsonSchema

A schema class that validates payloads

Description

Must be named `File` for test.

Code Sample

import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.schemas.MapMaker;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// Map validation
File.FileMap validatedPayload =
    File.File1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "sourceURI",
            "a"
        )
    ),
    configuration
);

Field Summary

Modifier and Type Field and Description
static LinkedHashMap<String, KeywordValidator> keywordToValidator
new LinkedHashMap<>(Map.ofEntries(
    new KeywordEntry("type", new TypeValidator(Set.of(FrozenMap.class))),
    new KeywordEntry("properties", new PropertiesValidator(Map.ofEntries(
        new PropertyEntry("sourceURI", SourceURI.class))
    )))
));

Method Summary

Modifier and Type Method and Description
static FileMap validate(Map<String, Object> arg, SchemaConfiguration configuration)

FileMap

public static class FileMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static FileMap of(Map<String, Object> arg, SchemaConfiguration configuration)
String sourceURI()
[optional]
Object getAdditionalProperty(String name)
provides type safety for additional properties

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
sourceURI String Test capitalization [optional]
anyStringName Object any string name can be used but the value must be the correct type [optional]

SourceURI

public static class SourceURI
extends StringJsonSchema

A schema class that validates payloads

Description

Test capitalization

Methods Inherited from class org.openapijsonschematools.client.schemas.StringJsonSchema
validate

[Back to top] [Back to Component Schemas] [Back to README]