apib2swagger 1.9.2 → 1.13.0

package/test/output/Attributes.ref.json

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

package/test/output/Gist Fox API + Auth.json

@@ -11,7 +11,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/hal+json": {
                 "_links": {
@@ -31,6 +35,7 @@
           }
         },
         "summary": "Retrieve the Entry Point",
+        "operationId": "Retrieve the Entry Point",
         "description": "",
         "tags": [],
         "parameters": [],
@@ -44,7 +49,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/GistModel"
@@ -52,6 +61,7 @@
           }
         },
         "summary": "Retrieve a Single Gist",
+        "operationId": "Retrieve a Single Gist",
         "description": "",
         "tags": [
           "Gist"
@@ -77,7 +87,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/GistModel"
@@ -85,6 +99,7 @@
           }
         },
         "summary": "Edit a Gist",
+        "operationId": "Edit a Gist",
         "description": "To update a Gist send a JSON with updated value for one or more of the Gist resource attributes. All attributes values (states) from the previous version of this Gist are carried over by default if not included in the hash.",
         "tags": [
           "Gist"
@@ -130,6 +145,7 @@
           }
         },
         "summary": "Delete a Gist",
+        "operationId": "Delete a Gist",
         "description": "",
         "tags": [
           "Gist"
@@ -157,7 +173,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Gist Collection Resource. The Gist resources in collections are embedded. Note the embedded Gists resource are incomplete representations of the Gist in question. Use the respective Gist link to retrieve its full representation.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/hal+json": {
                 "_links": {
@@ -188,6 +208,7 @@
           }
         },
         "summary": "List All Gists",
+        "operationId": "List All Gists",
         "description": "",
         "tags": [
           "Gist"
@@ -209,7 +230,11 @@
         "responses": {
           "201": {
             "description": "HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/GistModel"
@@ -217,6 +242,7 @@
           }
         },
         "summary": "Create a Gist",
+        "operationId": "Create a Gist",
         "description": "To create a new Gist simply provide a JSON hash of the *description* and *content* attributes for the new Gist.\n\nThis action requires an `access_token` with `gist_write` scope.",
         "tags": [
           "Gist"
@@ -261,6 +287,7 @@
           }
         },
         "summary": "Star a Gist",
+        "operationId": "Star a Gist",
         "description": "This action requires an `access_token` with `gist_write` scope.",
         "tags": [
           "Gist"
@@ -291,6 +318,7 @@
           }
         },
         "summary": "Unstar a Gist",
+        "operationId": "Unstar a Gist",
         "description": "This action requires an `access_token` with `gist_write` scope.",
         "tags": [
           "Gist"
@@ -316,7 +344,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Star Resource.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/StarModel"
@@ -324,6 +356,7 @@
           }
         },
         "summary": "Check if a Gist is Starred",
+        "operationId": "Check if a Gist is Starred",
         "description": "",
         "tags": [
           "Gist"
@@ -351,7 +384,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/AuthorizationModel"
@@ -359,6 +396,7 @@
           }
         },
         "summary": "Retrieve Authorization",
+        "operationId": "Retrieve Authorization",
         "description": "",
         "tags": [
           "Access Authorization and Control"
@@ -379,6 +417,7 @@
           }
         },
         "summary": "Create Authorization",
+        "operationId": "Create Authorization",
         "description": "",
         "tags": [
           "Access Authorization and Control"
@@ -420,6 +459,7 @@
           }
         },
         "summary": "Remove an Authorization",
+        "operationId": "Remove an Authorization",
         "description": "",
         "tags": [
           "Access Authorization and Control"

package/test/output/Gist Fox API + Auth.ref.json

@@ -11,7 +11,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/hal+json": {
                 "_links": {
@@ -31,6 +35,7 @@
           }
         },
         "summary": "Retrieve the Entry Point",
+        "operationId": "Retrieve the Entry Point",
         "description": "",
         "tags": [],
         "parameters": [],
@@ -44,7 +49,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/GistModel"
@@ -52,6 +61,7 @@
           }
         },
         "summary": "Retrieve a Single Gist",
+        "operationId": "Retrieve a Single Gist",
         "description": "",
         "tags": [
           "Gist"
@@ -77,7 +87,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/GistModel"
@@ -85,6 +99,7 @@
           }
         },
         "summary": "Edit a Gist",
+        "operationId": "Edit a Gist",
         "description": "To update a Gist send a JSON with updated value for one or more of the Gist resource attributes. All attributes values (states) from the previous version of this Gist are carried over by default if not included in the hash.",
         "tags": [
           "Gist"
@@ -130,6 +145,7 @@
           }
         },
         "summary": "Delete a Gist",
+        "operationId": "Delete a Gist",
         "description": "",
         "tags": [
           "Gist"
@@ -157,7 +173,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Gist Collection Resource. The Gist resources in collections are embedded. Note the embedded Gists resource are incomplete representations of the Gist in question. Use the respective Gist link to retrieve its full representation.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/hal+json": {
                 "_links": {
@@ -188,6 +208,7 @@
           }
         },
         "summary": "List All Gists",
+        "operationId": "List All Gists",
         "description": "",
         "tags": [
           "Gist"
@@ -209,7 +230,11 @@
         "responses": {
           "201": {
             "description": "HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/GistModel"
@@ -217,6 +242,7 @@
           }
         },
         "summary": "Create a Gist",
+        "operationId": "Create a Gist",
         "description": "To create a new Gist simply provide a JSON hash of the *description* and *content* attributes for the new Gist.\n\nThis action requires an `access_token` with `gist_write` scope.",
         "tags": [
           "Gist"
@@ -261,6 +287,7 @@
           }
         },
         "summary": "Star a Gist",
+        "operationId": "Star a Gist",
         "description": "This action requires an `access_token` with `gist_write` scope.",
         "tags": [
           "Gist"
@@ -291,6 +318,7 @@
           }
         },
         "summary": "Unstar a Gist",
+        "operationId": "Unstar a Gist",
         "description": "This action requires an `access_token` with `gist_write` scope.",
         "tags": [
           "Gist"
@@ -316,7 +344,11 @@
         "responses": {
           "200": {
             "description": "HAL+JSON representation of Star Resource.",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/StarModel"
@@ -324,6 +356,7 @@
           }
         },
         "summary": "Check if a Gist is Starred",
+        "operationId": "Check if a Gist is Starred",
         "description": "",
         "tags": [
           "Gist"
@@ -351,7 +384,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "Link": {
+                "type": "string"
+              }
+            },
             "examples": {},
             "schema": {
               "$ref": "#/definitions/AuthorizationModel"
@@ -359,6 +396,7 @@
           }
         },
         "summary": "Retrieve Authorization",
+        "operationId": "Retrieve Authorization",
         "description": "",
         "tags": [
           "Access Authorization and Control"
@@ -379,6 +417,7 @@
           }
         },
         "summary": "Create Authorization",
+        "operationId": "Create Authorization",
         "description": "",
         "tags": [
           "Access Authorization and Control"
@@ -420,6 +459,7 @@
           }
         },
         "summary": "Remove an Authorization",
+        "operationId": "Remove an Authorization",
         "description": "",
         "tags": [
           "Access Authorization and Control"

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": [],