Merge pull request OAI#939 from RobDolinMS/patch-10

Update "swagger" to more generic

Author: webron

versions/3.0.md

@@ -12,7 +12,7 @@ The OpenAPI Specification (OAS) is a project used to describe and document RESTf
 
 
 The OpenAPI Specification defines a set of files required to describe such an API.
-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.
+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.
 
 Additional utilities can also take advantage of the resulting files, such as testing tools.
 
@@ -206,7 +206,7 @@ In subsequent versions of the OpenAPI Specification, care will be given such tha
 #### <a name="infoObject"></a>Info Object
 
 The object provides metadata about the API.
-The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.
+The metadata can be used by the clients if needed, and can be presented in editing or documentation generation tools for convenience.
 
 ##### Fixed Fields
 
@@ -226,13 +226,13 @@ This object can be extended with [Specification Extensions](#specificationExtens
 
 ```json
 {
-  "title": "Swagger Sample App",
+  "title": "Sample Pet Store App",
   "description": "This is a sample server for a pet store.",
-  "termsOfService": "http://swagger.io/terms/",
+  "termsOfService": "http://example.com/terms/",
   "contact": {
     "name": "API Support",
-    "url": "http://www.swagger.io/support",
-    "email": "support@swagger.io"
+    "url": "http://www.example.com/support",
+    "email": "support@example.com"
   },
   "license": {
     "name": "Apache 2.0",
@@ -243,13 +243,13 @@ This object can be extended with [Specification Extensions](#specificationExtens
 ```
 
 ```yaml
-title: Swagger Sample App
+title: Sample Pet Store App
 description: This is a sample server for a pet store.
-termsOfService: http://swagger.io/terms/
+termsOfService: http://example.com/terms/
 contact:
   name: API Support
-  url: http://www.swagger.io/support
-  email: support@swagger.io
+  url: http://www.example.com/support
+  email: support@example.com
 license:
   name: Apache 2.0
   url: http://www.apache.org/licenses/LICENSE-2.0.html
@@ -275,15 +275,15 @@ This object can be extended with [Specification Extensions](#specificationExtens
 ```json
 {
   "name": "API Support",
-  "url": "http://www.swagger.io/support",
-  "email": "support@swagger.io"
+  "url": "http://www.example.com/support",
+  "email": "support@example.com"
 }
 ```
 
 ```yaml
 name: API Support
-url: http://www.swagger.io/support
-email: support@swagger.io
+url: http://www.example.com/support
+email: support@example.com
 ```
 
 #### <a name="licenseObject"></a>License Object
@@ -579,7 +579,7 @@ Describes a single API operation on a path.
 Field Name | Type | Description
 ---|:---:|---
 <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.
-<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.
+<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.
 <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.
 <a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
 <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.
@@ -720,13 +720,13 @@ This object can be extended with [Specification Extensions](#specificationExtens
 ```json
 {
   "description": "Find more info here",
-  "url": "https://swagger.io"
+  "url": "https://example.com"
 }
 ```
 
 ```yaml
 description: Find more info here
-url: https://swagger.io
+url: https://example.com
 ```
 
 #### <a name="parameterObject"></a>Parameter Object
@@ -2829,7 +2829,7 @@ In this example, a full model definition is shown.
       "name": {
         "type": "string",
         "xml": {
-          "namespace": "http://swagger.io/schema/sample",
+          "namespace": "http://example.com/schema/sample",
           "prefix": "sample"
         }
       }
@@ -2850,13 +2850,13 @@ Person:
     name:
       type: string
       xml:
-        namespace: http://swagger.io/schema/sample
+        namespace: http://example.com/schema/sample
         prefix: sample
 ```
 
 ```xml
 <Person id="123">
-    <sample:name xmlns:sample="http://swagger.io/schema/sample">example</sample:name>
+    <sample:name xmlns:sample="http://example.com/schema/sample">example</sample:name>
 </Person>
 ```
 
@@ -3261,7 +3261,7 @@ Field Pattern | Type | Description
     "type": "oauth2",
     "flow": {
       "implicit": {
-        "authorizationUrl": "http://swagger.io/api/oauth/dialog",
+        "authorizationUrl": "http://example.com/api/oauth/dialog",
         "scopes": {
           "write:pets": "modify pets in your account",
           "read:pets": "read your pets"
@@ -3281,7 +3281,7 @@ petstore_auth:
   type: oauth2
   flow: 
     implicit:
-      authorizationUrl: http://swagger.io/api/oauth/dialog
+      authorizationUrl: http://example.com/api/oauth/dialog
       scopes:
         write:pets: modify pets in your account
         read:pets: read your pets
@@ -3361,7 +3361,7 @@ bearerFormat: JWT
   "type": "oauth2",
   "flow": {
     "implicit": {
-      "authorizationUrl": "https://swagger.io/api/oauth/dialog",
+      "authorizationUrl": "https://example.com/api/oauth/dialog",
       "scopes": {
         "write:pets": "modify pets in your account",
         "read:pets": "read your pets"
@@ -3375,7 +3375,7 @@ bearerFormat: JWT
 type: oauth2
 flow: 
   implicit:
-    authorizationUrl: https://swagger.io/api/oauth/dialog
+    authorizationUrl: https://example.com/api/oauth/dialog
     scopes:
       write:pets: modify pets in your account
       read:pets: read your pets
@@ -3416,15 +3416,15 @@ This object can be extended with [Specification Extensions](#specificationExtens
   "type": "oauth2",
   "flow": {
     "implicit": {
-      "authorizationUrl": "https://swagger.io/api/oauth/dialog",
+      "authorizationUrl": "https://example.com/api/oauth/dialog",
       "scopes": {
         "write:pets": "modify pets in your account",
         "read:pets": "read your pets"
       }
     },
     "authorizationCode": {
-      "authorizationUrl": "https://swagger.io/api/oauth/dialog",
-      "tokenUrl": "https://swagger.io/api/oauth/token",
+      "authorizationUrl": "https://example.com/api/oauth/dialog",
+      "tokenUrl": "https://example.com/api/oauth/token",
       "scopes": {
         "write:pets": "modify pets in your account",
         "read:pets": "read your pets"
@@ -3438,13 +3438,13 @@ This object can be extended with [Specification Extensions](#specificationExtens
 type: oauth2
 flow: 
   implicit:
-    authorizationUrl: https://swagger.io/api/oauth/dialog
+    authorizationUrl: https://example.com/api/oauth/dialog
     scopes:
       write:pets: modify pets in your account
       read:pets: read your pets
   authorizationCode:
-    authorizationUrl: https://swagger.io/api/oauth/dialog
-    tokenUrl: https://swagger.io/api/oauth/token
+    authorizationUrl: https://example.com/api/oauth/dialog
+    tokenUrl: https://example.com/api/oauth/token
     scopes:
       write:pets: modify pets in your account
       read:pets: read your pets