Skip to content

Commit affac83

Browse files
RobDolinMSRobDolinMS
authored
Update "swagger" to more generic
Replaces references to Swagger UI or Swagger CodeGen with more generic descriptions. Also updates swagger.io URLs in examples to example.com URLs Signed-off-by: Rob Dolin <[email protected]>
1 parent 5842eda commit affac83

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

‎versions/3.0.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The OpenAPI Specification (OAS) is a project used to describe and document RESTf
1212

1313

1414
The OpenAPI Specification defines a set of files required to describe such an API.
15-
These files can then be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various programming languages.
15+
These files can then be used by documentation generation tools to display the API and code generation tools to generate clients in various programming languages.
1616

1717
Additional utilities can also take advantage of the resulting files, such as testing tools.
1818

@@ -203,7 +203,7 @@ In subsequent versions of the OpenAPI Specification, care will be given such tha
203203
#### <a name="infoObject"></a>Info Object
204204

205205
The object provides metadata about the API.
206-
The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.
206+
The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
207207

208208
##### Fixed Fields
209209

@@ -223,13 +223,13 @@ This object can be extended with [Specification Extensions](#specificationExtens
223223

224224
```json
225225
{
226-
"title": "Swagger Sample App",
226+
"title": "Sample Pet Store App",
227227
"description": "This is a sample server for a pet store.",
228-
"termsOfService": "http://swagger.io/terms/",
228+
"termsOfService": "http://example.com/terms/",
229229
"contact": {
230230
"name": "API Support",
231-
"url": "http://www.swagger.io/support",
232-
"email": "support@swagger.io"
231+
"url": "http://www.example.com/support",
232+
"email": "support@example.com"
233233
},
234234
"license": {
235235
"name": "Apache 2.0",
@@ -240,13 +240,13 @@ This object can be extended with [Specification Extensions](#specificationExtens
240240
```
241241

242242
```yaml
243-
title: Swagger Sample App
243+
title: Sample Pet Store App
244244
description: This is a sample server for a pet store.
245-
termsOfService: http://swagger.io/terms/
245+
termsOfService: http://example.com/terms/
246246
contact:
247247
name: API Support
248-
url: http://www.swagger.io/support
249-
email: support@swagger.io
248+
url: http://www.example.com/support
249+
email: support@example.com
250250
license:
251251
name: Apache 2.0
252252
url: http://www.apache.org/licenses/LICENSE-2.0.html
@@ -272,15 +272,15 @@ This object can be extended with [Specification Extensions](#specificationExtens
272272
```json
273273
{
274274
"name": "API Support",
275-
"url": "http://www.swagger.io/support",
276-
"email": "support@swagger.io"
275+
"url": "http://www.example.com/support",
276+
"email": "support@example.com"
277277
}
278278
```
279279

280280
```yaml
281281
name: API Support
282-
url: http://www.swagger.io/support
283-
email: support@swagger.io
282+
url: http://www.example.com/support
283+
email: support@example.com
284284
```
285285

286286
#### <a name="licenseObject"></a>License Object
@@ -576,7 +576,7 @@ Describes a single API operation on a path.
576576
Field Name | Type | Description
577577
---|:---:|---
578578
<a name="operationTags"></a>tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
579-
<a name="operationSummary"></a>summary | `string` | A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
579+
<a name="operationSummary"></a>summary | `string` | A short summary of what the operation does. For maximum readability in editing or documentation generation tools, this field SHOULD be less than 120 characters.
580580
<a name="operationDescription"></a>description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
581581
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
582582
<a name="operationId"></a>operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
@@ -717,13 +717,13 @@ This object can be extended with [Specification Extensions](#specificationExtens
717717
```json
718718
{
719719
"description": "Find more info here",
720-
"url": "https://swagger.io"
720+
"url": "https://example.com"
721721
}
722722
```
723723

724724
```yaml
725725
description: Find more info here
726-
url: https://swagger.io
726+
url: https://example.com
727727
```
728728

729729
#### <a name="parameterObject"></a>Parameter Object
@@ -2826,7 +2826,7 @@ In this example, a full model definition is shown.
28262826
"name": {
28272827
"type": "string",
28282828
"xml": {
2829-
"namespace": "http://swagger.io/schema/sample",
2829+
"namespace": "http://example.com/schema/sample",
28302830
"prefix": "sample"
28312831
}
28322832
}
@@ -2847,13 +2847,13 @@ Person:
28472847
name:
28482848
type: string
28492849
xml:
2850-
namespace: http://swagger.io/schema/sample
2850+
namespace: http://example.com/schema/sample
28512851
prefix: sample
28522852
```
28532853

28542854
```xml
28552855
<Person id="123">
2856-
<sample:name xmlns:sample="http://swagger.io/schema/sample">example</sample:name>
2856+
<sample:name xmlns:sample="http://example.com/schema/sample">example</sample:name>
28572857
</Person>
28582858
```
28592859

@@ -3258,7 +3258,7 @@ Field Pattern | Type | Description
32583258
"type": "oauth2",
32593259
"flow": {
32603260
"implicit": {
3261-
"authorizationUrl": "http://swagger.io/api/oauth/dialog",
3261+
"authorizationUrl": "http://example.com/api/oauth/dialog",
32623262
"scopes": {
32633263
"write:pets": "modify pets in your account",
32643264
"read:pets": "read your pets"
@@ -3278,7 +3278,7 @@ petstore_auth:
32783278
type: oauth2
32793279
flow:
32803280
implicit:
3281-
authorizationUrl: http://swagger.io/api/oauth/dialog
3281+
authorizationUrl: http://example.com/api/oauth/dialog
32823282
scopes:
32833283
write:pets: modify pets in your account
32843284
read:pets: read your pets
@@ -3358,7 +3358,7 @@ bearerFormat: JWT
33583358
"type": "oauth2",
33593359
"flow": {
33603360
"implicit": {
3361-
"authorizationUrl": "https://swagger.io/api/oauth/dialog",
3361+
"authorizationUrl": "https://example.com/api/oauth/dialog",
33623362
"scopes": {
33633363
"write:pets": "modify pets in your account",
33643364
"read:pets": "read your pets"
@@ -3372,7 +3372,7 @@ bearerFormat: JWT
33723372
type: oauth2
33733373
flow:
33743374
implicit:
3375-
authorizationUrl: https://swagger.io/api/oauth/dialog
3375+
authorizationUrl: https://example.com/api/oauth/dialog
33763376
scopes:
33773377
write:pets: modify pets in your account
33783378
read:pets: read your pets
@@ -3413,15 +3413,15 @@ This object can be extended with [Specification Extensions](#specificationExtens
34133413
"type": "oauth2",
34143414
"flow": {
34153415
"implicit": {
3416-
"authorizationUrl": "https://swagger.io/api/oauth/dialog",
3416+
"authorizationUrl": "https://example.com/api/oauth/dialog",
34173417
"scopes": {
34183418
"write:pets": "modify pets in your account",
34193419
"read:pets": "read your pets"
34203420
}
34213421
},
34223422
"authorizationCode": {
3423-
"authorizationUrl": "https://swagger.io/api/oauth/dialog",
3424-
"tokenUrl": "https://swagger.io/api/oauth/token",
3423+
"authorizationUrl": "https://example.com/api/oauth/dialog",
3424+
"tokenUrl": "https://example.com/api/oauth/token",
34253425
"scopes": {
34263426
"write:pets": "modify pets in your account",
34273427
"read:pets": "read your pets"
@@ -3435,13 +3435,13 @@ This object can be extended with [Specification Extensions](#specificationExtens
34353435
type: oauth2
34363436
flow:
34373437
implicit:
3438-
authorizationUrl: https://swagger.io/api/oauth/dialog
3438+
authorizationUrl: https://example.com/api/oauth/dialog
34393439
scopes:
34403440
write:pets: modify pets in your account
34413441
read:pets: read your pets
34423442
authorizationCode:
3443-
authorizationUrl: https://swagger.io/api/oauth/dialog
3444-
tokenUrl: https://swagger.io/api/oauth/token
3443+
authorizationUrl: https://example.com/api/oauth/dialog
3444+
tokenUrl: https://example.com/api/oauth/token
34453445
scopes:
34463446
write:pets: modify pets in your account
34473447
read:pets: read your pets

0 commit comments

Comments
 (0)