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

Latest commit

 

History

History
241 lines (192 loc) · 9.91 KB

Order.md

File metadata and controls

241 lines (192 loc) · 9.91 KB

Order

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

A class that contains necessary nested

  • schema classes (which validate payloads), extends JsonSchema
  • classes to store validated map payloads, extends FrozenMap
  • classes to build inputs for map payloads
  • enum classes

Nested Class Summary

Modifier and Type Class and Description
static class Order.Order1
schema class
static class Order.OrderMapBuilder
builder for Map payloads
static class Order.OrderMap
output class for Map payloads
static class Order.Complete
schema class
static class Order.Status
schema class
enum Order.StringStatusEnums
String enum
static class Order.ShipDate
schema class
static class Order.Quantity
schema class
static class Order.PetId
schema class
static class Order.Id
schema class

Order1

public static class Order1
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.validation.MapUtils;
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
Order.OrderMap validatedPayload =
    Order.Order1.validate(
    new Order.OrderMapBuilder()
        .id(1L)

        .petId(1L)

        .quantity(1)

        .shipDate("1970-01-01T00:00:00.00Z")

        .status("placed")

        .complete(true)

    .build(),
    configuration
);

Field Summary

Modifier and Type Field and Description
Set<Class<?>> type = Set.of(Map.class)
Map<String, Class<? extends JsonSchema>> properties = Map.ofEntries(
    new PropertyEntry("id", Id.class)),
    new PropertyEntry("petId", PetId.class)),
    new PropertyEntry("quantity", Quantity.class)),
    new PropertyEntry("shipDate", ShipDate.class)),
    new PropertyEntry("status", Status.class)),
    new PropertyEntry("complete", Complete.class))
)

Method Summary

Modifier and Type Method and Description
OrderMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

OrderMapBuilder

public class OrderMapBuilder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
OrderMapBuilder()
Creates a builder that contains an empty map

Method Summary

Modifier and Type Method and Description
Map<String, @Nullable Object> build()
Returns map input that should be used with Schema.validate
OrderMapBuilder id(int value)
OrderMapBuilder id(float value)
OrderMapBuilder id(long value)
OrderMapBuilder id(double value)
OrderMapBuilder petId(int value)
OrderMapBuilder petId(float value)
OrderMapBuilder petId(long value)
OrderMapBuilder petId(double value)
OrderMapBuilder quantity(int value)
OrderMapBuilder quantity(float value)
OrderMapBuilder shipDate(String value)
OrderMapBuilder status(String value)
OrderMapBuilder status(StringStatusEnums value)
OrderMapBuilder complete(boolean value)
OrderMapBuilder additionalProperty(String key, Void value)
OrderMapBuilder additionalProperty(String key, boolean value)
OrderMapBuilder additionalProperty(String key, String value)
OrderMapBuilder additionalProperty(String key, int value)
OrderMapBuilder additionalProperty(String key, float value)
OrderMapBuilder additionalProperty(String key, long value)
OrderMapBuilder additionalProperty(String key, double value)
OrderMapBuilder additionalProperty(String key, List<?> value)
OrderMapBuilder additionalProperty(String key, Map<String, ?> value)

OrderMap

public static class OrderMap
extends FrozenMap<String, @Nullable Object>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static OrderMap of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
Number id()
[optional] value must be a 64 bit integer
Number petId()
[optional] value must be a 64 bit integer
Number quantity()
[optional] value must be a 32 bit integer
String shipDate()
[optional] value must conform to RFC-3339 date-time
String status()
[optional] must be one of ["placed", "approved", "delivered"]
boolean complete()
[optional] if omitted the server will use the default value of false
@Nullable Object getAdditionalProperty(String name)
provides type safety for additional properties

Complete

public static class Complete
extends BooleanJsonSchema

A schema class that validates payloads

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

Status

public static class Status
extends JsonSchema

A schema class that validates payloads

Description

Order Status

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.validation.MapUtils;
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());

// String validation
String validatedPayload = Order.Status.validate(
    "placed",
    configuration
);

Field Summary

Modifier and Type Field and Description
Set<Class<?>> type = Set.of(
    String.class
)
Set enumValues = SetMaker.makeSet(
    "placed",
    "approved",
    "delivered"
)

Method Summary

Modifier and Type Method and Description
String validate(String arg, SchemaConfiguration configuration)
String validate(StringStatusEnums arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

StringStatusEnums

public enum StringStatusEnums
extends Enum<StringStatusEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant Description
PLACED value = "placed"
APPROVED value = "approved"
DELIVERED value = "delivered"

ShipDate

public static class ShipDate
extends DateTimeJsonSchema

A schema class that validates payloads

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

Quantity

public static class Quantity
extends Int32JsonSchema

A schema class that validates payloads

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

PetId

public static class PetId
extends Int64JsonSchema

A schema class that validates payloads

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

Id

public static class Id
extends Int64JsonSchema

A schema class that validates payloads

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

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