nestia 3.1.0 → 3.1.1-dev.20221016

package/demo/generic/swagger.json

@@ -0,0 +1,736 @@
+{
+  "openapi": "3.0.1",
+  "servers": [
+    {
+      "url": "https://github.com/samchon/nestia",
+      "description": "insert your server url"
+    }
+  ],
+  "info": {
+    "version": "0.1.0",
+    "title": "Generated by nestia - https://github.com/samchon/nestia"
+  },
+  "paths": {
+    "/consumers/{section}/sales/{saleId}/questions": {
+      "post": {
+        "tags": [],
+        "parameters": [
+          {
+            "name": "section",
+            "in": "path",
+            "description": "Code of the target section",
+            "schema": {
+              "type": "string",
+              "nullable": false
+            },
+            "required": true
+          },
+          {
+            "name": "saleId",
+            "in": "path",
+            "description": "ID of the target sale",
+            "schema": {
+              "type": "string",
+              "nullable": false
+            },
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "description": "Content to archive",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ISaleArticle.IStore"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Newly archived inquiry",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ISaleInquiry_lt_ISaleArticle.IContent_gt_"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "bad request error when type of the input data is not valid"
+          },
+          "401": {
+            "description": "unauthorized error when you've not logged in yet"
+          }
+        },
+        "description": "Store a new inquiry.\n\nWrite a new article inquirying about a sale."
+      }
+    },
+    "/consumers/{section}/sales/{saleId}/questions/{id}": {
+      "put": {
+        "tags": [],
+        "parameters": [
+          {
+            "name": "section",
+            "in": "path",
+            "description": "Code of the target section",
+            "schema": {
+              "type": "string",
+              "nullable": false
+            },
+            "required": true
+          },
+          {
+            "name": "saleId",
+            "in": "path",
+            "description": "ID of the target sale",
+            "schema": {
+              "type": "string",
+              "nullable": false
+            },
+            "required": true
+          },
+          {
+            "name": "id",
+            "in": "path",
+            "description": "ID of the target article to be updated",
+            "schema": {
+              "type": "number",
+              "nullable": false
+            },
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "description": "New content to be overwritten",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ISaleArticle.IStore"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "The newly created content record",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ISaleInquiry_lt_ISaleArticle.IContent_gt_"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "bad request error when type of the input data is not valid"
+          },
+          "401": {
+            "description": "unauthorized error when you've not logged in yet"
+          },
+          "403": {
+            "description": "forbidden error when the article is not yours"
+          }
+        },
+        "description": "Update an inquiry.\n\nUpdate ordinary inquiry article. However, it would not modify the content reocrd\n{@link ISaleInquiry.IContent}, but be accumulated into the {@link ISaleInquiry.contents}.\nTherefore, all of the poeple can read how the content has been changed."
+      }
+    },
+    "/consumers/{section}/sales/{saleId}/reviews": {
+      "post": {
+        "tags": [],
+        "parameters": [
+          {
+            "name": "section",
+            "in": "path",
+            "description": "Code of the target section",
+            "schema": {
+              "type": "string",
+              "nullable": false
+            },
+            "required": true
+          },
+          {
+            "name": "saleId",
+            "in": "path",
+            "description": "ID of the target sale",
+            "schema": {
+              "type": "string",
+              "nullable": false
+            },
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "description": "Content to archive",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ISaleReview.IStore"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Newly archived inquiry",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ISaleInquiry_lt_ISaleReview.IContent_gt_"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "bad request error when type of the input data is not valid"
+          },
+          "401": {
+            "description": "unauthorized error when you've not logged in yet"
+          }
+        },
+        "description": "Store a new inquiry.\n\nWrite a new article inquirying about a sale."
+      }
+    },
+    "/consumers/{section}/sales/{saleId}/reviews/{id}": {
+      "put": {
+        "tags": [],
+        "parameters": [
+          {
+            "name": "section",
+            "in": "path",
+            "description": "Code of the target section",
+            "schema": {
+              "type": "string",
+              "nullable": false
+            },
+            "required": true
+          },
+          {
+            "name": "saleId",
+            "in": "path",
+            "description": "ID of the target sale",
+            "schema": {
+              "type": "string",
+              "nullable": false
+            },
+            "required": true
+          },
+          {
+            "name": "id",
+            "in": "path",
+            "description": "ID of the target article to be updated",
+            "schema": {
+              "type": "number",
+              "nullable": false
+            },
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "description": "New content to be overwritten",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ISaleReview.IStore"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "The newly created content record",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ISaleInquiry_lt_ISaleReview.IContent_gt_"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "bad request error when type of the input data is not valid"
+          },
+          "401": {
+            "description": "unauthorized error when you've not logged in yet"
+          },
+          "403": {
+            "description": "forbidden error when the article is not yours"
+          }
+        },
+        "description": "Update an inquiry.\n\nUpdate ordinary inquiry article. However, it would not modify the content reocrd\n{@link ISaleInquiry.IContent}, but be accumulated into the {@link ISaleInquiry.contents}.\nTherefore, all of the poeple can read how the content has been changed."
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "ISaleArticle.IStore": {
+        "type": "object",
+        "properties": {
+          "title": {
+            "type": "string",
+            "nullable": false,
+            "description": "Title of the content."
+          },
+          "body": {
+            "type": "string",
+            "nullable": false,
+            "description": "Body of the content."
+          },
+          "extension": {
+            "type": "string",
+            "enum": [
+              "html",
+              "md",
+              "txt"
+            ],
+            "nullable": false,
+            "description": "Extension, content type (format)."
+          },
+          "files": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/IAttachmentFile",
+              "description": "Attached files."
+            },
+            "nullable": false,
+            "description": "Attached files."
+          }
+        },
+        "nullable": false,
+        "required": [
+          "title",
+          "body",
+          "extension",
+          "files"
+        ],
+        "description": "Store info.",
+        "jsDocTags": []
+      },
+      "IAttachmentFile": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "nullable": false,
+            "description": "Name of the file."
+          },
+          "extension": {
+            "type": "string",
+            "nullable": true,
+            "description": "Extension of the file, but ommitable."
+          },
+          "url": {
+            "type": "string",
+            "nullable": false,
+            "description": "Full URL path of the file."
+          }
+        },
+        "nullable": false,
+        "required": [
+          "name",
+          "extension",
+          "url"
+        ],
+        "description": "Attachemd (physical) file info.",
+        "jsDocTags": [
+          {
+            "name": "author",
+            "text": [
+              {
+                "text": "Jeongho Nam - https://github.com/samchon",
+                "kind": "text"
+              }
+            ]
+          }
+        ]
+      },
+      "ISaleInquiry_lt_ISaleArticle.IContent_gt_": {
+        "type": "object",
+        "properties": {
+          "writer": {
+            "type": "string",
+            "nullable": false,
+            "description": "Name of the writer."
+          },
+          "answer": {
+            "$ref": "#/components/schemas/ISaleArticle_lt_ISaleArticle.IContent_gt_.Nullable",
+            "description": "Formal answer from the seller."
+          },
+          "id": {
+            "type": "number",
+            "nullable": false,
+            "description": "Primary Key."
+          },
+          "hit": {
+            "type": "number",
+            "nullable": false,
+            "description": "Hit count.\n\nHow many consumers had read."
+          },
+          "contents": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ISaleArticle.IContent",
+              "description": "List of contents.\n\nWhen the article writer tries to modify content, it would not modify the article\ncontent but would be accumulated. Therefore, all of the people can read how\nthe content has been changed."
+            },
+            "nullable": false,
+            "description": "List of contents.\n\nWhen the article writer tries to modify content, it would not modify the article\ncontent but would be accumulated. Therefore, all of the people can read how\nthe content has been changed."
+          },
+          "created_at": {
+            "type": "string",
+            "nullable": false,
+            "description": "Creation time."
+          }
+        },
+        "nullable": false,
+        "required": [
+          "writer",
+          "answer",
+          "id",
+          "hit",
+          "contents",
+          "created_at"
+        ],
+        "description": "Inquiry article.\n\nSub-type of article and super-type of question and answer.",
+        "jsDocTags": [
+          {
+            "name": "template",
+            "text": [
+              {
+                "text": "Content",
+                "kind": "typeParameterName"
+              },
+              {
+                "text": " ",
+                "kind": "space"
+              },
+              {
+                "text": "Content type",
+                "kind": "text"
+              }
+            ]
+          },
+          {
+            "name": "author",
+            "text": [
+              {
+                "text": "Jeongho Nam - https://github.com/samchon",
+                "kind": "text"
+              }
+            ]
+          }
+        ]
+      },
+      "ISaleArticle_lt_ISaleArticle.IContent_gt_.Nullable": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "number",
+            "nullable": false,
+            "description": "Primary Key."
+          },
+          "hit": {
+            "type": "number",
+            "nullable": false,
+            "description": "Hit count.\n\nHow many consumers had read."
+          },
+          "contents": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ISaleArticle.IContent",
+              "description": "List of contents.\n\nWhen the article writer tries to modify content, it would not modify the article\ncontent but would be accumulated. Therefore, all of the people can read how\nthe content has been changed."
+            },
+            "nullable": false,
+            "description": "List of contents.\n\nWhen the article writer tries to modify content, it would not modify the article\ncontent but would be accumulated. Therefore, all of the people can read how\nthe content has been changed."
+          },
+          "created_at": {
+            "type": "string",
+            "nullable": false,
+            "description": "Creation time."
+          }
+        },
+        "nullable": true,
+        "required": [
+          "id",
+          "hit",
+          "contents",
+          "created_at"
+        ],
+        "description": "Article about a sale.\n\nThe `ISaleArticle` is a super type interface. Many sub-type articles would be\ndesigned by extending this super type interface `ISaleArticle`.",
+        "jsDocTags": [
+          {
+            "name": "template",
+            "text": [
+              {
+                "text": "Content",
+                "kind": "typeParameterName"
+              },
+              {
+                "text": " ",
+                "kind": "space"
+              },
+              {
+                "text": "Content type.",
+                "kind": "text"
+              }
+            ]
+          },
+          {
+            "name": "author",
+            "text": [
+              {
+                "text": "Jeongho Nam - https://github.com/samchon",
+                "kind": "text"
+              }
+            ]
+          }
+        ]
+      },
+      "ISaleArticle.IContent": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "nullable": false,
+            "description": "Primary Key"
+          },
+          "created_at": {
+            "type": "string",
+            "nullable": false,
+            "description": "Creation time."
+          },
+          "title": {
+            "type": "string",
+            "nullable": false,
+            "description": "Title of the content."
+          },
+          "body": {
+            "type": "string",
+            "nullable": false,
+            "description": "Body of the content."
+          },
+          "extension": {
+            "type": "string",
+            "enum": [
+              "html",
+              "md",
+              "txt"
+            ],
+            "nullable": false,
+            "description": "Extension, content type (format)."
+          },
+          "files": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/IAttachmentFile",
+              "description": "Attached files."
+            },
+            "nullable": false,
+            "description": "Attached files."
+          }
+        },
+        "nullable": false,
+        "required": [
+          "id",
+          "created_at",
+          "title",
+          "body",
+          "extension",
+          "files"
+        ],
+        "description": "Content info.",
+        "jsDocTags": []
+      },
+      "ISaleReview.IStore": {
+        "type": "object",
+        "properties": {
+          "score": {
+            "type": "number",
+            "nullable": false,
+            "description": "Estimation score."
+          },
+          "title": {
+            "type": "string",
+            "nullable": false,
+            "description": "Title of the content."
+          },
+          "body": {
+            "type": "string",
+            "nullable": false,
+            "description": "Body of the content."
+          },
+          "extension": {
+            "type": "string",
+            "enum": [
+              "html",
+              "md",
+              "txt"
+            ],
+            "nullable": false,
+            "description": "Extension, content type (format)."
+          },
+          "files": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/IAttachmentFile",
+              "description": "Attached files."
+            },
+            "nullable": false,
+            "description": "Attached files."
+          }
+        },
+        "nullable": false,
+        "required": [
+          "score",
+          "title",
+          "body",
+          "extension",
+          "files"
+        ],
+        "description": "Store info of the review.",
+        "jsDocTags": []
+      },
+      "ISaleInquiry_lt_ISaleReview.IContent_gt_": {
+        "type": "object",
+        "properties": {
+          "writer": {
+            "type": "string",
+            "nullable": false,
+            "description": "Name of the writer."
+          },
+          "answer": {
+            "$ref": "#/components/schemas/ISaleArticle_lt_ISaleArticle.IContent_gt_.Nullable",
+            "description": "Formal answer from the seller."
+          },
+          "id": {
+            "type": "number",
+            "nullable": false,
+            "description": "Primary Key."
+          },
+          "hit": {
+            "type": "number",
+            "nullable": false,
+            "description": "Hit count.\n\nHow many consumers had read."
+          },
+          "contents": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ISaleReview.IContent",
+              "description": "List of contents.\n\nWhen the article writer tries to modify content, it would not modify the article\ncontent but would be accumulated. Therefore, all of the people can read how\nthe content has been changed."
+            },
+            "nullable": false,
+            "description": "List of contents.\n\nWhen the article writer tries to modify content, it would not modify the article\ncontent but would be accumulated. Therefore, all of the people can read how\nthe content has been changed."
+          },
+          "created_at": {
+            "type": "string",
+            "nullable": false,
+            "description": "Creation time."
+          }
+        },
+        "nullable": false,
+        "required": [
+          "writer",
+          "answer",
+          "id",
+          "hit",
+          "contents",
+          "created_at"
+        ],
+        "description": "Inquiry article.\n\nSub-type of article and super-type of question and answer.",
+        "jsDocTags": [
+          {
+            "name": "template",
+            "text": [
+              {
+                "text": "Content",
+                "kind": "typeParameterName"
+              },
+              {
+                "text": " ",
+                "kind": "space"
+              },
+              {
+                "text": "Content type",
+                "kind": "text"
+              }
+            ]
+          },
+          {
+            "name": "author",
+            "text": [
+              {
+                "text": "Jeongho Nam - https://github.com/samchon",
+                "kind": "text"
+              }
+            ]
+          }
+        ]
+      },
+      "ISaleReview.IContent": {
+        "type": "object",
+        "properties": {
+          "score": {
+            "type": "number",
+            "nullable": false,
+            "description": "Estimation score."
+          },
+          "id": {
+            "type": "string",
+            "nullable": false,
+            "description": "Primary Key"
+          },
+          "created_at": {
+            "type": "string",
+            "nullable": false,
+            "description": "Creation time."
+          },
+          "title": {
+            "type": "string",
+            "nullable": false,
+            "description": "Title of the content."
+          },
+          "body": {
+            "type": "string",
+            "nullable": false,
+            "description": "Body of the content."
+          },
+          "extension": {
+            "type": "string",
+            "enum": [
+              "html",
+              "md",
+              "txt"
+            ],
+            "nullable": false,
+            "description": "Extension, content type (format)."
+          },
+          "files": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/IAttachmentFile",
+              "description": "Attached files."
+            },
+            "nullable": false,
+            "description": "Attached files."
+          }
+        },
+        "nullable": false,
+        "required": [
+          "score",
+          "id",
+          "created_at",
+          "title",
+          "body",
+          "extension",
+          "files"
+        ],
+        "description": "Content info of the review.",
+        "jsDocTags": []
+      }
+    }
+  }
+}