Support base64-encoded data #55
Merged
Conversation
This file contains hidden or 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
rnro
force-pushed
the
base64_encoded_data_type_string_format_byte
branch
from
83125e6 to
b1cd56e
Compare
There was a problem hiding this comment.
Users will be able to describe base64-encoded data as
OpenAPIRuntime.Base64EncodedDatae.g.public typealias MyData = OpenAPIRuntime.Base64EncodedData
By users, do we mean the generator will emit this type alias when it encounters format: base64 in the OpenAPI document?
Sorry, yes, the generator. I think we will use |
|
@swift-server-bot add to allowlist |
rnro
force-pushed
the
base64_encoded_data_type_string_format_byte
branch
2 times, most recently
from
4a10d8c to
bc27f86
Compare
|
@swift-server-bot test this please |
Motivation OpenAPI supports base64-encoded data but to this point OpenAPI Generator has not (apple/swift-openapi-generator#11). Modifications Introduce the `Base64EncodedData` codable type to allow users in the generator to describe byte types which must be en/de-coded. Result Users will be able to describe base64-encoded data as `OpenAPIRuntime.Base64EncodedData` e.g. ``` public typealias MyData = OpenAPIRuntime.Base64EncodedData ``` Test Plan Added a round-trip encode/decode test `testEncodingDecodingRoundTrip_base64_success`
rnro
force-pushed
the
base64_encoded_data_type_string_format_byte
branch
from
6a86b64 to
dffa64c
Compare
czechboy0
reviewed
Oct 5, 2023
rnro
force-pushed
the
base64_encoded_data_type_string_format_byte
branch
from
a8c8212 to
1427a01
Compare
czechboy0
requested changes
Oct 5, 2023
|
The accompanying generator change is apple/swift-openapi-generator#326 |
|
@swift-server-bot add to allowlist |
czechboy0
approved these changes
Oct 9, 2023
simonjbeaumont
approved these changes
Oct 9, 2023
czechboy0
pushed a commit
to apple/swift-openapi-generator
that referenced
this pull request
Oct 10, 2023
This change accompanies apple/swift-openapi-runtime#55 and relies on it for the `OpenAPIRuntime.Base64EncodedData` type. ### Motivation OpenAPI supports base64-encoded data but to this point Swift OpenAPI Generator has not (#11). ### Modifications A data type specified as `type: string, format: byte` will now result in a generated type which is `Codable` and backed by a `OpenAPIRuntime.Base64EncodedData` type which knows how to encode and decode base64 data. ### Result Users will be able to specify request/response payloads as base64-encoded data which will be encoded and decoded transparently ### Test Plan Unit tested locally.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
OpenAPI supports base64-encoded data but to this point OpenAPI Generator has not (apple/swift-openapi-generator#11).
Modifications
Introduce the
Base64EncodedDatacodable type to allow users in the generator to describe byte types which must be en/de-coded.Result
Users will be able to describe base64-encoded data as
OpenAPIRuntime.Base64EncodedDatae.g.Test Plan
Added a round-trip encode/decode test
testEncodingDecodingRoundTrip_base64_success