example pokeapi with new protocol #17489
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Regexes are purely illustrative and need to be workshopped: BC dates shouldn't require 4-digit years; years may have >=5 digits; etc | ||
| definitions: | ||
| String: | ||
| type: string | ||
| description: Arbitrary text | ||
| BinaryData: | ||
| type: string | ||
| description: > | ||
| Arbitrary binary data. Represented as base64-encoded strings in the JSON transport. | ||
| In the future, if we support other transports, may be encoded differently. | ||
| # All credit to https://stackoverflow.com/a/475217 for this pattern | ||
| pattern: (?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)? | ||
| Date: | ||
| type: string | ||
| # format: date is a superset of what we want, so we cannot use it here (e.g. it accepts 2-digit years) | ||
| pattern: \d{4}-\d{2}-\d{2}( BC)? | ||
| TimestampWithTimezone: | ||
| type: string | ||
| # format: date-time is a superset of what we want, so we cannot use it here (e.g. it accepts 2-digit years) | ||
| pattern: \d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{1,2}(:\d{2})?)( BC)? | ||
| description: An instant in time. Frequently simply referred to as just a timestamp, or timestamptz. | ||
| TimestampWithoutTimezone: | ||
| type: string | ||
| pattern: \d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}(\.\d+)?( BC)? | ||
| description: Also known as a localdatetime, or just datetime. | ||
| TimeWithTimezone: | ||
| type: string | ||
| pattern: \d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{1,2}(:\d{2})?) | ||
| TimeWithoutTimezone: | ||
| type: string | ||
| pattern: \d{2}:\d{2}:\d{2}(\.\d+)? | ||
| Number: | ||
| type: string | ||
| # Note the mix of regex validation for normal numbers, and enum validation for special values | ||
| oneOf: | ||
| - pattern: -?(0|[0-9]\d*)(\.\d+)? | ||
| - enum: | ||
| - Infinity | ||
| - -Infinity | ||
| - NaN | ||
| Integer: | ||
| type: string | ||
| oneOf: | ||
| - pattern: -?(0|[0-9]\d*) | ||
| - enum: | ||
| - Infinity | ||
| - -Infinity | ||
| - NaN | ||
| Boolean: | ||
| # Note the direct usage of a primitive boolean rather than string. Unlike Numbers and Integers, we don't expect unusual values here. | ||
| type: boolean |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| { | ||
|
There was a problem hiding this comment. This file is just the JSON-ified version of WellKnownTypes.yaml. In the real usage, this file will be provided as part of the CDK - I'm copying it in manually because I don't want to set up the full yaml -> json -> copy pipeline just for this example. |
||
| "definitions": { | ||
| "String": { | ||
| "type": "string", | ||
| "description": "Arbitrary text" | ||
| }, | ||
| "BinaryData": { | ||
| "type": "string", | ||
| "description": "Arbitrary binary data. Represented as base64-encoded strings in the JSON transport. In the future, if we support other transports, may be encoded differently.\n", | ||
| "pattern": "(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?" | ||
| }, | ||
| "Date": { | ||
| "type": "string", | ||
| "pattern": "\\d{4}-\\d{2}-\\d{2}( BC)?" | ||
| }, | ||
| "TimestampWithTimezone": { | ||
| "type": "string", | ||
| "pattern": "\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{1,2}(:\\d{2})?)( BC)?", | ||
| "description": "An instant in time. Frequently simply referred to as just a timestamp, or timestamptz." | ||
| }, | ||
| "TimestampWithoutTimezone": { | ||
| "type": "string", | ||
| "pattern": "\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?( BC)?", | ||
| "description": "Also known as a localdatetime, or just datetime." | ||
| }, | ||
| "TimeWithTimezone": { | ||
| "type": "string", | ||
| "pattern": "\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{1,2}(:\\d{2})?)" | ||
| }, | ||
| "TimeWithoutTimezone": { | ||
| "type": "string", | ||
| "pattern": "\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?" | ||
| }, | ||
| "Number": { | ||
| "type": "string", | ||
| "oneOf": [ | ||
| { | ||
| "pattern": "-?(0|[0-9]\\d*)(\\.\\d+)?" | ||
| }, | ||
| { | ||
| "enum": ["Infinity", "-Infinity", "NaN"] | ||
| } | ||
| ] | ||
| }, | ||
| "Integer": { | ||
| "type": "string", | ||
| "oneOf": [ | ||
| { | ||
| "pattern": "-?(0|[0-9]\\d*)" | ||
| }, | ||
| { | ||
| "enum": ["Infinity", "-Infinity", "NaN"] | ||
| } | ||
| ] | ||
| }, | ||
| "Boolean": { | ||
| "type": "boolean" | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nullis redundant: these properties aren'trequired, so the source can just not set them at all.If we find that sources actually want to output
{"id": null}, then we can always update the well-known types to usetype: [null, integer].