Skip to content
This repository was archived by the owner on Sep 14, 2022. It is now read-only.

Commit 4020e6f

Browse files
committed
Swagger Spec -> OpenAPI Spec
1 parent 982774a commit 4020e6f

7 files changed

+15
-15
lines changed

docs/adding-paths.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The parts of the path definition include:
5151

5252
* `parameters:` specifies any parameters used by the path. They can be passed as query or form parameters, or headers.
5353

54-
* The other keys conform to the Swagger 2.0 [specifications](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md). The parameters is a YAML array that defines all the parameters required for the call. The responses object defines the response specifications for response codes.
54+
* The other keys conform to the Swagger 2.0 [specifications](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md). The parameters is a YAML array that defines all the parameters required for the call. The responses object defines the response specifications for response codes.
5555

5656
### <a name="more"></a>More about route handling
5757

@@ -93,7 +93,7 @@ When you call your API, the middleware attempts to match a route defined in the
9393

9494
### <a name="models"></a>Request and response models
9595

96-
The Swagger specification allows you to define both request and the response models (also called schemas). The `path` definition described in the previous section is an example of a request model.
96+
The OpenAPI Specification allows you to define both request and the response models (also called schemas). The `path` definition described in the previous section is an example of a request model.
9797

9898
Here's an example of a weather API that returns a relatively complex object.
9999

docs/cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Example:
141141

142142
##### <a name="docs"></a>swagger docs
143143

144-
Opens the Swagger 2.0 specification in your browser.
144+
Opens the OpenAPI 2.0 Specification in your browser.
145145

146146
Example:
147147

docs/introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The swagger module provides tools for designing and building APIs entirely in No
77
### <a name="sdlc"></a>The API-First Development Process
88
API design is a discovery process. Swagger development begins with design tooling, and it expects that you will evolve your interface over time. It gracefully handles the routing of interfaces to controllers so that you can make changes to your interfaces without clobbering any of your implementation logic.
99

10-
Designing an API specification is like writing a contract. As you write the spec in YAML using [Swagger 2.0](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md), your API documentation is generated in real-time, allowing the client and server teams to agree on how their systems will work together.
10+
Designing an API specification is like writing a contract. As you write the spec in YAML using [Swagger 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md), your API documentation is generated in real-time, allowing the client and server teams to agree on how their systems will work together.
1111

1212
Once you have defined your first operation, it drives a mock server, which enables client development happen in parallel with server development. As you build the client, you will discover further changes you'll need to make to your APIs, meaning another iteration of the specification.
1313

docs/mock-mode.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ Here's an example that returns some data whenever the `search()` handler method
252252

253253
After you're happy with your API design, you're ready to implement wire up the controller for the `/weather` path.
254254

255-
You simply specify in the Swagger spec the route handler (controller) file, which method to call in the controller (operationId), and any query parameters you wish to pass:
255+
You simply specify in the OpenAPI spec the route handler (controller) file, which method to call in the controller (operationId), and any query parameters you wish to pass:
256256

257257
In weather sample's `swagger.yaml` file, it looks like this:
258258

docs/quick-start.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ That's it - You have now created, started and tested your first API project with
5050
5151
Open <project-root>/app.js in an editor. This is the main Node.js app that installs middleware and requires the API framework that you chose when you created your project.
5252
53-
The middleware modules perform tasks like Swagger specification validation and endpoint routing. For more information, see [swagger modules and dependencies](./modules.md).
53+
The middleware modules perform tasks like OpenAPI Specification validation and endpoint routing. For more information, see [swagger modules and dependencies](./modules.md).
5454
5555
### <a name="openeditor"></a>Open the Swagger editor
5656

docs/swagger-about.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To read more about Swagger, refer to:
2020

2121
The Swagger Editor lets you design your API specification and preview its documentation for your swagger API. The editor is installed with swagger.
2222

