apib2swagger 1.10.0 → 1.14.0

package/test/output/Issue-#15.json

@@ -41,6 +41,7 @@
           }
         },
         "summary": "Get Server Settings",
+        "operationId": "Get Server Settings",
         "description": "",
         "tags": [
           "Settings"
@@ -82,6 +83,7 @@
           }
         },
         "summary": "List all users",
+        "operationId": "List all users",
         "description": "Get a list of all users. Optionally, you can specify a `prefix` to search for a specific user.\n\n+ prefix (string - The prefix of a user (username, first name, or last name)",
         "tags": [
           "Users"
@@ -186,6 +188,7 @@
           }
         },
         "summary": "Get a specific user",
+        "operationId": "Get a specific user",
         "description": "",
         "tags": [
           "Users"

package/test/output/Issue-#15.ref.json

@@ -41,6 +41,7 @@
           }
         },
         "summary": "Get Server Settings",
+        "operationId": "Get Server Settings",
         "description": "",
         "tags": [
           "Settings"
@@ -82,6 +83,7 @@
           }
         },
         "summary": "List all users",
+        "operationId": "List all users",
         "description": "Get a list of all users. Optionally, you can specify a `prefix` to search for a specific user.\n\n+ prefix (string - The prefix of a user (username, first name, or last name)",
         "tags": [
           "Users"
@@ -123,6 +125,7 @@
           }
         },
         "summary": "Get a specific user",
+        "operationId": "Get a specific user",
         "description": "",
         "tags": [
           "Users"

package/test/output/Issue-#23.json

@@ -16,6 +16,7 @@
           }
         },
         "summary": "",
+        "operationId": "",
         "description": "",
         "tags": [],
         "parameters": [

package/test/output/Issue-#23.ref.json

@@ -16,6 +16,7 @@
           }
         },
         "summary": "",
+        "operationId": "",
         "description": "",
         "tags": [],
         "parameters": [

package/test/output/Issue-#26.json

@@ -61,6 +61,7 @@
           }
         },
         "summary": "Get Store",
+        "operationId": "Get Store",
         "description": "",
         "tags": [
           "Stores"
@@ -133,6 +134,7 @@
           }
         },
         "summary": "Update Store",
+        "operationId": "Update Store",
         "description": "Updates an existing store. This call does not currently support partial updates. The entire resource must be provided in the body of the request.",
         "tags": [
           "Stores"

package/test/output/Issue-#26.ref.json

@@ -61,6 +61,7 @@
           }
         },
         "summary": "Get Store",
+        "operationId": "Get Store",
         "description": "",
         "tags": [
           "Stores"
@@ -133,6 +134,7 @@
           }
         },
         "summary": "Update Store",
+        "operationId": "Update Store",
         "description": "Updates an existing store. This call does not currently support partial updates. The entire resource must be provided in the body of the request.",
         "tags": [
           "Stores"

package/test/output/Issue-#29.json

@@ -77,6 +77,7 @@
           }
         },
         "summary": "Retrieve A Post",
+        "operationId": "Retrieve A Post",
         "description": "",
         "tags": [],
         "parameters": [
@@ -104,6 +105,7 @@
           }
         },
         "summary": "Create Post",
+        "operationId": "Create Post",
         "description": "",
         "tags": [],
         "parameters": [

package/test/output/Issue-#29.ref.json

@@ -39,6 +39,7 @@
           }
         },
         "summary": "Retrieve A Post",
+        "operationId": "Retrieve A Post",
         "description": "",
         "tags": [],
         "parameters": [
@@ -66,6 +67,7 @@
           }
         },
         "summary": "Create Post",
+        "operationId": "Create Post",
         "description": "",
         "tags": [],
         "parameters": [

package/test/output/Issue-#33.json

@@ -97,6 +97,7 @@
           }
         },
         "summary": "Get Plans of People",
