apib2swagger 1.9.2 → 1.13.0

package/test/output/01. Simplest API.json

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

package/test/output/01. Simplest API.ref.json

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

package/test/output/02. Resource and Actions.json

@@ -18,6 +18,7 @@
           }
         },
         "summary": "",
+        "operationId": "",
         "description": "Here we define an action using the `GET` [HTTP request method](http://www.w3schools.com/tags/ref_httpmethods.asp) for our resource `/message`.\n\nAs with every good action it should return a [response](http://www.w3.org/TR/di-gloss/#def-http-response). A response always bears a status code. Code 200 is great as it means all is green. Responding with some data can be a great idea as well so let's add a plain text message to our response.",
         "tags": [],
         "parameters": [],
@@ -34,6 +35,7 @@
           }
         },
         "summary": "",
+        "operationId": "",
         "description": "OK, let's add another action. This time to put new data to our resource (essentially an update action). We will need to send something in a [request](http://www.w3.org/TR/di-gloss/#def-http-request) and then send a response back confirming the posting was a success (HTTP Status Code 204 ~ Resource updated successfully, no content is returned).",
         "tags": [],
         "parameters": []

package/test/output/02. Resource and Actions.ref.json

@@ -18,6 +18,7 @@
           }
         },
         "summary": "",
+        "operationId": "",
         "description": "Here we define an action using the `GET` [HTTP request method](http://www.w3schools.com/tags/ref_httpmethods.asp) for our resource `/message`.\n\nAs with every good action it should return a [response](http://www.w3.org/TR/di-gloss/#def-http-response). A response always bears a status code. Code 200 is great as it means all is green. Responding with some data can be a great idea as well so let's add a plain text message to our response.",
         "tags": [],
         "parameters": [],
@@ -34,6 +35,7 @@
           }
         },
         "summary": "",
+        "operationId": "",
         "description": "OK, let's add another action. This time to put new data to our resource (essentially an update action). We will need to send something in a [request](http://www.w3.org/TR/di-gloss/#def-http-request) and then send a response back confirming the posting was a success (HTTP Status Code 204 ~ Resource updated successfully, no content is returned).",
         "tags": [],
         "parameters": []

package/test/output/03. Named Resource and Actions.json

@@ -18,6 +18,7 @@
           }
         },
         "summary": "Retrieve a Message",
+        "operationId": "Retrieve a Message",
         "description": "Now this is informative! No extra explanation needed here. This action clearly retrieves the message.",
         "tags": [],
         "parameters": [],
@@ -34,6 +35,7 @@
           }
         },
         "summary": "Update a Message",
+        "operationId": "Update a Message",
         "description": "`Update a message` - nice and simple naming is the best way to go.",
         "tags": [],
         "parameters": []

package/test/output/03. Named Resource and Actions.ref.json

@@ -18,6 +18,7 @@
           }
         },
         "summary": "Retrieve a Message",
+        "operationId": "Retrieve a Message",
         "description": "Now this is informative! No extra explanation needed here. This action clearly retrieves the message.",
         "tags": [],
         "parameters": [],
@@ -34,6 +35,7 @@
           }
         },
         "summary": "Update a Message",
+        "operationId": "Update a Message",
         "description": "`Update a message` - nice and simple naming is the best way to go.",
         "tags": [],
         "parameters": []

package/test/output/04. Grouping Resources.json

@@ -18,6 +18,7 @@
           }
         },
         "summary": "Retrieve a Message",
+        "operationId": "Retrieve a Message",
         "description": "",
         "tags": [
           "Messages"
@@ -36,6 +37,7 @@
           }
         },
         "summary": "Update a Message",
+        "operationId": "Update a Message",
         "description": "",
         "tags": [
           "Messages"

package/test/output/04. Grouping Resources.ref.json

@@ -18,6 +18,7 @@
           }
         },
         "summary": "Retrieve a Message",
+        "operationId": "Retrieve a Message",
         "description": "",
         "tags": [
           "Messages"
@@ -36,6 +37,7 @@
           }
         },
         "summary": "Update a Message",
+        "operationId": "Update a Message",
         "description": "",
         "tags": [
           "Messages"

package/test/output/05. Responses.json

@@ -11,7 +11,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "X-My-Message-Header": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/json": {
                 "message": "Hello World!"
@@ -20,6 +24,7 @@
           }
         },
         "summary": "Retrieve a Message",
