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

Files

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Latest commit

5deb73a · Dec 6, 2023

History

History
99 lines (78 loc) · 3.97 KB

File metadata and controls

99 lines (78 loc) · 3.97 KB

MyObjectDto

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

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 MyObjectDto.MyObjectDto1
schema class
static class MyObjectDto.MyObjectDtoMap
output class for Map payloads
static class MyObjectDto.Id
schema class
static class MyObjectDto.AdditionalProperties
schema class

MyObjectDto1

public static class MyObjectDto1
extends JsonSchema

A schema class that validates payloads

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
MyObjectDto.MyObjectDtoMap validatedPayload =
    MyObjectDto.MyObjectDto1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "id",
            "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        )
    ),
    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("id", Id.class))
    ))),
    new KeywordEntry("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties.class))
));

Method Summary

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

MyObjectDtoMap

public static class MyObjectDtoMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static MyObjectDtoMap of(Map<String, String> arg, SchemaConfiguration configuration)
String id()
[optional] value must be a uuid

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
id String [optional] value must be a uuid

Id

public static class Id
extends UuidJsonSchema

A schema class that validates payloads

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

AdditionalProperties

public static class AdditionalProperties
extends NotAnyTypeJsonSchema

A schema class that validates payloads

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

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