Add "OpenAPI integration with DocC" GSoC project idea #906
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
MahdiBM
reviewed
Feb 12, 2025
|
I'll wait out a bit before merging so you can hash out what this project truly should be about; It would be good to have a very specific goal in mind here so a contributor does not get lost trying to define the output. @simonjbeaumont @sofiaromorales @czechboy0 -- please ping me when this is ready to be merged from your perspective |
sofiaromorales
force-pushed
the
gsoc25-openapi-docc
branch
2 times, most recently
from
bd4145c to
de58087
Compare
anferbui
reviewed
Feb 12, 2025
|
|
||
| **Description** | ||
|
|
||
| [OpenAPI](https://www.openapis.org/) is a standard for documenting HTTP services. It allows creating documents in YAML or JSON format that can be utilized by various tools to automate workflows, such as generating the required code for sending and receiving HTTP requests. |
There was a problem hiding this comment.
I'd say not just for documenting, but in general for defining the APIs of HTTP services. It defines the API contract between the client and the server.
anferbui
approved these changes
Feb 12, 2025
sofiaromorales
force-pushed
the
gsoc25-openapi-docc
branch
from
de58087 to
3de6894
Compare
MahdiBM
approved these changes
Feb 12, 2025
sofiaromorales
force-pushed
the
gsoc25-openapi-docc
branch
from
3de6894 to
89c2a87
Compare
|
Would you mind also resolving the conflict please @sofiaromorales ? |
|
@ktoso anything else needed on this? |
ktoso
approved these changes
Feb 17, 2025
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.
This change adds a "OpenAPI integration with DocC" project idea to the GSoC page.
Motivation:
The Swift ecosystem already offers tooling for OpenAPI. This project explores expanding that support by incorporating DocC for OpenAPI documentation.
Modifications:
Project added to the list of GSoC ideas.
Result:
New project on the GSoC25 list page.