+        "operationId": "Retrieve a Message",
         "description": "This action has **two** responses defined: One returing a plain text and the other a JSON representation of our resource. Both has the same HTTP status code. Also both responses bear additional information in the form of a custom HTTP header. Note that both responses have set the `Content-Type` HTTP header just by specifying `(text/plain)` or `(application/json)` in their respective signatures.",
         "tags": [
           "Messages"
@@ -38,6 +43,7 @@
           }
         },
         "summary": "Update a Message",
+        "operationId": "Update a Message",
         "description": "",
         "tags": [
           "Messages"

package/test/output/05. Responses.ref.json

@@ -11,7 +11,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "X-My-Message-Header": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/json": {
                 "message": "Hello World!"
@@ -20,6 +24,7 @@
           }
         },
         "summary": "Retrieve a Message",
+        "operationId": "Retrieve a Message",
         "description": "This action has **two** responses defined: One returing a plain text and the other a JSON representation of our resource. Both has the same HTTP status code. Also both responses bear additional information in the form of a custom HTTP header. Note that both responses have set the `Content-Type` HTTP header just by specifying `(text/plain)` or `(application/json)` in their respective signatures.",
         "tags": [
           "Messages"
@@ -38,6 +43,7 @@
           }
         },
         "summary": "Update a Message",
+        "operationId": "Update a Message",
         "description": "",
         "tags": [
           "Messages"

package/test/output/06. Requests.json

@@ -11,7 +11,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "X-My-Message-Header": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/json": {
                 "message": "Hello World!"
@@ -20,15 +24,16 @@
           }
         },
         "summary": "Retrieve a Message",
+        "operationId": "Retrieve a Message",
         "description": "In API Blueprint requests can hold exactly the same kind of information and can be described by exactly the same structure as responses, only with different signature – using the `Request` keyword. The string that follows after the `Request` keyword is a request identifier. Again, using an explanatory and simple naming is the best way to go.",
         "tags": [
           "Messages"
         ],
         "parameters": [
           {
-            "description": "e.g. text/plain",
-            "in": "header",
             "name": "Accept",
+            "in": "header",
+            "description": "e.g. text/plain",
             "required": false,
             "x-example": "text/plain",
             "type": "string"
@@ -47,6 +52,7 @@
           }
         },
         "summary": "Update a Message",
+        "operationId": "Update a Message",
         "description": "",
         "tags": [
           "Messages"

package/test/output/06. Requests.ref.json

@@ -11,7 +11,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "X-My-Message-Header": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/json": {
                 "message": "Hello World!"
@@ -20,15 +24,16 @@
           }
         },
         "summary": "Retrieve a Message",
+        "operationId": "Retrieve a Message",
         "description": "In API Blueprint requests can hold exactly the same kind of information and can be described by exactly the same structure as responses, only with different signature – using the `Request` keyword. The string that follows after the `Request` keyword is a request identifier. Again, using an explanatory and simple naming is the best way to go.",
         "tags": [
           "Messages"
         ],
         "parameters": [
           {
-            "description": "e.g. text/plain",
-            "in": "header",
             "name": "Accept",
+            "in": "header",
+            "description": "e.g. text/plain",
             "required": false,
             "x-example": "text/plain",
             "type": "string"
@@ -47,6 +52,7 @@
           }
         },
         "summary": "Update a Message",
+        "operationId": "Update a Message",
         "description": "",
         "tags": [
           "Messages"

package/test/output/07. Parameters.json

@@ -11,7 +11,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "X-My-Message-Header": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/json": {
                 "id": 1,
@@ -21,6 +25,7 @@
           }
         },
         "summary": "Retrieve a Message",
+        "operationId": "Retrieve a Message",
         "description": "",
         "tags": [
           "Messages"
@@ -35,12 +40,12 @@
             "type": "number"
           },
           {
-            "description": "e.g. text/plain",
-            "in": "header",
             "name": "Accept",
+            "in": "header",
+            "description": "e.g. text/plain",
             "required": false,
-            "type": "string",
-            "x-example": "text/plain"
+            "x-example": "text/plain",
+            "type": "string"
           }
         ],
         "produces": [
@@ -56,6 +61,7 @@
           }
         },
         "summary": "Update a Message",
+        "operationId": "Update a Message",
         "description": "",
         "tags": [
           "Messages"
@@ -112,6 +118,7 @@
           }
         },
         "summary": "Retrieve all Messages",