+        "operationId": "Get Plans of People",
         "description": "* Paginated ✖\n\n* Sortable ✖\n\n* Signable ✖\n\n#### Error Codes\n\nPossible error codes for this resource.\n\n| HTTP Status Code  | Error Code        | Purpose   |\n| ----------------- | ----------------- | --------- |\n| 400               | VALIDATION\\_ERROR | Validation error. |\n| 400               | FIELD\\_MISSING    | A required field is missing. |",
         "tags": [
           "People"
@@ -119,20 +120,20 @@
             "type": "string"
           },
           {
-            "description": "e.g. <here comes some key>",
-            "in": "header",
             "name": "some-key",
+            "in": "header",
+            "description": "e.g. <here comes some key>",
             "required": false,
-            "type": "string",
-            "x-example": "<here comes some key>"
+            "x-example": "<here comes some key>",
+            "type": "string"
           },
           {
-            "description": "e.g. <here comes some token>",
-            "in": "header",
             "name": "auth",
+            "in": "header",
+            "description": "e.g. <here comes some token>",
             "required": false,
-            "type": "string",
-            "x-example": "<here comes some token>"
+            "x-example": "<here comes some token>",
+            "type": "string"
           }
         ],
         "produces": [

package/test/output/Issue-#33.ref.json

@@ -87,6 +87,7 @@
           }
         },
         "summary": "Get Plans of People",
+        "operationId": "Get Plans of People",
         "description": "* Paginated ✖\n\n* Sortable ✖\n\n* Signable ✖\n\n#### Error Codes\n\nPossible error codes for this resource.\n\n| HTTP Status Code  | Error Code        | Purpose   |\n| ----------------- | ----------------- | --------- |\n| 400               | VALIDATION\\_ERROR | Validation error. |\n| 400               | FIELD\\_MISSING    | A required field is missing. |",
         "tags": [
           "People"
@@ -109,20 +110,20 @@
             "type": "string"
           },
           {
-            "description": "e.g. <here comes some key>",
-            "in": "header",
             "name": "some-key",
+            "in": "header",
+            "description": "e.g. <here comes some key>",
             "required": false,
-            "type": "string",
-            "x-example": "<here comes some key>"
+            "x-example": "<here comes some key>",
+            "type": "string"
           },
           {
-            "description": "e.g. <here comes some token>",
-            "in": "header",
             "name": "auth",
+            "in": "header",
+            "description": "e.g. <here comes some token>",
             "required": false,
-            "type": "string",
-            "x-example": "<here comes some token>"
+            "x-example": "<here comes some token>",
+            "type": "string"
           }
         ],
         "produces": [

package/test/output/Issue-#36.json

@@ -69,6 +69,7 @@
           }
         },
         "summary": "",
+        "operationId": "",
         "description": "",
         "tags": [],
         "parameters": [],

package/test/output/Issue-#36.ref.json

@@ -47,6 +47,7 @@
           }
         },
         "summary": "",
+        "operationId": "",
         "description": "",
         "tags": [],
         "parameters": [],

package/test/output/Issue-#38.bearer.json

@@ -1,56 +1,57 @@
 {
-    "swagger": "2.0",
-    "info": {
-      "title": "",
-      "version": "",
-      "description": ""
-    },
-    "paths": {
-      "/whatever": {
-        "get": {
-          "responses": {
-            "200": {
-              "description": "OK",
-              "headers": {},
-              "examples": {}
-            }
+  "swagger": "2.0",
+  "info": {
+    "title": "",
+    "version": "",
+    "description": ""
+  },
+  "paths": {
+    "/whatever": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {},
+            "examples": {}
+          }
+        },
+        "summary": "Whatever",
+        "operationId": "Whatever",
+        "description": "",
+        "tags": [],
+        "parameters": [
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "The maximum number of results to return.",
+            "required": false,
+            "type": "number",
+            "default": 10
+          }
+        ],
+        "security": [
+          {
+            "basic": []
           },
-          "summary": "Whatever",
-          "description": "",
-          "tags": [],
-          "parameters": [
-            {
-              "name": "limit",
-              "in": "query",
-              "description": "The maximum number of results to return.",
-              "required": false,
-              "type": "number",
-              "default": 10
-            }
-          ],
-          "security": [
-            {
-              "basic": []
-            },
-            {
-              "bearer": []
-            }
-          ]
-        }
-      }
-    },
-    "definitions": {
-      "Whatever": {}
-    },
-    "securityDefinitions": {
-      "basic": {
-        "type": "basic"
-      },
-      "bearer": {
-        "in": "header",
-        "name": "Authorization",
-        "type": "apiKey"
+          {
+            "bearer": []
+          }
+        ]
       }
+    }
+  },
+  "definitions": {
+    "Whatever": {}
+  },
+  "securityDefinitions": {
+    "basic": {
+      "type": "basic"
     },
-    "tags": []
-  }
+    "bearer": {
+      "type": "apiKey",
+      "in": "header",
+      "name": "Authorization"
+    }
+  },
+  "tags": []
+}

