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

Java adds propertyNames #362

Merged
merged 6 commits into from
Jan 16, 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
4 changes: 2 additions & 2 deletions docs/generators/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|Integer|✓|OAS2,OAS3
|Float|✓|OAS2,OAS3
|Double|✓|OAS2,OAS3
|Number||OAS2,OAS3
|Number||OAS2,OAS3
|String|✓|OAS2,OAS3
|Byte|✗|OAS2,OAS3
|Binary|✗|OAS2,OAS3
Expand Down Expand Up @@ -307,7 +307,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|PatternProperties|✗|OAS3
|PrefixItems|✗|OAS3
|Properties|✓|OAS2,OAS3
|PropertyNames||OAS3
|PropertyNames||OAS3
|Ref|✓|OAS2,OAS3
|Required|✓|OAS2,OAS3
|Then|✗|OAS3
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,7 @@ src/main/java/org/openapijsonschematools/client/schemas/validation/PathToSchemas
src/main/java/org/openapijsonschematools/client/schemas/validation/PatternValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/PropertiesValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/PropertyEntry.java
src/main/java/org/openapijsonschematools/client/schemas/validation/PropertyNamesValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/RequiredValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/StringEnumValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/StringSchemaValidator.java
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ public abstract class JsonSchema {
public final @Nullable Class<? extends JsonSchema> contains;
public final @Nullable Integer maxContains;
public final @Nullable Integer minContains;
public final @Nullable Class<? extends JsonSchema> propertyNames;
private final LinkedHashMap<String, KeywordValidator> keywordToValidator;

protected JsonSchema(JsonSchemaInfo jsonSchemaInfo) {
Expand Down Expand Up @@ -252,6 +253,13 @@ protected JsonSchema(JsonSchemaInfo jsonSchemaInfo) {
new MinContainsValidator(this.minContains)
);
}
this.propertyNames = jsonSchemaInfo.propertyNames;
if (this.propertyNames != null) {
keywordToValidator.put(
"propertyNames",
new PropertyNamesValidator(this.propertyNames)
);
}
this.keywordToValidator = keywordToValidator;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,4 +157,9 @@ public JsonSchemaInfo minContains(Integer minContains) {
this.minContains = minContains;
return this;
}
public @Nullable Class<? extends JsonSchema> propertyNames = null;
public JsonSchemaInfo propertyNames(Class<? extends JsonSchema> propertyNames) {
this.propertyNames = propertyNames;
return this;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
package org.openapijsonschematools.client.schemas.validation;

import org.checkerframework.checker.nullness.qual.Nullable;

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

public class PropertyNamesValidator implements KeywordValidator {
public final Class<? extends JsonSchema> propertyNames;

public PropertyNamesValidator(Class<? extends JsonSchema> propertyNames) {
this.propertyNames = propertyNames;
}

@Override
public @Nullable PathToSchemasMap validate(
JsonSchema schema,
@Nullable Object arg,
ValidationMetadata validationMetadata,
@Nullable List<PathToSchemasMap> containsPathToSchemas
) {
if (!(arg instanceof Map)) {
return null;
}
JsonSchema propertyNamesSchema = JsonSchemaFactory.getInstance(propertyNames);
for (Object objKey: ((Map<?, ?>) arg).keySet()) {
if (objKey instanceof String key) {
List<Object> propPathToItem = new ArrayList<>(validationMetadata.pathToItem());
propPathToItem.add(key);
ValidationMetadata keyValidationMetadata = new ValidationMetadata(
propPathToItem,
validationMetadata.configuration(),
validationMetadata.validatedPathToSchemas(),
validationMetadata.seenClasses()
);
JsonSchema.validate(propertyNamesSchema, key, keyValidationMetadata);
}
}
return null;
}
}
3 changes: 3 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 @@ -88,6 +88,7 @@ docs/components/schemas/PropertiesWhoseNamesAreJavascriptObjectPropertyNames.md
docs/components/schemas/PropertiesWithEscapedCharacters.md
docs/components/schemas/PropertiesWithNullValuedInstanceProperties.md
docs/components/schemas/PropertyNamedRefThatIsNotAReference.md
docs/components/schemas/PropertynamesValidation.md
docs/components/schemas/RegexFormat.md
docs/components/schemas/RelativeJsonPointerFormat.md
docs/components/schemas/RequiredDefaultValidation.md
Expand Down Expand Up @@ -202,6 +203,7 @@ src/main/java/org/openapijsonschematools/client/components/schemas/PropertiesWho
src/main/java/org/openapijsonschematools/client/components/schemas/PropertiesWithEscapedCharacters.java
src/main/java/org/openapijsonschematools/client/components/schemas/PropertiesWithNullValuedInstanceProperties.java
src/main/java/org/openapijsonschematools/client/components/schemas/PropertyNamedRefThatIsNotAReference.java
src/main/java/org/openapijsonschematools/client/components/schemas/PropertynamesValidation.java
src/main/java/org/openapijsonschematools/client/components/schemas/RegexFormat.java
src/main/java/org/openapijsonschematools/client/components/schemas/RelativeJsonPointerFormat.java
src/main/java/org/openapijsonschematools/client/components/schemas/RequiredDefaultValidation.java
Expand Down Expand Up @@ -308,6 +310,7 @@ src/main/java/org/openapijsonschematools/client/schemas/validation/PathToSchemas
src/main/java/org/openapijsonschematools/client/schemas/validation/PatternValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/PropertiesValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/PropertyEntry.java
src/main/java/org/openapijsonschematools/client/schemas/validation/PropertyNamesValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/RequiredValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/StringEnumValidator.java
src/main/java/org/openapijsonschematools/client/schemas/validation/StringSchemaValidator.java
Expand Down
1 change: 1 addition & 0 deletions samples/client/3_1_0_unit_test/java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,7 @@ allowed input and output types.
| [PropertiesWithEscapedCharacters.PropertiesWithEscapedCharacters1](docs/components/schemas/PropertiesWithEscapedCharacters.md#propertieswithescapedcharacters1) | |
| [PropertiesWithNullValuedInstanceProperties.PropertiesWithNullValuedInstanceProperties1](docs/components/schemas/PropertiesWithNullValuedInstanceProperties.md#propertieswithnullvaluedinstanceproperties1) | |
| [PropertyNamedRefThatIsNotAReference.PropertyNamedRefThatIsNotAReference1](docs/components/schemas/PropertyNamedRefThatIsNotAReference.md#propertynamedrefthatisnotareference1) | |
| [PropertynamesValidation.PropertynamesValidation1](docs/components/schemas/PropertynamesValidation.md#propertynamesvalidation1) | |
| [RegexFormat.RegexFormat1](docs/components/schemas/RegexFormat.md#regexformat1) | |
| [RelativeJsonPointerFormat.RelativeJsonPointerFormat1](docs/components/schemas/RelativeJsonPointerFormat.md#relativejsonpointerformat1) | |
| [RequiredDefaultValidation.RequiredDefaultValidation1](docs/components/schemas/RequiredDefaultValidation.md#requireddefaultvalidation1) | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# PropertynamesValidation
org.openapijsonschematools.client.components.schemas.PropertynamesValidation.java
public class PropertynamesValidation

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

## Nested Class Summary
| Modifier and Type | Class and Description |
| ----------------- | ---------------------- |
| static class | [PropertynamesValidation.PropertynamesValidation1](#propertynamesvalidation1)<br> schema class |
| static class | [PropertynamesValidation.PropertyNames](#propertynames)<br> schema class |

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

A schema class that validates payloads

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

### 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) |
## 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 = PropertynamesValidation.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 = 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)
Loading