-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
OpenAPI Specification Tutorials #256
base: main
Are you sure you want to change the base?
Conversation
❌ Deploy Preview for bump-content-hub failed.
|
src/_guides/openapi/specification/v3.1/data-models/schema-and-data-types.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/components.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/http-requests.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/http-requests.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/http-requests.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/http-requests.md
Outdated
Show resolved
Hide resolved
8ef848b
to
c143301
Compare
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.
Implemented all changes and feedback in latest push. Will continue to crack on!
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/data-models/schema-and-data-types.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Outdated
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Show resolved
Hide resolved
src/_guides/openapi/specification/v3.1/understanding-structure/basic-structure.md
Show resolved
Hide resolved
c143301
to
89d985f
Compare
@ChristopheDujarric @paulRbr Do you want me to bother with that first section: Introduction to OpenAPI
You already have this https://docs.bump.sh/guides/openapi/what-is-openapi/ That guide covers what is openapi, history and evolution, and benefits, all in the one guide. I could A) move it to this section, B) use it as a starter for the three guides, c) do nothing with it and not write these new guides. |
Great question! Reading quickly through it again, it feels like some things can be reused (like the diagrams), but the style/tone and possibly some of the content need an update, too. Also, this guide points to what was originally a blog post: https://bump.sh/blog/what-is-openapi. In my opinion:
|
befdd22
to
aa0f9aa
Compare
f006919
to
0d945f3
Compare
Alright! This is draft done! We could spend months getting this perfect, but for now lets make it good and merge it, focusing on typos, inaccuracies, and anything that is weird. Other improvements would be better off listed as seperate issues, or turned into a writeup somewhere where I can sprinkle in improvements in batches over the upcoming weeks. The content is structured in folders, but Bridgetown will need some convincing to display this properly, and I feel like that is also outside the scope of this work. If anyone can help me with that in another PR based off of this one, we can merge both at once. |
Co-authored-by: Paul B. <[email protected]>
c5c866f
to
462e07e
Compare
A new OpenAPI Specification tutorial section, covering all the important topics showing how to work with OpenAPI, instead of just going to the specification.