From e38a1f9c1a22d107ba3f320ad913121a96d5e754 Mon Sep 17 00:00:00 2001 From: nxglabs Date: Thu, 18 Jan 2024 21:09:10 +0530 Subject: [PATCH] add help docs --- docs/docs/API-docs/add-pet.api.mdx | 2 +- docs/docs/API-docs/create-user.api.mdx | 637 ------------------ docs/docs/API-docs/createtemplate.api.mdx | 242 +++++++ docs/docs/API-docs/delete-pet.api.mdx | 6 +- ...-order.api.mdx => delete-template.api.mdx} | 16 +- .../docs/API-docs/find-pets-by-status.api.mdx | 4 +- docs/docs/API-docs/find-pets-by-tags.api.mdx | 4 +- docs/docs/API-docs/get-inventory.api.mdx | 2 +- docs/docs/API-docs/get-order-by-id.api.mdx | 319 --------- docs/docs/API-docs/get-pet-by-id.api.mdx | 4 +- docs/docs/API-docs/get-template.api.mdx | 219 ++++++ docs/docs/API-docs/opensign-api-v-1.info.mdx | 2 +- docs/docs/API-docs/place-order.api.mdx | 436 ------------ docs/docs/API-docs/sidebar.ts | 22 +- docs/docs/API-docs/template-list.api.mdx | 297 ++++++++ .../API-docs/update-pet-with-form.api.mdx | 8 +- docs/docs/API-docs/update-pet.api.mdx | 2 +- docs/docs/API-docs/update-template.api.mdx | 178 +++++ docs/docs/API-docs/upload-file.api.mdx | 2 +- 19 files changed, 976 insertions(+), 1426 deletions(-) delete mode 100644 docs/docs/API-docs/create-user.api.mdx create mode 100644 docs/docs/API-docs/createtemplate.api.mdx rename docs/docs/API-docs/{delete-order.api.mdx => delete-template.api.mdx} (54%) delete mode 100644 docs/docs/API-docs/get-order-by-id.api.mdx create mode 100644 docs/docs/API-docs/get-template.api.mdx delete mode 100644 docs/docs/API-docs/place-order.api.mdx create mode 100644 docs/docs/API-docs/template-list.api.mdx create mode 100644 docs/docs/API-docs/update-template.api.mdx diff --git a/docs/docs/API-docs/add-pet.api.mdx b/docs/docs/API-docs/add-pet.api.mdx index 0f7f60bad..8648d066e 100644 --- a/docs/docs/API-docs/add-pet.api.mdx +++ b/docs/docs/API-docs/add-pet.api.mdx @@ -5,7 +5,7 @@ description: "Add a new pet to the store" sidebar_label: "Add a new pet to the store" hide_title: true hide_table_of_contents: true -api: eJztWN+P4jYQ/lesPPUkINBe+4CqqnRvdVr11EVlq1ZiUWWSgfg2sV3bWRah/O+dsRMSYHd76t295QUl4/k93+cYHyLHtzaaLqPSgrHRahClYBMjtBNKRtNolqaMMwk7psExp5jLgFmnDESDSGkwnBRvUlTlaToHh2ID/5Rg3S8q3UfTw5nDKwPcQcenkCc+EyUdSEeGXOtcJD5A/NGS9SGySQYFpyeKIgyklLzkBdnqTDn1h8l9HW6vAeOp9UdIKCttKF0nwJK1SOm31hEYcgsGlTbKFNwF0Q9vUQBPvNA5Kk3G1SDEae2sM0Juu1pRqrZbARHqYuKwVWbf0f9iuXxSKu8UTrZC1aciJ81g0eaFK044r3rVkbVNbL1zY/g+OnraGRwNdd6ZEtBEOCjsc8mcRm48Y1IU2wPv/4b4rFa+2L7LbmGW3Ubd8aBkHXflsyWfop0AHnTPcQ6yLAi6/JGLnK9zj1+QafBiVZ5Gq8t00F83HeIbKXWZUhv0ROmJ0hPlVaIMd7vdkCoeliYHmagU0p46PXV66lxSpxp0yFD3y4DVStrQlW/H48vD3qJMErB2U+bseFbsz3g9/3r+9We8nig9Ub7Ghwolb8ffX36LbuQjz0WKoXUZGGUhKY1wCMolfYjE3w9Az6sKCVOAyxTdamhlfWe5y/At3oKjmxLKCswjXZmQMZ4fcTFzTttpHOOwRjgHacVWYjV2lKgChSJ+nETku4m7IPqGUR2jtxDQ4lcgDNTF/jWcc2NhOGvkgorKgKeYDVVDX8/f25uX6wb6AQeT8dFTzcpTUnqdo0pgywn8l81UVw1al8GqddzgZtVCojNRwq3cKF9iPbFbbNICm8Rm8xuGzTkHzF0mECrWL6cqKQs8NPgNkCGG2Zk1W3MLKVMBWbRI8u9GE2Y1JGJT750jdi/v5UIVwHCQdDLJhXyw03s5ZMvbDaoJnrM/YW2RZatvmpniX4WLmb7xNu+Fy8o1M6BVq771Qj/4rtXx5Q3W6sAU9nazQByJBGr8vBAq9spxfXbiiT874d4vCHe16OdzI2o5fjJQCB3WzN7PP2Bbxuirhe0npBx/uLm6/m1xTV4J+GFEk9EYXRFUkCcFl91Ar10dngz60J4IX7equeHgycU650iBqq7iUDN0GTUMRRRmxF0UHQ6EDcRxVZEYOWI80bEQboRHJ9F+0NCJoO3ZGF2FvIZ3FJjU8zKQ87/+RlaDxsUMj8DavWDsj7wn+838dnGHyuv68rRAbyjteB50X0LavKTSu1vHg98i6gcqp1mS+04mF3tKyJh+Kf9nbX4kVqH2T0f1sPKiQd3TRptmhnt59S82CpVV +api: eJztWN9v2zYQ/lcIPq2AbdlbtwdjGJalQRGsWII6wx4cY6Cls8RGIjWSimMY+t93R0qWbCdZ0a5vejGk0/2+7yNp7rkTqeXzJa8sGMtXI56AjY0sndSKz/lFkjDBFGxZCY45zVwGzDptgI+4LsEIUrxOUFUkyS04FBv4pwLrftPJjs/3Jw4vDQgHPZ9SHfmMtXKgHBmKssxl7ANEnyxZ77mNMygEPVEUaSCh5JUoyLbMtNN/mtzX4XYlYDy9/gQxZVUaStdJsGQtE/ptdCSGTMGg0kabQrgg+uktCuBJFGWOSrNpPQpxOjvrjFRpX4snOk0lcNTFxCHVZtfT/99y+axU3mmcbI2qT0VOmsGiywu/OOm86mVP1jWx8y6METt+8LQ1OBrqvDMVoIl0UNjnkjmO3HrGpCi2B96XhviqVr7YvvNuYZb9Rt2JoGSdcNWzJR+jnQAedE9xDqoqCLriUchcrHOPX1BJ8GJ1nvDVeTror58O8Y2U+kxpDAaiDEQZiPIqUcbb7XZMFY8rk4OKdQLJQJ2BOgN1zqlTj3pkaPplwJZa2dCV76fT88PeoopjsHZT5exwVhzOeAP/Bv4NZ7yBKANRvsVGhZK30x/P96Jr9ShymWDosgqMshBXRjoE5ZI2Ivn3A9DzqkbCFOAyTbcapba+s8Jl+Bal4OimhLIC80hXJmSM50f8mDlX2nkU4bAmOAdlZaqwGjuJdYFCGT3OOPlu4y6IvmFUh+gdBEr5OxAGmmKfxigZO/0AtINKqigDkWAqVAptnR+7a5erFvcBBLPpwU1DyWNGep2DSqDKEfaX7UhXLVSXwapz3IJm1eGhN04CrdpoX18zrhvs0AI7xC5urxl25hQtd5lEnFj/OdFxVeCJwa9+DAHMTqzZWlhImA6woo8k/2EyY7aEWG6ahXPC7tW9WugCGE6RjiW5VA92fq/GbHmzQTUpcvYXrC1SbPVdO1D8n3A20Dfe5r10WbVmBkrdqade6Kfetzq8vMFaHZjC3mwWCCIZQwOeF0JFXjlqDk4i9gcnXPglga4R/XpqRC3H/QKF0KPMxfvbD9iWKfrqMPsZKUcfri+v/lhckVdCfRjRbDJFVwQVJEkhVD/Qa/eGR4Ped8fB160aYjh4clGZC6RA3VSxb+i55C09EYUZERdF+z1hA3Fc1yRGjhjPcixEGOnRSZwftXQiaHsq8suQ1/iOApN6XgVm/td/yHrUurjA82/pXjD2592jxeb2ZnGHyuvm5rRAbyjteR71X0LaoqLS++vGg183mgcqp/2kdr1MjheUkC79UvLPGvxMlMI16ZeDevjyokHT0FabBoareP0vA9iTzw== sidebar_class_name: "post api-method" info_path: docs/API-docs/opensign-api-v-1 custom_edit_url: null diff --git a/docs/docs/API-docs/create-user.api.mdx b/docs/docs/API-docs/create-user.api.mdx deleted file mode 100644 index 9a48a9ed0..000000000 --- a/docs/docs/API-docs/create-user.api.mdx +++ /dev/null @@ -1,637 +0,0 @@ ---- -id: create-user -title: "Create user" -description: "This can only be done by the logged in user." -sidebar_label: "Create user" -hide_title: true -hide_table_of_contents: true -api: eJztV99v2jAQ/lesPK0SEGi7PfBUVlVVt6qg0WqTKJqc5CBuEzuznVKE8r/vzgkh0F/seUg8kPN35/Pddz7fyrN8brz+xLOQZgm3YLxpy4vAhFpkVijp9b3bWBgWcsmUTJYsABYpCSxYMhsDS9R8DhETkuUGdMdreSoDzUn1KkLlUANavcM1XNLwJwdjv6po6fVXO9ucO2Tk7DAVPEBoUSVU0oK0BOdZlojQmfYfDOmsPBPGkHL6Z5cZoJVaMdPkiBV4IlwVUQMj0OTcOTRTOuW2FH05RQE8c4wDgnrdouWRK5Kn0NA1Vgs5byI9DIM7HyrMhDb25kONbyqWBE/4XmhEGILjSUXyPvYBLZ85XCdUKSll3JiF0tH7er3jk9PPDh5jcvfEUnjGltvcvBrc7fRSiFiF3g78yfFW4Au0/Jy6c5axd/vQflZY50AZbRQ0GVGpHAhxIERFiPZisWiT3XauE5ChiiA6UOT/pggBNZhMSVMmOYIZzxP7sh2ZPAzBmFmesLqjHfrRgVuHfnQgxN6XDcpSsLGil3CmjEs7tzF++esHdyKcGDWeQNNTfOVhu0JEbG1m+r6PpOogU6QRc5nwwFDcUCj8p55XTEkzzLWwyzExrSQTrv5+hGXj0Cj5joLW2uNf7RHXBtqDtVxQCGLgUUVlutB+bJ7rF+vTl0ztdZvcqwm2xa+SRE0OVUSpebJLhiYXqiTW+a6/mzntFeT4TLmDVrEfYqjGGCo2GF0xDNGr0wz+aDlSYZ7ibe4qlmHK2Y42C7jBkQQXadahRZKfdHrMZBCKWVXsHXYv7+VYpUDTC7WMRMhH07+XbTYZzhAmeMJ+QmCEhemndWbxffIis0dO51LYOA+Yhkxt4HMndOlvatUfR3hWCzo1w9kY2SRCqFj0xla+A/tVU+Oha2rr1FSis10ldyugaeyfjQIYXI6uMSxdyk9N3j1c9q+vzi9uxhdklehfpqjX6aIpqnUsmZTLxkblkOhmxN3Mrja9+V9H1qpILDxbH4tSuLvPHWRV1etmQHb1imUXUzmjfLUijtzppChIjBWjsfAm+PeJa8EDIuVkivaq4qICd7XpnZfutm9pd4IneVmqH71hi9baxADfKJl9Q9m9SeiGqK+g0XB8i+Cgmr9TtEa318Zyq/lBbhfFXysscmQ= -sidebar_class_name: "post api-method" -info_path: docs/API-docs/opensign-api-v-1 -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

