OAI / learn.openapis.org

OpenAPI - Getting started, and the specification explained
https://learn.openapis.org/
Creative Commons Attribution 4.0 International
112 stars 56 forks source link

WIP: Glossary and guide to referencing #69

Closed handrews closed 7 months ago

handrews commented 10 months ago

This includes both a defitions page (which could be renamed to glossary if folks like that better) and the start of a detailed guide to referencing and related topics.

The referencing guide is more of a WIP than the glossary, and I'm happy to split the glossary into its own PR if folks like it enough to approve it. I just wanted to show it in context as this is how I wrote it all.

I made the referencing information a section as it is too long and has too many sub-topics to be on a single page. I tried to extract the most common topics into the FAQ so that the basics can be found quickly, which might lead some folks to read the more deep-dive pages.

Some pages stop rather abruptly as I was getting bogged down and figured it would be good to solicit feedback before writing too much more. I'm happy to rework any/all of this to suit what typical users want to know.

handrews commented 10 months ago

@duncanbeevers @notEthan @karenetheridge @ndenny I think I have incorporated all feedback, please let me know if I missed something.

@notEthan instead of making bullet points, I rearranged and renamed the table columns- please let me know if that is more readable. I'd like to keep all of those sorts of blocks of information in the same sort of table rather than switching formats if possible.

I also added an example of names that look usable but probably won't be in many tools because the names are not directly referenced. It's such a weird thing that I'm not sure if that makes it less or more confusing, but it is at least concrete.

handrews commented 7 months ago

Closing this for now in favor of #79 for the definitions/glossary and doing more work on the references parts before re-submitting.