Skip to content
This repository was archived by the owner on Nov 8, 2024. It is now read-only.

Fix reference to the OpenAPI Specification #950

Closed
wants to merge 1 commit into from

Conversation

earth2marsh
Copy link

@earth2marsh earth2marsh commented Jan 17, 2018

πŸš€ Why this change?

The specification format formerly known as Swagger is now the OpenAPI Specification

πŸ“ Related issues and Pull Requests

None

βœ… What didn't I forget?

  • To write docs
  • To write tests
  • To put Conventional Changelog prefixes in front of all my commits and run npm run lint

Since this is a docs-only fix, no tests or linting required.

@honzajavorek
Copy link
Contributor

Hi, there are hundreds of references to Swagger throughout the docs, so if we want to change it, let's change it everywhere.

I'm wondering whether we want to do this at all, but I'm open to discussion. My thoughts: the format is still very well known and searched for as "Swagger". I'm aware of the renaming, but so far I decided to go with the naming like this:

  • Reference the 2.0 version of the format consistently as Swagger
  • Reference the 3.0 version of the format consistently as OpenAPI

The latter isn't in effect as #894 isn't done yet. When Dredd supports both, I'd call the formats Swagger 2.0 and OpenAPI 3.0, to clearly distinguish them. What do you think?

@honzajavorek
Copy link
Contributor

Hi, thanks again for bringing it up. I filed a separate issue for discussing this: #994

@honzajavorek honzajavorek mentioned this pull request Dec 10, 2018
3 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants