Skip to content

Completed the OpenAPI QuickStart #55

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

Merged
merged 5 commits into from
Sep 12, 2021
Merged

Completed the OpenAPI QuickStart #55

merged 5 commits into from
Sep 12, 2021

Conversation

bradygaster
Copy link
Contributor

@LadyNaggaga let me know if this is the right style you'd hoped for in terms of TOC placement and so forth. Definitely do not merge yet, as there's a lot of work to be done, but just wanted to make sure this represents the approach you'd hoped I'd take with placing the article in the TOC and the H1/H2/H3's. :) Let me know if you have any tweaks you'd like me to make to this approach and I'll adjust and finish the content.

Feel free to close this PR once you let me know if this is the desired approach, and I'll finish up the content ASAP.

Copy link
Contributor

@LadyNaggaga LadyNaggaga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please move the guide/openapi do to guide section please?

@davidfowl
Copy link
Collaborator

@bradygaster take a look here as well https://gist.github.com/davidfowl/ff1addd02d239d2d26f4648a06158727#open-apiswagger. I want to make sure I cover all of the methods that can influence the open API description. I'm sure I'm missing some

@bradygaster
Copy link
Contributor Author

@LadyNaggaga i've moved this over per your request and finished up what i think is a concise OpenAPI quickstart. This is ready for your review and merge. Thanks so much!

@bradygaster
Copy link
Contributor Author

bradygaster commented Sep 12, 2021

@bradygaster take a look here as well https://gist.github.com/davidfowl/ff1addd02d239d2d26f4648a06158727#open-apiswagger. I want to make sure I cover all of the methods that can influence the open API description. I'm sure I'm missing some

Did you see the doc @captainsafia was working on? I'd argue all of her content could be brought in to your doc, too. That's a fantastic doc. Kitchen sink!

Here's the link to Safia's content: #36

@bradygaster bradygaster changed the title Started the OpenAPI doc Completed the OpenAPI QuickStart Sep 12, 2021
@bradygaster
Copy link
Contributor Author

Last update on this - i've added @captainsafia's content from the issue and applied a teensy bit of wordsmithery to it. Let me know if any of you have anything to add (or feel free to update the PR, i welcome any tweaks on this).

@LadyNaggaga
Copy link
Contributor

This so dope!!!! Thank you

@LadyNaggaga LadyNaggaga merged commit ba3552c into Minimal-APIs:main Sep 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants