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

Java, adds unevaluatedProperties #374

Merged
merged 2 commits into from
Jan 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/generators/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|Then|✓|OAS3
|Type|✓|OAS2,OAS3
|UnevaluatedItems|✓|OAS3
|UnevaluatedProperties||OAS3
|UnevaluatedProperties||OAS3
|UniqueItems|✓|OAS2,OAS3
|Xml|✗|OAS2,OAS3

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,7 @@ src/main/java/org/openapijsonschematools/client/schemas/validation/StringValueMe
src/main/java/org/openapijsonschematools/client/schemas/validation/ThenValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/TypeValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/UnevaluatedItemsValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/UnevaluatedPropertiesValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/UniqueItemsValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/UnsetAnyTypeJsonSchema.java
src/main/java/org/openapijsonschematools/client/schemas/validation/ValidationData.java
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ public abstract class JsonSchema {
public final @Nullable Class<? extends JsonSchema> then;
public final @Nullable Class<? extends JsonSchema> elseSchema;
public final @Nullable Class<? extends JsonSchema> unevaluatedItems;
public final @Nullable Class<? extends JsonSchema> unevaluatedProperties;
private final LinkedHashMap<String, KeywordValidator> keywordToValidator;

protected JsonSchema(JsonSchemaInfo jsonSchemaInfo) {
Expand Down Expand Up @@ -213,6 +214,10 @@ protected JsonSchema(JsonSchemaInfo jsonSchemaInfo) {
if (this.unevaluatedItems != null) {
keywordToValidator.put("unevaluatedItems", new UnevaluatedItemsValidator());
}
this.unevaluatedProperties = jsonSchemaInfo.unevaluatedProperties;
if (this.unevaluatedProperties != null) {
keywordToValidator.put("unevaluatedProperties", new UnevaluatedPropertiesValidator());
}
this.keywordToValidator = keywordToValidator;
}

Expand Down Expand Up @@ -333,7 +338,7 @@ public static PathToSchemasMap validate(
continue;
}
}
if ("unevaluatedItems".equals(jsonKeyword)) {
if ("unevaluatedItems".equals(jsonKeyword) || "unevaluatedProperties".equals(jsonKeyword)) {
knownPathToSchemas = pathToSchemas;
}
KeywordValidator validator = entry.getValue();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -202,4 +202,9 @@ public JsonSchemaInfo unevaluatedItems(Class<? extends JsonSchema> unevaluatedIt
this.unevaluatedItems = unevaluatedItems;
return this;
}
public @Nullable Class<? extends JsonSchema> unevaluatedProperties = null;
public JsonSchemaInfo unevaluatedProperties(Class<? extends JsonSchema> unevaluatedProperties) {
this.unevaluatedProperties = unevaluatedProperties;
return this;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
package org.openapijsonschematools.client.schemas.validation;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.openapijsonschematools.client.exceptions.InvalidTypeException;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

public class UnevaluatedPropertiesValidator implements KeywordValidator {
@Override
public @Nullable PathToSchemasMap validate(
ValidationData data
) {
var unevaluatedProperties = data.schema().unevaluatedProperties;
if (unevaluatedProperties == null) {
return null;
}
var knownPathToSchemas = data.knownPathToSchemas();
if (knownPathToSchemas == null) {
return null;
}
if (!(data.arg() instanceof Map<?, ?> mapArg)) {
return null;
}
PathToSchemasMap pathToSchemas = new PathToSchemasMap();
JsonSchema unevaluatedPropertiesSchema = JsonSchemaFactory.getInstance(unevaluatedProperties);
for(Map.Entry<?, ?> entry: mapArg.entrySet()) {
if (!(entry.getKey() instanceof String propName)) {
throw new InvalidTypeException("Map keys must be strings");
}
List<Object> propPathToItem = new ArrayList<>(data.validationMetadata().pathToItem());
propPathToItem.add(propName);
if (knownPathToSchemas.containsKey(propPathToItem)) {
continue;
}
@Nullable Object propValue = mapArg.get(propName);
ValidationMetadata propValidationMetadata = new ValidationMetadata(
propPathToItem,
data.validationMetadata().configuration(),
data.validationMetadata().validatedPathToSchemas(),
data.validationMetadata().seenClasses()
);
PathToSchemasMap otherPathToSchemas = JsonSchema.validate(unevaluatedPropertiesSchema, propValue, propValidationMetadata);
pathToSchemas.update(otherPathToSchemas);
}
return pathToSchemas;
}
}
5 changes: 5 additions & 0 deletions samples/client/3_1_0_unit_test/java/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ docs/components/schemas/UnevaluateditemsAsSchema.md
docs/components/schemas/UnevaluateditemsDependsOnMultipleNestedContains.md
docs/components/schemas/UnevaluateditemsWithItems.md
docs/components/schemas/UnevaluateditemsWithNullInstanceElements.md
docs/components/schemas/UnevaluatedpropertiesNotAffectedByPropertynames.md
docs/components/schemas/UnevaluatedpropertiesSchema.md
docs/components/schemas/UnevaluatedpropertiesWithAdjacentAdditionalproperties.md
docs/components/schemas/UnevaluatedpropertiesWithNullValuedInstanceProperties.md
docs/components/schemas/UniqueitemsFalseValidation.md
Expand Down Expand Up @@ -272,6 +274,8 @@ src/main/java/org/openapijsonschematools/client/components/schemas/Unevaluatedit
src/main/java/org/openapijsonschematools/client/components/schemas/UnevaluateditemsDependsOnMultipleNestedContains.java
src/main/java/org/openapijsonschematools/client/components/schemas/UnevaluateditemsWithItems.java
src/main/java/org/openapijsonschematools/client/components/schemas/UnevaluateditemsWithNullInstanceElements.java
src/main/java/org/openapijsonschematools/client/components/schemas/UnevaluatedpropertiesNotAffectedByPropertynames.java
src/main/java/org/openapijsonschematools/client/components/schemas/UnevaluatedpropertiesSchema.java
src/main/java/org/openapijsonschematools/client/components/schemas/UnevaluatedpropertiesWithAdjacentAdditionalproperties.java
src/main/java/org/openapijsonschematools/client/components/schemas/UnevaluatedpropertiesWithNullValuedInstanceProperties.java
src/main/java/org/openapijsonschematools/client/components/schemas/UniqueitemsFalseValidation.java
Expand Down Expand Up @@ -380,6 +384,7 @@ src/main/java/org/openapijsonschematools/client/schemas/validation/StringValueMe
src/main/java/org/openapijsonschematools/client/schemas/validation/ThenValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/TypeValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/UnevaluatedItemsValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/UnevaluatedPropertiesValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/UniqueItemsValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/UnsetAnyTypeJsonSchema.java
src/main/java/org/openapijsonschematools/client/schemas/validation/ValidationData.java
Expand Down
2 changes: 2 additions & 0 deletions samples/client/3_1_0_unit_test/java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,8 @@ allowed input and output types.
| [UnevaluateditemsDependsOnMultipleNestedContains.UnevaluateditemsDependsOnMultipleNestedContains1](docs/components/schemas/UnevaluateditemsDependsOnMultipleNestedContains.md#unevaluateditemsdependsonmultiplenestedcontains1) | |
| [UnevaluateditemsWithItems.UnevaluateditemsWithItems1](docs/components/schemas/UnevaluateditemsWithItems.md#unevaluateditemswithitems1) | |
| [UnevaluateditemsWithNullInstanceElements.UnevaluateditemsWithNullInstanceElements1](docs/components/schemas/UnevaluateditemsWithNullInstanceElements.md#unevaluateditemswithnullinstanceelements1) | |
| [UnevaluatedpropertiesNotAffectedByPropertynames.UnevaluatedpropertiesNotAffectedByPropertynames1](docs/components/schemas/UnevaluatedpropertiesNotAffectedByPropertynames.md#unevaluatedpropertiesnotaffectedbypropertynames1) | |
| [UnevaluatedpropertiesSchema.UnevaluatedpropertiesSchema1](docs/components/schemas/UnevaluatedpropertiesSchema.md#unevaluatedpropertiesschema1) | |
| [UnevaluatedpropertiesWithAdjacentAdditionalproperties.UnevaluatedpropertiesWithAdjacentAdditionalproperties1](docs/components/schemas/UnevaluatedpropertiesWithAdjacentAdditionalproperties.md#unevaluatedpropertieswithadjacentadditionalproperties1) | |
| [UnevaluatedpropertiesWithNullValuedInstanceProperties.UnevaluatedpropertiesWithNullValuedInstanceProperties1](docs/components/schemas/UnevaluatedpropertiesWithNullValuedInstanceProperties.md#unevaluatedpropertieswithnullvaluedinstanceproperties1) | |
| [UniqueitemsFalseValidation.UniqueitemsFalseValidation1](docs/components/schemas/UniqueitemsFalseValidation.md#uniqueitemsfalsevalidation1) | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# UnevaluatedpropertiesNotAffectedByPropertynames
org.openapijsonschematools.client.components.schemas.UnevaluatedpropertiesNotAffectedByPropertynames.java
public class UnevaluatedpropertiesNotAffectedByPropertynames

A class that contains necessary nested
- schema classes (which validate payloads), extends JsonSchema

## Nested Class Summary
| Modifier and Type | Class and Description |
| ----------------- | ---------------------- |
| static class | [UnevaluatedpropertiesNotAffectedByPropertynames.UnevaluatedpropertiesNotAffectedByPropertynames1](#unevaluatedpropertiesnotaffectedbypropertynames1)<br> schema class |
| static class | [UnevaluatedpropertiesNotAffectedByPropertynames.UnevaluatedProperties](#unevaluatedproperties)<br> schema class |
| static class | [UnevaluatedpropertiesNotAffectedByPropertynames.PropertyNames](#propertynames)<br> schema class |

## UnevaluatedpropertiesNotAffectedByPropertynames1
public static class UnevaluatedpropertiesNotAffectedByPropertynames1<br>
extends JsonSchema

A schema class that validates payloads

### Field Summary
| Modifier and Type | Field and Description |
| ----------------- | ---------------------- |
| Class<? extends JsonSchema> | propertyNames = [PropertyNames.class](#propertynames) |
| Class<? extends JsonSchema> | unevaluatedProperties = [UnevaluatedProperties.class](#unevaluatedproperties) |

### Method Summary
| Modifier and Type | Method and Description |
| ----------------- | ---------------------- |
| String | validate(String arg, SchemaConfiguration configuration) |
| Void | validate(Void arg, SchemaConfiguration configuration) |
| int | validate(int arg, SchemaConfiguration configuration) |
| long | validate(long arg, SchemaConfiguration configuration) |
| float | validate(float arg, SchemaConfiguration configuration) |
| double | validate(double arg, SchemaConfiguration configuration) |
| boolean | validate(boolean arg, SchemaConfiguration configuration) |
| FrozenMap<String, @Nullable Object> | validate(Map&lt;?, ?&gt; arg, SchemaConfiguration configuration) |
| FrozenList<@Nullable Object> | validate(List<?> arg, SchemaConfiguration configuration) |
| @Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
## UnevaluatedProperties
public static class UnevaluatedProperties<br>
extends NumberJsonSchema

A schema class that validates payloads

| Methods Inherited from class org.openapijsonschematools.client.schemas.NumberJsonSchema |
| ------------------------------------------------------------------ |
| validate |

## PropertyNames
public static class PropertyNames<br>
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());

// String validation
String validatedPayload = UnevaluatedpropertiesNotAffectedByPropertynames.PropertyNames.validate(
"a",
configuration
);
```

### Field Summary
| Modifier and Type | Field and Description |
| ----------------- | ---------------------- |
| Set<Class<?>> | type = Set.of(<br/>&nbsp;&nbsp;&nbsp;&nbsp;String.class<br/>)<br/> |
| Integer | maxLength = 1 |

### Method Summary
| Modifier and Type | Method and Description |
| ----------------- | ---------------------- |
| String | validate(String arg, SchemaConfiguration configuration) |
| @Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
[[Back to top]](#top) [[Back to Component Schemas]](../../../README.md#Component-Schemas) [[Back to README]](../../../README.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# UnevaluatedpropertiesSchema
org.openapijsonschematools.client.components.schemas.UnevaluatedpropertiesSchema.java
public class UnevaluatedpropertiesSchema

A class that contains necessary nested
- schema classes (which validate payloads), extends JsonSchema

## Nested Class Summary
| Modifier and Type | Class and Description |
| ----------------- | ---------------------- |
| static class | [UnevaluatedpropertiesSchema.UnevaluatedpropertiesSchema1](#unevaluatedpropertiesschema1)<br> schema class |
| static class | [UnevaluatedpropertiesSchema.UnevaluatedProperties](#unevaluatedproperties)<br> schema class |

## UnevaluatedpropertiesSchema1
public static class UnevaluatedpropertiesSchema1<br>
extends JsonSchema

A schema class that validates payloads

### Field Summary
| Modifier and Type | Field and Description |
| ----------------- | ---------------------- |
| Set<Class<?>> | type = Set.of(Map.class) |
| Class<? extends JsonSchema> | unevaluatedProperties = [UnevaluatedProperties.class](#unevaluatedproperties) |

### Method Summary
| Modifier and Type | Method and Description |
| ----------------- | ---------------------- |
| FrozenMap<String, @Nullable Object> | validate(Map&lt;?, ?&gt; arg, SchemaConfiguration configuration) |
| @Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
## UnevaluatedProperties
public static class UnevaluatedProperties<br>
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());

// String validation
String validatedPayload = UnevaluatedpropertiesSchema.UnevaluatedProperties.validate(
"a",
configuration
);
```

### Field Summary
| Modifier and Type | Field and Description |
| ----------------- | ---------------------- |
| Set<Class<?>> | type = Set.of(<br/>&nbsp;&nbsp;&nbsp;&nbsp;String.class<br/>)<br/> |
| Integer | minLength = 3 |

### Method Summary
| Modifier and Type | Method and Description |
| ----------------- | ---------------------- |
| String | validate(String arg, SchemaConfiguration configuration) |
| @Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
[[Back to top]](#top) [[Back to Component Schemas]](../../../README.md#Component-Schemas) [[Back to README]](../../../README.md)
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ UnevaluatedpropertiesWithAdjacentAdditionalproperties.UnevaluatedpropertiesWithA
| Set<Class<?>> | type = Set.of(Map.class) |
| Map<String, Class<? extends JsonSchema>> | properties = Map.ofEntries(<br>&nbsp;&nbsp;&nbsp;&nbsp;new PropertyEntry("foo", [Foo.class](#foo)))<br>)<br> |
| Class<? extends JsonSchema> | additionalProperties = [AdditionalProperties.class](#additionalproperties) |
| Class<? extends JsonSchema> | unevaluatedProperties = [UnevaluatedProperties.class](#unevaluatedproperties) |

### Method Summary
| Modifier and Type | Method and Description |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ A schema class that validates payloads
### Field Summary
| Modifier and Type | Field and Description |
| ----------------- | ---------------------- |
| Class<? extends JsonSchema> | unevaluatedProperties = [UnevaluatedProperties.class](#unevaluatedproperties) |

### Method Summary
| Modifier and Type | Method and Description |
Expand Down
Loading