23-
A swagger.yaml file is installed into every new swagger project, and lives in `<project_root>/api/swagger/swagger.yaml`. It conforms to the [Swagger 2.0 specification](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md).
23+
A swagger.yaml file is installed into every new swagger project, and lives in `<project_root>/api/swagger/swagger.yaml`. It conforms to the [OpenAPI 2.0 Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md).
2424

2525
Behind the scenes, Swagger middleware validates and processes the Swagger configuration file, and routes API operation endpoints to controller files. All **you** need to do is implement your custom API controller logic.
2626

@@ -44,4 +44,4 @@ YAML is intended to be easy for humans to read. Every swagger project includes a
4444

4545
### <a name="nextstep"></a>Next step
4646

47-
For a more detailed look the Swagger configurations, see "[The Swagger specification file](./swagger-file.md)".
47+
For a more detailed look the Swagger configurations, see "[The OpenAPI Specification file](./swagger-file.md)".

docs/swagger-file.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
## <a name="understandingthespec"></a>Understanding the Swagger specification file
1+
## <a name="understandingthespec"></a>Understanding the OpenAPI Specification file
22

33
* [Intro](#intro)
44
* [Default swagger project file](#default)
5-
* [Swagger specification elements](#reference)
5+
* [OpenAPI Specification elements](#reference)
66

77
### <a name="intro"></a>Intro
88

9-
When you execute `swagger project create myproject`, a default Swagger model is placed in `myproject/api/swagger/swagger.yaml`. This model conforms to the [Swagger 2.0 specification](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md).
9+
When you execute `swagger project create myproject`, a default Swagger model is placed in `myproject/api/swagger/swagger.yaml`. This model conforms to the [OpenAPI 2.0 Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md).
1010

1111
>Note: For a quick intro to swagger, see "[What is Swagger](./swagger-about.md)".
1212
@@ -56,13 +56,13 @@ Here is the entire `swagger.yaml` file that is provisioned for a new swagger pro
5656
```
5757

5858

59-
###<a name="reference"></a>Swagger specification elements
59+
###<a name="reference"></a>OpenAPI Specification elements
6060

61-
The Swagger file includes a number of standard Swagger 2.0 specification elements. You can read about them in the [Swagger 2.0 specification](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md).
61+
The Swagger file includes a number of standard OpenAPI 2.0 Specification elements. You can read about them in the [OpenAPI 2.0 Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md).
6262

6363
Here's a brief description of the elements in a swagger project file:
6464

65-
* **swagger: 2.0** - (Required) Identifies the version of the Swagger specification (2.0).
65+
* **swagger: 2.0** - (Required) Identifies the version of the OpenAPI Specification (2.0).
6666

6767
* **info:** - (Required) Provides metadata about the API.
6868

@@ -76,7 +76,7 @@ Here's a brief description of the elements in a swagger project file:
7676

7777
* **produces:** - (Optional) A list of MIME types the APIs can produce.
7878

79-
* **paths:** - (Required) Defines the available operations on the API. You'll spend most of your time configuring the paths part of the file. You can read about the path element in the [Swagger 2.0 specification](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md). In general, the paths section specifies an operation's verb (like `get`), the endpoint for an API operation (like `/hello`), query parameters, and responses.
79+
* **paths:** - (Required) Defines the available operations on the API. You'll spend most of your time configuring the paths part of the file. You can read about the path element in the [OpenAPI 2.0 Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md). In general, the paths section specifies an operation's verb (like `get`), the endpoint for an API operation (like `/hello`), query parameters, and responses.
8080

8181
* **definitions:** - (Optional) These represent the structure of complex objects such as request and response bodies. For example, you might have a collection of `/users` that returns an array of `user` objects. You would describe these with two definitions: 1) to describe the `User` object, and 2) the definition of the `Users` array. Swagger uses [JSON-schema](http://json-schema.org/).
8282

0 commit comments

Comments
 (0)