- Create user -

- - - - - - - -This can only be done by the logged in user. - -## Request - - - -
- -

- Body -

-
-
- - - Created user object - - -
-
    - - - - - - - - - - - - - - - - - -
-
-
-
- -

- Body -

-
-
- - - Created user object - - -
-
    - - - - - - - - - - - - - - - - - -
-
-
-
- -

- Body -

-
-
- - - Created user object - - -
-
    - - - - - - - - - - - - - - - - - -
-
-
-
-
- - -
- - - successful operation - - -
- - - - -
- - - Schema - -
- -
    - - - - - - - - - - - - - - - - - -
-
-
- - - - -
-
- - -
- - - Schema - -
- -
    - - - - - - - - - - - - - - - - - -
-
-
- \n 10\n theUser\n John\n James\n john@email.com\n 12345\n 12345\n 1\n"} - language={"xml"} - > - - - -
-
-
-
-
-
-
-
- \ No newline at end of file diff --git a/docs/docs/API-docs/createtemplate.api.mdx b/docs/docs/API-docs/createtemplate.api.mdx new file mode 100644 index 000000000..67472efee --- /dev/null +++ b/docs/docs/API-docs/createtemplate.api.mdx @@ -0,0 +1,242 @@ +--- +id: createtemplate +title: "Template Creation API" +description: "The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template." +sidebar_label: "Template Creation API" +hide_title: true +hide_table_of_contents: true +api: eJztVt9v4zYM/ld0upddkSbp3T3l6bquKIIVbdCk2ENaDLLNxGplyZPk/FiQ/32kbCeOkxsaYI/rFT2bpEjqI/nRG+7F3PHBlHvIciU8OP7a4Qm42MrcS6P5gE9SYJNKzW4sCJKz69GQCaXM0rHCgXXMGxaTElhcOG8y+beIFLCd4w5bpjJOGRovgAnHIlVAbqX2js2MZXPQYNG3nrPExEUGpFhKn7LcQgIzqSFhztsi9oUF12XPOabhijgG52aF2kUq08AcO8xj6pSoBTyjHROs0PKvAtjFRW09TC4u0E54FgvNIqDbJHSZKh9oZBMJ0mFU8utyiOVMknHlqss73OThEkYPE4SuBKTWo9oCRnf+V5Os+WDDY6M9eqZHkedKxuFo780R8Bvu4hQyQU9+nQP6M9EbxB795JYCeYn1Qu2DyKBhhSAhimiFsGbCNyWwEphLMAoPu9z5tsMfjD/bzUgBgoIALyQsmdBYIjkngKTbAUe+f2u21HkhdnVttiW6fH66P9dV6n3uBr3e2hRWZmIO3dhk5IuSxiZu+BPWinXz8JS/Gfgxz4RU4VQH31PdEODgrDJFLnSox85phy8tlhewI7B9AcNJvJM7lfw+VQpWvVXhTjtHb156dSDaEgoqAUtNeB5CqzcXias7sRoFN4cxW+3cCN3WbOkwTimOqCt79Gu/T/+1qOVgZGm+d+Os1p8wsf9oQGKTNDsbOQfmYJtQoOjb13CjYNIGDRUZ5oUdc0J3hNPnz8hXolD+GKL6xk8VNhVU3/vfj9EZ6oVQMgkMNjHvoD+FWBn41BC75MaFqwqf4lvviGwC01JTTze8sKrR/4hlF/HR1DFKRI46DIWyt7ji21c6GeOA+PWY8C0hRO2f77BuTkgufwcakerWq0uUXHpKFIWSbpCCwC4MWVPJnvbsd1t3XM1eR4RU89HHKKbFMKdJo+KMn9BAgwU+Muv7CTsYGrr5zASYqsI/ItBjypjqiAAf71e8CP6Sur5PuWNpLbZOH+4gUpL8W/eq3kflhHTZi37RY5OFfUbbUUn97gYv+pJNH2doJoVif0DkkIpef6kBWS6XR33xJZy5w0VcRFiE3OzN50EYmqd5avfyBe/qwWbucTbGXpRxzcE/CdULxr1q7kUc5h4IdJqfUvSjfYggR2IAGqb9CF7fje4Rlj762rf+B1Lu3Q9vbh/Gt+SVhqcs0VW3j65QRCOXCd0IdPLLqF3jxqb//3PqnM+pimo8rHwPhTIs/lDQTcV70/buwdFMiRhRs9lQiGertlsSY6YWCWyKjwthJeFJb+ix4ikiysBx/KYs1+WE4pM5ghsor7WDtp36xDUCl/t/tX1tcPfocTxB46j6EMzCguJWLOkjEf8O+Av+Cx+U5CFQcJBvuBJ6XoRNxEu/9PMPphMdww== +sidebar_class_name: "post api-method" +info_path: docs/API-docs/opensign-api-v-1 +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

