search

OAI / OpenAPI-Style-Guide

How to (and how not to) refer to the OAI in meetups, interviews, casual conversations, the settling of bar bets, and for conference presentations.
Apache License 2.0
210 stars 45 forks source link

OpenAPI Specification vs. Swagger specification - Why the change in capitalization for Specification? #6

Closed coopr closed 6 years ago

coopr commented 6 years ago

I find it curious that the word "specification" is capitalized when following OpenAPI, but not when following Swagger.

I understand there exists an abbreviation OAS - but I'm not sure that the presence of a capital S in that abbreviation necessitates a capital S in "OpenAPI Specification".

Is there an explanation for why Specification is capitalized?

earth2marsh commented 6 years ago

Because both an initiative and a specification can be referred to as OpenAPI, those two nouns were made part of the proper names of those two things in order to make it easier to differentiate between them.

FWIW, it's acceptable to refer to specifications (documents, not the Spec itself) in the OpenAPI format using lowercase. The capital is only needed when describing the formal API description format known as the OpenAPI Specification (OAS).

Does that help?