@xyd-js/openapi 0.1.0-build.168

package/__fixtures__/2.more/input.yaml

@@ -0,0 +1,76 @@
+openapi: 3.0.0
+paths:
+  /users:
+    get:
+      summary: Returns a list of users
+      description: Optional extended description in CommonMark or HTML.
+      responses:
+        '200':
+          description: A JSON array of users
+          content:
+            application/json:
+              schema:
+                # Response
+#                $ref: '#/components/schemas/User'
+                # Response & User
+#                allOf:
+#                  - $ref: '#/components/schemas/Response'
+#                  - $ref: '#/components/schemas/User'
+#                # Response | User
+#                anyOf:
+#                  - $ref: '#/components/schemas/Response'
+#                  - $ref: '#/components/schemas/User'
+#                # Response ^ User
+#                oneOf:
+#                  - $ref: '#/components/schemas/Response'
+#                  - $ref: '#/components/schemas/User'
+
+
+                type: array
+                items:
+                  # Response
+#                  $ref: '#/components/schemas/User'
+#                  # Response & User
+                  allOf:
+                    - $ref: '#/components/schemas/Response'
+                    - $ref: '#/components/schemas/User'
+#                  # Response | User
+#                  anyOf:
+#                    - $ref: '#/components/schemas/Response'
+#                    - $ref: '#/components/schemas/User'
+#                  # Response ^ User
+#                  oneOf:
+#                    - $ref: '#/components/schemas/Response'
+#                    - $ref: '#/components/schemas/User'
+
+components:
+  schemas:
+    Response:
+      type: object
+      title: "Hello Response"
+      properties:
+        message:
+          type: string
+    User:
+      type: object
+      required:
+        - id
+        - username
+      properties:
+        id:
+          type: integer
+          format: int64
+        username:
+          type: string
+        email:
+          type: string
+          format: email
+        status:
+          type: string
+          enum: [ active, inactive ]
+        createdAt:
+          type: string
+          format: date-time
+        updatedAt:
+          type: string
+          format: date-time

package/__fixtures__/2.more/output.json