+        "operationId": "Retrieve all Messages",
         "description": "",
         "tags": [
           "Messages"

package/test/output/07. Parameters.ref.json

@@ -11,7 +11,11 @@
         "responses": {
           "200": {
             "description": "OK",
-            "headers": {},
+            "headers": {
+              "X-My-Message-Header": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/json": {
                 "id": 1,
@@ -21,6 +25,7 @@
           }
         },
         "summary": "Retrieve a Message",
+        "operationId": "Retrieve a Message",
         "description": "",
         "tags": [
           "Messages"
@@ -35,12 +40,12 @@
             "type": "number"
           },
           {
-            "description": "e.g. text/plain",
-            "in": "header",
             "name": "Accept",
+            "in": "header",
+            "description": "e.g. text/plain",
             "required": false,
-            "type": "string",
-            "x-example": "text/plain"
+            "x-example": "text/plain",
+            "type": "string"
           }
         ],
         "produces": [
@@ -56,6 +61,7 @@
           }
         },
         "summary": "Update a Message",
+        "operationId": "Update a Message",
         "description": "",
         "tags": [
           "Messages"
@@ -112,6 +118,7 @@
           }
         },
         "summary": "Retrieve all Messages",
+        "operationId": "Retrieve all Messages",
         "description": "",
         "tags": [
           "Messages"

package/test/output/08. Attributes.json

@@ -36,6 +36,7 @@
           }
         },
         "summary": "Retrieve a Coupon",
+        "operationId": "Retrieve a Coupon",
         "description": "Retrieves the coupon with the given ID.",
         "tags": [
           "Coupons"

package/test/output/08. Attributes.ref.json

@@ -36,6 +36,7 @@
           }
         },
         "summary": "Retrieve a Coupon",
+        "operationId": "Retrieve a Coupon",
         "description": "Retrieves the coupon with the given ID.",
         "tags": [
           "Coupons"

package/test/output/09. Advanced Attributes.json

@@ -43,6 +43,7 @@
           }
         },
         "summary": "Retrieve a Coupon",
+        "operationId": "Retrieve a Coupon",
         "description": "Retrieves the coupon with the given ID.",
         "tags": [
           "Coupons"
@@ -84,6 +85,7 @@
           }
         },
         "summary": "List all Coupons",
+        "operationId": "List all Coupons",
         "description": "Returns a list of your coupons.",
         "tags": [
           "Coupons"
@@ -138,6 +140,7 @@
           }
         },
         "summary": "Create a Coupon",
+        "operationId": "Create a Coupon",
         "description": "Creates a new Coupon.",
         "tags": [
           "Coupons"

package/test/output/09. Advanced Attributes.ref.json

@@ -26,6 +26,7 @@
           }
         },
         "summary": "Retrieve a Coupon",
+        "operationId": "Retrieve a Coupon",
         "description": "Retrieves the coupon with the given ID.",
         "tags": [
           "Coupons"
@@ -66,6 +67,7 @@
           }
         },
         "summary": "List all Coupons",
+        "operationId": "List all Coupons",
         "description": "Returns a list of your coupons.",
         "tags": [
           "Coupons"
@@ -103,6 +105,7 @@
           }
         },
         "summary": "Create a Coupon",
+        "operationId": "Create a Coupon",
         "description": "Creates a new Coupon.",
         "tags": [
           "Coupons"

package/test/output/10. Data Structures.json

@@ -43,6 +43,7 @@
           }
         },
         "summary": "Retrieve a Coupon",
+        "operationId": "Retrieve a Coupon",
         "description": "Retrieves the coupon with the given ID.",
         "tags": [
           "Coupons"
@@ -84,6 +85,7 @@
           }
         },
         "summary": "List all Coupons",
+        "operationId": "List all Coupons",
         "description": "Returns a list of your coupons.",
         "tags": [
           "Coupons"
@@ -138,6 +140,7 @@
           }
         },
         "summary": "Create a Coupon",
+        "operationId": "Create a Coupon",
         "description": "Creates a new Coupon.",
         "tags": [
           "Coupons"

package/test/output/10. Data Structures.ref.json

@@ -26,6 +26,7 @@
           }
         },
         "summary": "Retrieve a Coupon",
+        "operationId": "Retrieve a Coupon",
         "description": "Retrieves the coupon with the given ID.",
         "tags": [
           "Coupons"
@@ -66,6 +67,7 @@
           }
         },
         "summary": "List all Coupons",
+        "operationId": "List all Coupons",
         "description": "Returns a list of your coupons.",
         "tags": [
           "Coupons"
@@ -103,6 +105,7 @@
           }
         },
         "summary": "Create a Coupon",
