Add "OpenAPI integration with DocC" GSoC project idea #906
Conversation
|
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
left a comment
anferbui
left a comment
There was a problem hiding this comment.
The goal seems clear to me, I like the new phrasing.
I have a couple of suggestions on the wording of the description of the project, to help with clarity.
|
|
||
| **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.
sofiaromorales
force-pushed
the
gsoc25-openapi-docc
branch
from
de58087 to
3de6894
Compare
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? |
6 participants
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.