apib2swagger 1.9.2 → 1.13.0

package/test/output/OpenAPI3_responses.json

@@ -0,0 +1,255 @@
+{
+    "openapi": "3.0.3",
+    "info": {
+        "title": "",
+        "version": "1.0.0",
+        "description": ""
+    },
+    "servers": [
+        {
+          "url": "https://www.testhost.com"
+        }
+    ],
+    "paths": {
+        "/some/resource": {
+            "get": {
+                "responses": {
+                    "200": {
+                        "description": "Array schema",
+                        "headers": {
+                            "X-My-Message-Header": {
+                                "schema": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "oneOf": [
+                                        {
+                                            "type": "object",
+                                            "properties": {
+                                                "message": {
+                                                    "type": "string",
+                                                    "description": "This is the message description "
+                                                }
+                                            }
+                                        },
+                                        {
+                                            "type": "object",
+                                            "properties": {
+                                                "other": {
+                                                    "type": "string",
+                                                    "description": "This is the message description "
+                                                }
+                                            }
+                                        },
+                                        {
+                                            "type": "array",
+                                            "items": {
+                                                "type": "object",
+                                                "properties": {
+                                                    "message": {
+                                                        "type": "string",
+                                                        "description": "This is the message description "
+                                                    }
+                                                }
+                                            }
+                                        }
+                                    ]
+                                },
+                                "examples": {
+                                    "example1": {
+                                        "value": {
+                                            "message": "Hello World!"
+                                        }
+                                    },
+                                    "example2": {
+                                        "value": {
+                                            "other": "Hello World!"
+                                        }
+                                    },
+                                    "example3": {
+                                        "value": {
+                                            "other": "Hello World!"
+                                        }
+                                    },
+                                    "example4": {
+                                        "value": [
+                                            {
+                                                "message": "Hello World!"
+                                            }
+                                        ]
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "headers": {},
+                        "content": {
+                            "application/json": {
+                                "example": {
+                                    "message": "Invalid data"
+                                }
+                            }
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": []
+            },
+            "post": {
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "headers": {
+                            "X-My-Message-Header": {
+                                "schema": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "properties": {
+                                        "message": {
+                                            "type": "string",
+                                            "description": "This is the message description "
+                                        }
+                                    }
+                                },
+                                "examples": {
+                                    "example1": {
+                                        "value": {
+                                            "message": "Hello World!"
+                                        }
+                                    },
+                                    "example2": {
+                                        "value": {
+                                            "message": "Hello World!"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": []
+            }
+        },
+        "/test/attributes": {
+            "get": {
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "headers": {},
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "oneOf": [
+                                        {
+                                            "type": "object",
+                                            "properties": {
+                                                "message": {
+                                                    "type": "string"
+                                                }
+                                            }
+                                        },
+                                        {
+                                            "type": "object",
+                                            "properties": {
+                                                "otherMessage": {
+                                                    "type": "string"
+                                                }
+                                            }
+                                        }
+                                    ]
+                                },
+                                "examples": {
+                                    "example1": {
+                                        "value": {
+                                            "message": "Hello World!"
+                                        }
+                                    },
+                                    "example2": {
+                                        "value": {
+                                            "message": "Hello World2"
+                                        }
+                                    },
+                                    "example3": {
+                                        "value": {
+                                            "otherMessage": "Hello World!"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": []
+            }
+        },
+        "/message": {
+            "get": {
+                "responses": {
+                    "200": {
+                        "description": "Unparsable schema should fall back to Attributes",
+                        "headers": {},
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/Message"
+                                },
+                                "example": {
+                                    "message": ""
+                                }
+                            }
+                        }
+                    }
+                },
+                "summary": "Message",
+                "operationId": "Message",
+                "description": "",
+                "tags": [],
+                "parameters": []
+            }
+        }
+    },
+    "components": {
+        "schemas":{
+            "Message": {
+                "type": "object",
+                "properties": {
+                    "message": {
+                        "type": "string"
+                    }
+                }
+            },
+            "OtherMessage": {
+                "type": "object",
+                "properties": {
+                    "otherMessage": {
+                        "type": "string"
+                    }
+                }
+            }
+        }
+    },
+    "tags": []
+}

package/test/output/OpenAPI3_responses.ref.json

@@ -0,0 +1,245 @@
+{
+    "openapi": "3.0.3",
+    "info": {
+        "title": "",
+        "version": "1.0.0",
+        "description": ""
+    },
+    "servers": [
+        {
+          "url": "https://www.testhost.com"
+        }
+    ],
+    "paths": {
+        "/some/resource": {
+            "get": {
+                "responses": {
+                    "200": {
+                        "description": "Array schema",
+                        "headers": {
+                            "X-My-Message-Header": {
+                                "schema": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "oneOf": [
+                                        {
+                                            "type": "object",
+                                            "properties": {
+                                                "message": {
+                                                    "type": "string",
+                                                    "description": "This is the message description "
+                                                }
+                                            }
+                                        },
+                                        {
+                                            "type": "object",
+                                            "properties": {
+                                                "other": {
+                                                    "type": "string",
+                                                    "description": "This is the message description "
+                                                }
+                                            }
+                                        },
+                                        {
+                                            "type": "array",
+                                            "items": {
+                                                "type": "object",
+                                                "properties": {
+                                                    "message": {
+                                                        "type": "string",
+                                                        "description": "This is the message description "
+                                                    }
+                                                }
+                                            }
+                                        }
+                                    ]
+                                },
+                                "examples": {
+                                    "example1": {
+                                        "value": {
+                                            "message": "Hello World!"
+                                        }
+                                    },
+                                    "example2": {
+                                        "value": {
+                                            "other": "Hello World!"
+                                        }
+                                    },
+                                    "example3": {
+                                        "value": {
+                                            "other": "Hello World!"
+                                        }
+                                    },
+                                    "example4": {
+                                        "value": [
+                                            {
+                                                "message": "Hello World!"
+                                            }
+                                        ]
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "headers": {},
+                        "content": {
+                            "application/json": {
+                                "example": {
+                                    "message": "Invalid data"
+                                }
+                            }
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": []
+            },
+            "post": {
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "headers": {
+                            "X-My-Message-Header": {
+                                "schema": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "properties": {
+                                        "message": {
+                                            "type": "string",
+                                            "description": "This is the message description "
+                                        }
+                                    }
+                                },
+                                "examples": {
+                                    "example1": {
+                                        "value": {
+                                            "message": "Hello World!"
+                                        }
+                                    },
+                                    "example2": {
+                                        "value": {
+                                            "message": "Hello World!"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": []
+            }
+        },
+        "/test/attributes": {
+            "get": {
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "headers": {},
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "oneOf": [
+                                        {
+                                            "$ref": "#/components/schemas/Message"
+                                        },
+                                        {
+                                            "$ref": "#/components/schemas/OtherMessage"
+                                        }
+                                    ]
+                                },
+                                "examples": {
+                                    "example1": {
+                                        "value": {
+                                            "message": "Hello World!"
+                                        }
+                                    },
+                                    "example2": {
+                                        "value": {
+                                            "message": "Hello World2"
+                                        }
+                                    },
+                                    "example3": {
+                                        "value": {
+                                            "otherMessage": "Hello World!"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": []
+            }
+        },
+        "/message": {
+            "get": {
+                "responses": {
+                    "200": {
+                        "description": "Unparsable schema should fall back to Attributes",
+                        "headers": {},
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/Message"
+                                },
+                                "example": {
+                                    "message": ""
+                                }
+                            }
+                        }
+                    }
+                },
+                "summary": "Message",
+                "operationId": "Message",
+                "description": "",
+                "tags": [],
+                "parameters": []
+            }
+        }
+    },
+    "components": {
+        "schemas":{
+            "Message": {
+                "type": "object",
+                "properties": {
+                    "message": {
+                        "type": "string"
+                    }
+                }
+            },
+            "OtherMessage": {
+                "type": "object",
+                "properties": {
+                    "otherMessage": {
+                        "type": "string"
+                    }
+                }
+            }
+        }
+    },
+    "tags": []
+}

package/test/output/Schema.json

@@ -24,6 +24,7 @@
           }
         },
         "summary": "Some resource",
+        "operationId": "Some resource",
         "description": "",
         "tags": [],
         "parameters": [
@@ -66,6 +67,7 @@
           }
         },
         "summary": "",
+        "operationId": "",
         "description": "",
         "tags": [],
         "parameters": [
@@ -101,6 +103,7 @@
           }
         },
         "summary": "",
+        "operationId": "",
         "description": "",
         "tags": [],
         "parameters": [

package/test/output/Schema.ref.json

@@ -24,6 +24,7 @@
           }
         },
         "summary": "Some resource",
+        "operationId": "Some resource",
         "description": "",
         "tags": [],
         "parameters": [
@@ -61,6 +62,7 @@
           }
         },
         "summary": "",
+        "operationId": "",
         "description": "",
         "tags": [],
         "parameters": [
@@ -96,6 +98,7 @@
           }
         },
         "summary": "",
+        "operationId": "",
         "description": "",
         "tags": [],
         "parameters": [

package/test/output/apiblueprint_uber.json

@@ -44,6 +44,7 @@
           }
         },
         "summary": "Product Types",
+        "operationId": "Product Types",
         "description": "The Products endpoint returns information about the *Uber* products\noffered at a given location. The response includes the display name\nand other details about each product, and lists the products in the\nproper display order.",
         "tags": [
           "Products"
@@ -116,6 +117,7 @@
           }
         },
         "summary": "Price Estimates",
+        "operationId": "Price Estimates",
         "description": "The Price Estimates endpoint returns an estimated price range\nfor each product offered at a given location. The price estimate is\nprovided as a formatted string with the full price range and the localized\ncurrency symbol.<br><br>The response also includes low and high estimates,\nand the [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for\nsituations requiring currency conversion. When surge is active for a particular\nproduct, its surge_multiplier will be greater than 1, but the price estimate\nalready factors in this multiplier.",
         "tags": [
           "Estimates"
@@ -198,6 +200,7 @@
           }
         },
         "summary": "Time Estimates",
+        "operationId": "Time Estimates",
         "description": "The Time Estimates endpoint returns ETAs for all products offered at a given location, with the responses expressed as integers in seconds. We recommend that this endpoint be called every minute to provide the most accurate, up-to-date ETAs.",
         "tags": [
           "Estimates"
@@ -277,6 +280,7 @@
           }
         },
         "summary": "User Profile",
+        "operationId": "User Profile",
         "description": "The User Profile endpoint returns information about the Uber user that has authorized with the application.",
         "tags": [
           "User"
@@ -326,6 +330,7 @@
           }
         },
         "summary": "User Activity",
+        "operationId": "User Activity",
         "description": "The User Activity endpoint returns data about a user's lifetime activity with Uber. The response will include pickup locations and times, dropoff locations and times, the distance of past requests, and information about which products were requested.<br><br>The history array in the response will have a maximum length based on the limit parameter. The response value count may exceed limit, therefore subsequent API requests may be necessary.",
         "tags": [
           "User"

package/test/output/apiblueprint_uber.ref.json

@@ -44,6 +44,7 @@
           }
         },
         "summary": "Product Types",
+        "operationId": "Product Types",
         "description": "The Products endpoint returns information about the *Uber* products\noffered at a given location. The response includes the display name\nand other details about each product, and lists the products in the\nproper display order.",
         "tags": [
           "Products"
@@ -116,6 +117,7 @@
           }
         },
         "summary": "Price Estimates",
+        "operationId": "Price Estimates",
         "description": "The Price Estimates endpoint returns an estimated price range\nfor each product offered at a given location. The price estimate is\nprovided as a formatted string with the full price range and the localized\ncurrency symbol.<br><br>The response also includes low and high estimates,\nand the [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for\nsituations requiring currency conversion. When surge is active for a particular\nproduct, its surge_multiplier will be greater than 1, but the price estimate\nalready factors in this multiplier.",
         "tags": [
           "Estimates"
@@ -198,6 +200,7 @@
           }
         },
         "summary": "Time Estimates",
+        "operationId": "Time Estimates",
         "description": "The Time Estimates endpoint returns ETAs for all products offered at a given location, with the responses expressed as integers in seconds. We recommend that this endpoint be called every minute to provide the most accurate, up-to-date ETAs.",
         "tags": [
           "Estimates"
@@ -277,6 +280,7 @@
           }
         },
         "summary": "User Profile",
+        "operationId": "User Profile",
         "description": "The User Profile endpoint returns information about the Uber user that has authorized with the application.",
         "tags": [
           "User"
@@ -326,6 +330,7 @@
           }
         },
         "summary": "User Activity",
+        "operationId": "User Activity",
         "description": "The User Activity endpoint returns data about a user's lifetime activity with Uber. The response will include pickup locations and times, dropoff locations and times, the distance of past requests, and information about which products were requested.<br><br>The history array in the response will have a maximum length based on the limit parameter. The response value count may exceed limit, therefore subsequent API requests may be necessary.",
         "tags": [
           "User"