package/test/output/Issue-#38.json

@@ -16,6 +16,7 @@
           }
         },
         "summary": "Whatever",
+        "operationId": "Whatever",
         "description": "",
         "tags": [],
         "parameters": [

package/test/output/Issue-#38.ref.json

@@ -16,6 +16,7 @@
           }
         },
         "summary": "Whatever",
+        "operationId": "Whatever",
         "description": "",
         "tags": [],
         "parameters": [

package/test/output/Issue-#49.json

@@ -0,0 +1,141 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "",
+    "version": "",
+    "description": ""
+  },
+  "paths": {
+    "/user": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {},
+            "examples": {
+              "application/json": {
+                "id": "",
+                "name": null
+              }
+            },
+            "schema": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string"
+                },
+                "name": {
+                  "type": [
+                    "string",
+                    "null"
+                  ]
+                }
+              },
+              "required": [
+                "id",
+                "name"
+              ]
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "examples": {}
+          }
+        },
+        "summary": "Get one user",
+        "operationId": "Get one user",
+        "description": "",
+        "tags": [
+          "Users"
+        ],
+        "parameters": [],
+        "produces": [
+          "application/json"
+        ]
+      }
+    },
+    "/users": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {},
+            "examples": {
+              "application/json": [
+                {
+                  "id": "",
+                  "name": null
+                }
+              ]
+            },
+            "schema": {
+              "type": "array",
+              "items": {}
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "examples": {}
+          }
+        },
+        "summary": "Get a collection of users",
+        "operationId": "Get a collection of users",
+        "description": "",
+        "tags": [
+          "Users"
+        ],
+        "parameters": [],
+        "produces": [
+          "application/json"
+        ]
+      }
+    }
+  },
+  "definitions": {
+    "A user": {},
+    "Some users": {},
+    "User": {
+      "type": "object",
+      "required": [
+        "id",
+        "name"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "name": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      }
+    },
+    "Users": {
+      "type": "object",
+      "required": [
+        "users"
+      ],
+      "properties": {
+        "users": {
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "$ref": "#/definitions/User"
+          }
+        }
+      }
+    }
+  },
+  "securityDefinitions": {},
+  "tags": [
+    {
+      "name": "Users"
+    }
+  ]
+}

package/test/output/Issue-#49.ref.json

@@ -0,0 +1,126 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "",
+    "version": "",
+    "description": ""
+  },
+  "paths": {
+    "/user": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {},
+            "examples": {
+              "application/json": {
+                "id": "",
+                "name": null
+              }
+            },
+            "schema": {
+              "$ref": "#/definitions/User"
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "examples": {}
+          }
+        },
+        "summary": "Get one user",
+        "operationId": "Get one user",
+        "description": "",
+        "tags": [
+          "Users"
+        ],
+        "parameters": [],
+        "produces": [
+          "application/json"
+        ]
+      }
+    },
+    "/users": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {},
+            "examples": {
+              "application/json": [
+                {
+                  "id": "",
+                  "name": null
+                }
+              ]
+            },
+            "schema": {
+              "type": "array",
+              "items": {}
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "examples": {}
+          }
+        },
+        "summary": "Get a collection of users",
+        "operationId": "Get a collection of users",
+        "description": "",
+        "tags": [
+          "Users"
+        ],
+        "parameters": [],
+        "produces": [
+          "application/json"
+        ]
+      }
+    }
+  },
+  "definitions": {
+    "A user": {},
+    "Some users": {},
+    "User": {
+      "type": "object",
+      "required": [
+        "id",
+        "name"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "name": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      }
+    },
+    "Users": {
+      "type": "object",
+      "required": [
+        "users"
+      ],
+      "properties": {
+        "users": {
+          "type": [
+            "array",
+            "null"
+          ],
+          "items": {
+            "$ref": "#/definitions/User"
+          }
+        }
+      }
+    }
+  },
+  "securityDefinitions": {},
+  "tags": [
+    {
+      "name": "Users"
+    }
+  ]
+}