Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support enum map keys on OpenAPI 3.1.0 #1905

Merged
merged 1 commit into from
Aug 10, 2023
Merged

Support enum map keys on OpenAPI 3.1.0 #1905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 16 additions & 4 deletions smithy-openapi/src/main/java/software/amazon/smithy/openapi/OpenApiVersion.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,32 @@

package software.amazon.smithy.openapi;

import java.util.Set;
import software.amazon.smithy.jsonschema.JsonSchemaVersion;
import software.amazon.smithy.utils.SetUtils;
import software.amazon.smithy.utils.SmithyInternalApi;

/**
* OpenAPI versions supported by the converter.
*/
public enum OpenApiVersion {

VERSION_3_0_2("3.0.2", false, JsonSchemaVersion.DRAFT07),
VERSION_3_1_0("3.1.0", true, JsonSchemaVersion.DRAFT2020_12);
VERSION_3_0_2("3.0.2", false, JsonSchemaVersion.DRAFT07,
SetUtils.of("propertyNames", "contentMediaType")),
VERSION_3_1_0("3.1.0", true, JsonSchemaVersion.DRAFT2020_12,
SetUtils.of("contentMediaType"));

private final String version;
private final boolean supportsContentEncodingKeyword;
private final JsonSchemaVersion jsonSchemaVersion;
// See https://swagger.io/docs/specification/data-models/keywords/ for 3.0.2.
private final Set<String> unsupportedKeywords;

OpenApiVersion(String version, boolean supportsContentEncodingKeyword, JsonSchemaVersion jsonSchemaVersion) {
OpenApiVersion(String version, boolean supportsContentEncodingKeyword, JsonSchemaVersion jsonSchemaVersion,
Set<String> unsupportedKeywords) {
this.version = version;
this.supportsContentEncodingKeyword = supportsContentEncodingKeyword;
this.jsonSchemaVersion = jsonSchemaVersion;
this.unsupportedKeywords = unsupportedKeywords;
}

@Override
Expand All @@ -46,6 +53,11 @@ public boolean supportsContentEncodingKeyword() {
return supportsContentEncodingKeyword;
}

@SmithyInternalApi
public Set<String> getUnsupportedKeywords() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh interesting to make this version specific. Is this internal because you aren't sure about the design? Maybe unstable instead if that's the concern?

return unsupportedKeywords;
}

JsonSchemaVersion getJsonSchemaVersion() {
return jsonSchemaVersion;
}
Expand Down
12 changes: 4 additions & 8 deletions ...napi/src/main/java/software/amazon/smithy/openapi/fromsmithy/OpenApiJsonSchemaMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
import java.util.Locale;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import software.amazon.smithy.jsonschema.JsonSchemaConfig;
import software.amazon.smithy.jsonschema.JsonSchemaMapper;
import software.amazon.smithy.jsonschema.Schema;
Expand All @@ -35,7 +34,6 @@
import software.amazon.smithy.openapi.OpenApiConfig;
import software.amazon.smithy.openapi.model.ExternalDocumentation;
import software.amazon.smithy.utils.MapUtils;
import software.amazon.smithy.utils.SetUtils;

/**
* Applies OpenAPI extensions to a {@link Schema} using configuration settings
Expand All @@ -46,11 +44,6 @@
*/
public final class OpenApiJsonSchemaMapper implements JsonSchemaMapper {

/** See https://swagger.io/docs/specification/data-models/keywords/. */
private static final Set<String> UNSUPPORTED_KEYWORD_DIRECTIVES = SetUtils.of(
"propertyNames",
"contentMediaType");

@Override
public Schema.Builder updateSchema(Shape shape, Schema.Builder builder, JsonSchemaConfig config) {
getResolvedExternalDocs(shape, config)
Expand Down Expand Up @@ -93,7 +86,10 @@ public Schema.Builder updateSchema(Shape shape, Schema.Builder builder, JsonSche
}

// Remove unsupported JSON Schema keywords.
UNSUPPORTED_KEYWORD_DIRECTIVES.forEach(builder::disableProperty);
if (config instanceof OpenApiConfig) {
OpenApiConfig openApiConfig = (OpenApiConfig) config;
openApiConfig.getVersion().getUnsupportedKeywords().forEach(builder::disableProperty);
}

return builder;
}
Expand Down
1 change: 1 addition & 0 deletions ...openapi/src/test/java/software/amazon/smithy/openapi/fromsmithy/OpenApiConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,7 @@ public void convertsToOpenAPI3_0_2() {

Node.assertEquals(result, expectedNode);
}

@Test
public void convertsToOpenAPI3_1_0() {
Model model = Model.assembler()
Expand Down
18 changes: 0 additions & 18 deletions .../src/test/java/software/amazon/smithy/openapi/fromsmithy/OpenApiJsonSchemaMapperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@
import software.amazon.smithy.model.shapes.ShortShape;
import software.amazon.smithy.model.shapes.StringShape;
import software.amazon.smithy.model.shapes.StructureShape;
import software.amazon.smithy.model.traits.BoxTrait;
import software.amazon.smithy.model.traits.DeprecatedTrait;
import software.amazon.smithy.model.traits.ExternalDocumentationTrait;
import software.amazon.smithy.model.traits.SensitiveTrait;
Expand All @@ -67,23 +66,6 @@ public void convertsModels() {
assertTrue(document.toNode().expectObjectNode().getMember("components").isPresent());
}

@Test
public void stripsUnsupportedKeywords() {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This behavior is now covered by the convertsToOpenAPI3_0_2 and convertsToOpenAPI3_1_0 tests in OpenApiConverterTest.

StringShape string = StringShape.builder().id("smithy.api#String").build();
MemberShape key = MemberShape.builder().id("smithy.example#Map$key").target("smithy.api#String").build();
MemberShape value = MemberShape.builder().id("smithy.example#Map$value").target("smithy.api#String").build();
MapShape shape = MapShape.builder().id("smithy.example#Map").key(key).value(value).build();
Model model = Model.builder().addShapes(string, shape, key, value).build();
SchemaDocument document = JsonSchemaConverter.builder()
.addMapper(new OpenApiJsonSchemaMapper())
.model(model)
.build()
.convertShape(shape);
Schema schema = document.getRootSchema();

assertFalse(schema.getPropertyNames().isPresent());
}

@Test
public void supportsExternalDocs() {
String key = "Homepage";
Expand Down
18 changes: 17 additions & 1 deletion ...rc/test/resources/software/amazon/smithy/openapi/fromsmithy/nullability-and-format.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ blob FilePayload

@output
structure FooBarOutput {
bar: BoxedInteger
bar: BoxedInteger,
baz: MyMap
}

@error("client")
Expand All @@ -36,3 +37,18 @@ structure FooBarError {

@box
integer BoxedInteger

map MyMap {
key: MyEnum,
value: String
}

@enum([
{
value: "FOO"
},
{
value: "BAR"
}
])
string MyEnum
9 changes: 9 additions & 0 deletions ...i/src/test/resources/software/amazon/smithy/openapi/fromsmithy/openapi-3-0-2.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,17 @@
"properties": {
"bar": {
"type": "number"
},
"baz": {
"$ref": "#/components/schemas/MyMap"
}
}
},
"MyMap": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
Expand Down
19 changes: 19 additions & 0 deletions ...i/src/test/resources/software/amazon/smithy/openapi/fromsmithy/openapi-3-1-0.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,27 @@
"properties": {
"bar": {
"type": "number"
},
"baz": {
"$ref": "#/components/schemas/MyMap"
}
}
},
"MyEnum": {
"type": "string",
"enum": [
"FOO",
"BAR"
]
},
"MyMap": {
"type": "object",
"propertyNames": {
"$ref": "#/components/schemas/MyEnum"
},
"additionalProperties": {
"type": "string"
}
}
}
}
Expand Down