+ Template Creation API +

+ + + + + + + +The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template. + +## Request + + + +
+ +

+ Body +

+
+ +
    + + + + + + + + + + + + + +
+
+
+
+
+ + +
+ + + Template created successfully! + + +
+ + + + +
+ + + Schema + +
+ +
    + + + + + + + +
+
+
+ + + + +
+
+
+
+
+
+ + + Invalid API Token! + + +
+ +
+
+
+
+
+ \ No newline at end of file diff --git a/docs/docs/API-docs/delete-pet.api.mdx b/docs/docs/API-docs/delete-pet.api.mdx index 9f02e65d5..bf0f12a1f 100644 --- a/docs/docs/API-docs/delete-pet.api.mdx +++ b/docs/docs/API-docs/delete-pet.api.mdx @@ -5,7 +5,7 @@ description: "delete a pet" sidebar_label: "Deletes a pet" hide_title: true hide_table_of_contents: true -api: eJyVVdtq20AQ/ZVlnxJwLIeGPohSGhoTTENj6pQWHBPW0shaIq02u6ukQejfO7O6+QotGFua65kzF1fciY3l4ZJHhXIicpavRjwGGxmpnSwUD/EtAwdMMA2Oj3ihwQhSzeJeOfcaLYzI8c1QwIorfEELoeXTM7yjXlK0FEQMhu8nQYGBl1IawKiJyCyMuI1SyAUPK+7eNYWyzki14XU96qO3sJ9k3CXQwqUH4REgkzFzBWsA76RzpjyWTSoHGw81KUwuXCP6eIX5V+RudaEsWPK4mkzoZzfnTL2KDJMibQyfSiDg3EJUGunePUUdN+FyRTGRvLQYWPWUYjEhD9oyg2qot+YUzLx2dJcmI3qd0zYMAqH1GDulrNyoTKztOCpyFMrg9ZJTqg7GgqpuiujB9Ayg5JvvXEv274u5MBYurjv5dkepOKmSwvtLl5HDPSJYIAJ2PZ8xzLzflodUWoYfUsdFVOaA1ZGOIeVsz5uthYWYodKl4JUk/zC+ZFZDJBMZedcxe1SPalHkwEoLSZmxTKpnGz6qC7a8T9BMioz9grWVDlZnHWFvb28HhJ17n1vp0nLNDOhiMN94oWd126t/OcdacRNye58ssEkygrY5J1IF3jhAr7bDRCPOo8yGIf+y78SR8gxD4xiSedul69v5HdIywVjDTPwD5OBu9nX6fTGlqDRVTYsuxxMMhSJdWJcLtZXoxk+p7S/DTm8rjxr7eXhB2uly8McFOhM4RHULtWoHvj9HaB1urTgOboowyKCqaBx+mqyuSfxSgvF7hNiFkWJN84dbEUtLz8NROQny7Ed7EM7ZkWtxFHO3Jop2oVlxf8n8Fm2fpnqF1u2e/B+qU6mbFMNt7bPv3JGb6d30YYpqURKt24vduLUPhOloMQcb3+SlbzrCR30+0Vqi9efevL1+pxz6v4TGmgpc1XX9F0LcPJ0= +api: eJydVW1r2zAQ/itCn1pI45SVfTBjrKyhhJW1LBv70Iai2OdY1JZUSW4bjP/77mTHTtIEtkFI7Ht97rmX1NyLlePxPU+08iLxji9GPAWXWGm81IrH+FaAByaYAc9HXBuwglSztFfeBY0RVpT4ZilgzRW+oIUw8vEJ1qiXFC0HkYLl+0lQYOG5khYwaiYKByPu/LqgCE6WBh9GHN5MoVMYDJIcSsHjmvu1CZbeSrXiTTPq03d1Pcp0g8AIn7/LjxUwmTKvWVvRDh5vq/+CI5WHVSg207YUvhV9vECAC4rvjFYOHHlcTCb0swtqpl5EgaiQeIZPFVBl3EFSWenXgeQNu/H9gmIi/bke+hKagtXGPOp4iOqBkIZTMPuyaVhlC2qQ98bFUSSMGWOvlZMrVYilGye6RKGMXs45pdrAmFPVbRE9mJ4BlHwLve+68XaGkjOvn0DtDQRVJlWmg7P0gelbTD/H9OzybsYw7X7TfubSMfyQOtVJVQKWRjqGfLM9b7YUDlKGSp9DUJL8w/icOQOJzGQSXMfsQT2ouS6BVQ6yqmCFVE8uflBn7P42QzMpCvYblk56WJxs2Hp9fX3H1mnwuZY+r5bMgtGD+SoIA6XbXv3LKdaKi1S622yOHZIJdJ05kioKxhF6de0lGnEYZTGswJd9J46UFxgaZ5DMuxZdXt/dIC0TjDUMxF9Ajm5mX6ff51OKSiPVtuh8PMFQKDLa+VKorURXYURdf1h2elsH1NjP9weoGy0Pbz4yhcAhajqodTft/TVD63jrAODU5giDDOqaxuGXLZqGxM8V2LBEiF1YKZY0f7gSqXT0PNykoyBPfnTn4pQduCUHMW92RNGCtPsdDmFYoe3D1SzQutuTf0N1LHWbYjjNffadI3I1vZn+nKJaVETr9la3bt0DYTpYzO66t0npm+7zQYdPtJN4MT735t3dO+bQ/5201lTdommaP8yWUbU= sidebar_class_name: "delete api-method" info_path: docs/API-docs/opensign-api-v-1 custom_edit_url: null @@ -59,7 +59,7 @@ delete a pet