+        "operationId": "Create a Coupon",
         "description": "Creates a new Coupon.",
         "tags": [
           "Coupons"

package/test/output/11. Resource Model.json

@@ -11,7 +11,11 @@
         "responses": {
           "200": {
             "description": "This is the `application/vnd.siren+json` message resource representation.",
-            "headers": {},
+            "headers": {
+              "Location": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/vnd.siren+json": {
                 "class": [
@@ -34,6 +38,7 @@
           }
         },
         "summary": "Retrieve a Message",
+        "operationId": "Retrieve a Message",
         "description": "At this point we will utilize our `Message` resource model and reference it in `Response 200`.",
         "tags": [
           "Messages"
@@ -52,6 +57,7 @@
           }
         },
         "summary": "Update a Message",
+        "operationId": "Update a Message",
         "description": "",
         "tags": [
           "Messages"

package/test/output/11. Resource Model.ref.json

@@ -11,7 +11,11 @@
         "responses": {
           "200": {
             "description": "This is the `application/vnd.siren+json` message resource representation.",
-            "headers": {},
+            "headers": {
+              "Location": {
+                "type": "string"
+              }
+            },
             "examples": {
               "application/vnd.siren+json": {
                 "class": [
@@ -34,6 +38,7 @@
           }
         },
         "summary": "Retrieve a Message",
+        "operationId": "Retrieve a Message",
         "description": "At this point we will utilize our `Message` resource model and reference it in `Response 200`.",
         "tags": [
           "Messages"
@@ -52,6 +57,7 @@
           }
         },
         "summary": "Update a Message",
+        "operationId": "Update a Message",
         "description": "",
         "tags": [
           "Messages"

package/test/output/12. Advanced Action.json

@@ -31,6 +31,7 @@
           }
         },
         "summary": "List All Tasks",
+        "operationId": "List All Tasks",
         "description": "",
         "tags": [],
         "parameters": [
@@ -71,6 +72,7 @@
           }
         },
         "summary": "Retrieve Task",
+        "operationId": "Retrieve Task",
         "description": "This is a state transition to another resource",
         "tags": [],
         "parameters": [
@@ -95,6 +97,7 @@
           }
         },
         "summary": "Delete Task",
+        "operationId": "Delete Task",
         "description": "",
         "tags": [],
         "parameters": [

package/test/output/12. Advanced Action.ref.json

@@ -31,6 +31,7 @@
           }
         },
         "summary": "List All Tasks",
+        "operationId": "List All Tasks",
         "description": "",
         "tags": [],
         "parameters": [
@@ -71,6 +72,7 @@
           }
         },
         "summary": "Retrieve Task",
+        "operationId": "Retrieve Task",
         "description": "This is a state transition to another resource",
         "tags": [],
         "parameters": [
@@ -95,6 +97,7 @@
           }
         },
         "summary": "Delete Task",
+        "operationId": "Delete Task",
         "description": "",
         "tags": [],
         "parameters": [

package/test/output/13. Named Endpoints.json

@@ -11,11 +11,16 @@
         "responses": {
           "201": {
             "description": "Created",
-            "headers": {},
+            "headers": {
+              "Location": {
+                "type": "string"
+              }
+            },
             "examples": {}
           }
         },
         "summary": "Create message",
+        "operationId": "Create message",
         "description": "Start out by creating a message for the world to see.",
         "tags": [
           "Quick start"
@@ -44,11 +49,16 @@
         "responses": {
           "201": {
             "description": "Created",
-            "headers": {},
+            "headers": {
+              "Location": {
+                "type": "string"
+              }
+            },
             "examples": {}
           }
         },
         "summary": "Create a new task",
+        "operationId": "Create a new task",
         "description": "Now create a task that you need to do at a later date.",
         "tags": [
           "Quick start"

package/test/output/13. Named Endpoints.ref.json

@@ -11,11 +11,16 @@
         "responses": {
           "201": {
             "description": "Created",
-            "headers": {},
+            "headers": {
+              "Location": {
+                "type": "string"
+              }
+            },
             "examples": {}
           }
         },
         "summary": "Create message",
+        "operationId": "Create message",
         "description": "Start out by creating a message for the world to see.",
         "tags": [
           "Quick start"
@@ -44,11 +49,16 @@
         "responses": {
           "201": {
             "description": "Created",
-            "headers": {},
+            "headers": {
+              "Location": {
+                "type": "string"
+              }
+            },
             "examples": {}
           }
         },
         "summary": "Create a new task",
+        "operationId": "Create a new task",
         "description": "Now create a task that you need to do at a later date.",
         "tags": [
           "Quick start"

package/test/output/Attributes.json

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