[OpenAPI] Document the Swiftly and SSWG APIs #877
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
|
@cmcgee1024 I based it on your hand-crafted Codable types from https://github.com/swiftlang/swiftly/blob/c7fe40d3fd7d82f040014a88a11e8f6393e267d4/Sources/SwiftlyCore/HTTPClient.swift#L64, so should hopefully be plug-and-play for you now |
czechboy0
changed the title
|
cc @FranzBusch for the SSWG API |
FranzBusch
approved these changes
Jan 22, 2025
|
@0xTim Can you get this over the line for us? |
0xTim
approved these changes
Jan 22, 2025
|
@swift-ci test |
|
@swift-ci please test |
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:
A new Swiftly releases API was added in #828, but that happened before the first OpenAPI PR landed in #841.
The
/sswg/incubation/...API was also undocumented.Modifications:
Add the Swiftly and SSWG APIs info into the existing OpenAPI doc, allowing Swiftly and other API adopters to generate their client.
Result:
Quicker, less error-prone integration with the Swift.org API from tools in the ecosystem.
