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

Add "double" format to epoch-seconds timestamps #802

Merged
merged 1 commit into from
May 17, 2021
Merged

Add "double" format to epoch-seconds timestamps #802

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
3 changes: 2 additions & 1 deletion .../src/test/resources/software/amazon/smithy/aws/apigateway/openapi/cors-model.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,8 @@
"type": "object",
"properties": {
"createdAt": {
"type": "number"
"type": "number",
"format": "double"
},
"id": {
"type": "string"
Expand Down
3 changes: 2 additions & 1 deletion ...s/software/amazon/smithy/aws/apigateway/openapi/cors-with-additional-headers.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,8 @@
"type": "object",
"properties": {
"createdAt": {
"type": "number"
"type": "number",
"format": "double"
},
"id": {
"type": "string"
Expand Down
3 changes: 2 additions & 1 deletion ...ources/software/amazon/smithy/aws/apigateway/openapi/http-api-cors-wildcards.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,8 @@
"type": "object",
"properties": {
"createdAt": {
"type": "number"
"type": "number",
"format": "double"
},
"id": {
"type": "string"
Expand Down
3 changes: 2 additions & 1 deletion ...c/test/resources/software/amazon/smithy/aws/apigateway/openapi/http-api-cors.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,8 @@
"type": "object",
"properties": {
"createdAt": {
"type": "number"
"type": "number",
"format": "double"
},
"id": {
"type": "string"
Expand Down
18 changes: 18 additions & 0 deletions smithy-jsonschema/src/main/java/software/amazon/smithy/jsonschema/JsonSchemaConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,13 @@

import java.util.HashSet;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import software.amazon.smithy.model.node.Node;
import software.amazon.smithy.model.node.NodeMapper;
import software.amazon.smithy.model.node.ObjectNode;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.traits.TimestampFormatTrait;

Expand Down Expand Up @@ -329,4 +331,20 @@ public ShapeId getService() {
public void setService(ShapeId service) {
this.service = service;
}

/**
* Detects the TimestampFormat of the given shape, falling back to the
* configured default format specified in {@link #setDefaultTimestampFormat(TimestampFormatTrait.Format)}.
*
* @param shape Shape to extract the timestamp format from.
* @return Returns the optionally detected format.
*/
public Optional<String> detectJsonTimestampFormat(Shape shape) {
if (shape.isTimestampShape() || shape.hasTrait(TimestampFormatTrait.class)) {
return Optional.of(shape.getTrait(TimestampFormatTrait.class)
.map(TimestampFormatTrait::getValue)
.orElseGet(() -> getDefaultTimestampFormat().toString()));
}
return Optional.empty();
}
}
12 changes: 1 addition & 11 deletions smithy-jsonschema/src/main/java/software/amazon/smithy/jsonschema/TimestampMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public byte getOrder() {

@Override
public Schema.Builder updateSchema(Shape shape, Schema.Builder builder, JsonSchemaConfig config) {
String format = extractTimestampFormat(shape, config);
String format = config.detectJsonTimestampFormat(shape).orElse(null);

if (format == null) {
return builder;
Expand All @@ -49,14 +49,4 @@ public Schema.Builder updateSchema(Shape shape, Schema.Builder builder, JsonSche
return format.startsWith("epoch-") ? builder.type("number") : builder.type("string");
}
}

private static String extractTimestampFormat(Shape shape, JsonSchemaConfig config) {
if (shape.isTimestampShape() || shape.hasTrait(TimestampFormatTrait.class)) {
return shape.getTrait(TimestampFormatTrait.class)
.map(TimestampFormatTrait::getValue)
.orElseGet(() -> config.getDefaultTimestampFormat().toString());
}

return null;
}
}
7 changes: 7 additions & 0 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 @@ -32,6 +32,7 @@
import software.amazon.smithy.model.traits.DeprecatedTrait;
import software.amazon.smithy.model.traits.ExternalDocumentationTrait;
import software.amazon.smithy.model.traits.SensitiveTrait;
import software.amazon.smithy.model.traits.TimestampFormatTrait;
import software.amazon.smithy.openapi.OpenApiConfig;
import software.amazon.smithy.openapi.model.ExternalDocumentation;
import software.amazon.smithy.utils.MapUtils;
Expand Down Expand Up @@ -88,6 +89,12 @@ public Schema.Builder updateSchema(Shape shape, Schema.Builder builder, JsonSche
String blobFormat = ((OpenApiConfig) config).getDefaultBlobFormat();
return builder.format(blobFormat);
}
} else if (shape.isTimestampShape()) {
// Add the "double" format when epoch-seconds is used
// to account for optional millisecond precision.
config.detectJsonTimestampFormat(shape)
.filter(format -> format.equals(TimestampFormatTrait.EPOCH_SECONDS))
.ifPresent(format -> builder.format("double"));
} else if (shape.hasTrait(SensitiveTrait.class)) {
builder.format("password");
}
Expand Down
3 changes: 2 additions & 1 deletion ...est/resources/software/amazon/smithy/openapi/fromsmithy/test-service-integer.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,8 @@
"type": "string"
},
"time": {
"type": "number"
"type": "number",
"format": "double"
},
"list": {
"type": "array",
Expand Down
3 changes: 2 additions & 1 deletion ...pi/src/test/resources/software/amazon/smithy/openapi/fromsmithy/test-service.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,8 @@
"type": "string"
},
"time": {
"type": "number"
"type": "number",
"format": "double"
},
"list": {
"type": "array",
Expand Down