@@ -0,0 +1,327 @@
+[
+  {
+    "title": "Returns a list of users",
+    "canonical": "returns-a-list-of-users",
+    "description": "Optional extended description in CommonMark or HTML.",
+    "type": "rest_get",
+    "category": "rest",
+    "context": {
+      "method": "get",
+      "path": "/users",
+      "fullPath": "/users",
+      "group": [
+        ""
+      ],
+      "scopes": []
+    },
+    "examples": {
+      "groups": [
+        {
+          "description": "Example request",
+          "examples": [
+            {
+              "codeblock": {
+                "tabs": [
+                  {
+                    "title": "shell",
+                    "language": "shell",
+                    "code": "curl --request  \\\n     --url https://example.com/ \\\n     --header 'accept: application/json'"
+                  },
+                  {
+                    "title": "javascript",
+                    "language": "javascript",
+                    "code": "const options = {method: '', headers: {accept: 'application/json'}};\n\nfetch('https://example.com/', options)\n  .then(res => res.json())\n  .then(res => console.log(res))\n  .catch(err => console.error(err));"
+                  },
+                  {
+                    "title": "python",
+                    "language": "python",
+                    "code": "import requests\n\nurl = \"https://example.com/\"\n\nheaders = {\"accept\": \"application/json\"}\n\nresponse = requests.request(\"\", url, headers=headers)\n\nprint(response.text)"
+                  },
+                  {
+                    "title": "go",
+                    "language": "go",
+                    "code": "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io\"\n)\n\nfunc main() {\n\n\turl := \"https://example.com/\"\n\n\treq, _ := http.NewRequest(\"\", url, nil)\n\n\treq.Header.Add(\"accept\", \"application/json\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := io.ReadAll(res.Body)\n\n\tfmt.Println(string(body))\n\n}"
+                  }
+                ]
+              }
+            }
+          ]
+        },
+        {
+          "description": "Example response",
+          "examples": [
+            {
+              "codeblock": {
+                "title": "200",
+                "tabs": [
+                  {
+                    "title": "application/json",
+                    "language": "json",
+                    "code": "[\n  {\n    \"message\": \"string\",\n    \"id\": 0,\n    \"username\": \"string\",\n    \"email\": \"user@example.com\",\n    \"status\": \"active\",\n    \"createdAt\": \"2019-08-24T14:15:22Z\",\n    \"updatedAt\": \"2019-08-24T14:15:22Z\"\n  }\n]"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      ]
+    },
+    "definitions": [
+      {
+        "title": "Response",
+        "variants": [
+          {
+            "title": "200",
+            "description": "A JSON array of users",
+            "properties": [],
+            "rootProperty": {
+              "type": "$$array",
+              "properties": [
+                {
+                  "name": "message",
+                  "type": "string",
+                  "description": "",
+                  "meta": []
+                },
+                {
+                  "name": "id",
+                  "type": "integer",
+                  "description": "",
+                  "meta": [
+                    {
+                      "name": "required",
+                      "value": "true"
+                    }
+                  ]
+                },
+                {
+                  "name": "username",
+                  "type": "string",
+                  "description": "",
+                  "meta": [
+                    {
+                      "name": "required",
+                      "value": "true"
+                    }
+                  ]
+                },
+                {
+                  "name": "email",
+                  "type": "string",
+                  "description": "",
+                  "meta": []
+                },
+                {
+                  "name": "status",
+                  "type": "$$enum",
+                  "description": "",
+                  "meta": [
+                    {
+                      "name": "enum-type",
+                      "value": "string"
+                    }
+                  ],
+                  "properties": [
+                    {
+                      "name": "active",
+                      "type": "string",
+                      "description": "",
+                      "meta": []
+                    },
+                    {
+                      "name": "inactive",
+                      "type": "string",
+                      "description": "",
+                      "meta": []
+                    }
+                  ]
+                },
+                {
+                  "name": "createdAt",
+                  "type": "string",
+                  "description": "",
+                  "meta": []
+                },
+                {
+                  "name": "updatedAt",
+                  "type": "string",
+                  "description": "",
+                  "meta": []
+                }
+              ]
+            },
+            "meta": [
+              {
+                "name": "status",
+                "value": "200"
+              },
+              {
+                "name": "contentType",
+                "value": "application/json"
+              },
+              {
+                "name": "definitionDescription",
+                "value": ""
+              }
+            ],
+            "symbolDef": {
+              "id": []
+            }
+          }
+        ],
+        "properties": []
+      }
+    ]
+  },
+  {
+    "title": "Response",
+    "description": "",
+    "canonical": "objects/Response",
+    "definitions": [
+      {
+        "title": "Response",
+        "properties": [
+          {
+            "name": "message",
+            "type": "string",
+            "description": "",
+            "meta": []
+          }
+        ],
+        "meta": []
+      }
+    ],
+    "examples": {
+      "groups": [
+        {
+          "description": "Example",
+          "examples": [
+            {
+              "codeblock": {
+                "tabs": [
+                  {
+                    "title": "json",
+                    "language": "json",
+                    "code": "{\n  \"message\": \"\"\n}"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      ]
+    },
+    "type": "rest_component_schema",
+    "context": {
+      "componentSchema": "Response",
+      "group": [
+        "Objects"
+      ]
+    }
+  },
+  {
+    "title": "User",
+    "description": "",
+    "canonical": "objects/User",
+    "definitions": [
+      {
+        "title": "User",
+        "properties": [
+          {
+            "name": "id",
+            "type": "integer",
+            "description": "",
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ]
+          },
+          {
+            "name": "username",
+            "type": "string",
+            "description": "",
+            "meta": [
+              {
+                "name": "required",
+                "value": "true"
+              }
+            ]
+          },
+          {
+            "name": "email",
+            "type": "string",
+            "description": "",
+            "meta": []
+          },
+          {
+            "name": "status",
+            "type": "$$enum",
+            "description": "",
+            "meta": [
+              {
+                "name": "enum-type",
+                "value": "string"
+              }
+            ],
+            "properties": [
+              {
+                "name": "active",
+                "type": "string",
+                "description": "",
+                "meta": []
+              },
+              {
+                "name": "inactive",
+                "type": "string",
+                "description": "",
+                "meta": []
+              }
+            ]
+          },
+          {
+            "name": "createdAt",
+            "type": "string",
+            "description": "",
+            "meta": []
+          },
+          {
+            "name": "updatedAt",
+            "type": "string",
+            "description": "",
+            "meta": []
+          }
+        ],
+        "meta": []
+      }
+    ],
+    "examples": {
+      "groups": [
+        {
+          "description": "Example",
+          "examples": [
+            {
+              "codeblock": {
+                "tabs": [
+                  {
+                    "title": "json",
+                    "language": "json",
+                    "code": "{\n  \"id\": 0,\n  \"username\": \"\",\n  \"email\": \"\",\n  \"status\": \"\",\n  \"createdAt\": \"\",\n  \"updatedAt\": \"\"\n}"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      ]
+    },
+    "type": "rest_component_schema",
+    "context": {
+      "componentSchema": "User",
+      "group": [
+        "Objects"
+      ]
+    }
+  }
+]

package/__fixtures__/3.multiple-responses/input.yaml

@@ -0,0 +1,48 @@
+openapi: 3.0.0
+paths:
+  /response:
+    get:
+      summary: Returns a response
+      description: Returns a response or a stream of responses
+      responses:
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Response"
+            text/event-stream:
+              schema:
+                $ref: "#/components/schemas/ResponseStream"
+
+components:
+  schemas:
+    ErrorResponse:
+      type: object
+      title: "ErrorResponse"
+      properties:
+        message:
+          type: string
+
+    Response:
+      type: object
+      title: "Hello Response"
+      properties:
+        message:
+          type: string
+
+    ResponseStream:
+      type: object
+      title: "Hello ResponseStream"
+      properties:
+        message:
+          type: string
+
+