diff --git a/.gitignore b/.gitignore index 2a22b29a2..aa5c0e490 100644 --- a/.gitignore +++ b/.gitignore @@ -258,5 +258,10 @@ $RECYCLE.BIN/ # Windows shortcuts *.lnk +.vscode/launch.json +Pode.sln +examples/FileBrowser/wwwFiles/ +examples/PetStore/data/PetData.json + packers/choco/pode.nuspec packers/choco/tools/ChocolateyInstall.ps1 diff --git a/LICENSE.txt b/LICENSE.txt index e6d70bc0b..504a54493 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) [2017-2023] [Matthew Kelly (Badgerati)] +Copyright (c) [2017-2024] [Matthew Kelly (Badgerati)] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -18,4 +18,1196 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file +SOFTWARE. + + + +=========================================================================== + +Pode includes a number of components with separate copyright notices and license terms. This product does not necessarily use all the open source components referred to below. Your use of the source code for these components is subject to the terms and conditions of the following licenses. + +=============== TABLE OF CONTENTS ============================= + + +SECTION 1: Apache License, V2.0 + >>> Authress-Engineering/openapi-explorer + >>> stoplightio/elements + >>> swagger-api/swagger-editor + >>> swagger-api/swagger-ui + >>> cloudbase/powershell-yaml +SECTION 2: BSD-STYLE, MIT-STYLE, OR SIMILAR STYLE LICENSES + >>> mrin9/RapiPdf + >>> Redocly/redoc + >>> Phil-Factor/PSYaml + +-------------------- SECTION 1: Apache License, V2.0 -------------------- + + + >>> Authress-Engineering/openapi-explorer + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS"," BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS"," BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + ADDITIONAL LICENSE INFORMATION + name: openapi-explorer + version: 0.0.0 + description: OpenAPI Explorer - API viewer with dynamically generated components, documentation, and interaction console + author: Authress Developers + + >>> stoplightio/elements + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS"," BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2018 Stoplight, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS"," BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + ADDITIONAL LICENSE INFORMATION + author: Stoplight + + >>> swagger-api/swagger-editor + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS"," BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS"," BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + ADDITIONAL LICENSE INFORMATION + name: swagger-editor + description: Swagger Editor + version: 4.11.2 + contributors (in alphabetical order): + Anna Bodnia + Buu Nguyen + Josh Ponelat + Kyle Shockey + Robert Barnwell + Sahar Jafari " + + >>> swagger-api/swagger-ui + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS"," BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS"," BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + ADDITIONAL LICENSE INFORMATION + name: swagger-ui + version: 5.10.5 + contributors (in alphabetical order) : + Anna Bodnia + Buu Nguyen + Josh Ponelat + Kyle Shockey + Robert Barnwell + Sahar Jafari + Vladimir Gorej " + + >>> cloudbase/powershell-yaml + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2016-2023 Cloudbase Solutions SRL + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + ADDITIONAL LICENSE INFORMATION + name: powershell-yaml + version: 0.4.7 + description: Powershell module for serializing and deserializing YAML + author: Gabriel Adrian Samfira,Alessandro Pilotti + CompanyName: Cloudbase Solutions SRL + + + +-------------------- SECTION 2: BSD-STYLE, MIT-STYLE, OR SIMILAR STYLE LICENSES -------------------- + + >>> mrin9/RapiPdf + MIT License + + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + ADDITIONAL LICENSE INFORMATION + name: rapipdf + version: 2.2.1 + description: RapiPdf - Generate PDF from Open API spec + author: Mrinmoy Majumdar + + >>> Redocly/redoc + The MIT License (MIT) + + Copyright (c) 2015-present, Rebilly, Inc. + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + + ADDITIONAL LICENSE INFORMATION + name: redoc + version: 2.1.3 + description: ReDoc + author: Roman Hotsiy + + + >>> rapi-doc/RapiDoc + MIT License + + Copyright (c) 2022 Mrinmoy Majumdar + + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + ADDITIONAL LICENSE INFORMATION + name: rapidoc + version: 9.3.5-beta + description: RapiDoc - Open API spec viewer with built in console + author: Mrinmoy Majumdar + + >>> Phil-Factor/PSYaml + The MIT License (MIT) + + Copyright (c) 2016 Jakku Labs + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + + ADDITIONAL LICENSE INFORMATION + name: PSYaml + version: 1.0.3 + description: PowerShell module used to intrepret Yaml formatted strings + author: Phil-Factor, Pezhore diff --git a/docs/Hosting/RunAsService.md b/docs/Hosting/RunAsService.md index e5ad7f420..551adb8d6 100644 --- a/docs/Hosting/RunAsService.md +++ b/docs/Hosting/RunAsService.md @@ -81,3 +81,55 @@ To stop the service afterwards, you can use the following: ```powershell sudo systemctl stop pode-server ``` +### Using Ports Below 1024 + +#### Introduction + +Traditionally in Linux, binding to ports below 1024 requires root privileges. This is a security measure, as these low-numbered ports are considered privileged. However, running applications as the root user poses significant security risks. This article explores methods to use these privileged ports with PowerShell (`pwsh`) in Linux, without running it as the root user. +There are different methods to achieve the goals. +Reverse Proxy is the right approach for a production environment, primarily if the server is connected directly to the internet. +The other solutions are reasonable after an in-depth risk analysis. + +#### Using a Reverse Proxy + +A reverse proxy like Nginx can listen on the privileged port and forward requests to your application running on an unprivileged port. + +**Configuration:** + +* Configure Nginx to listen on port 443 and forward requests to the port where your PowerShell script is listening. +* This method is widely used in web applications for its additional benefits like load balancing and SSL termination. + +#### iptables Redirection + +Using iptables, you can redirect traffic from a privileged port to a higher, unprivileged port. + +**Implementation:** + * Set up an iptables rule to redirect traffic from, say, port 443 to a higher port where your PowerShell script is listening. + + * `sudo iptables -t nat -A PREROUTING -p tcp --dport 443 -j REDIRECT --to-port 8080` + +**Benefits:** + * This approach doesn't require changing the privileges of the PowerShell executable or script. + +#### Using `setcap` Command + +The `setcap` utility can grant specific capabilities to an executable, like `pwsh`, enabling it to bind to privileged ports. + +**How it Works:** + * Run `sudo setcap 'cap_net_bind_service=+ep' $(which pwsh)`. This command sets the `CAP_NET_BIND_SERVICE` capability on the PowerShell executable, allowing it to bind to any port below 1024. + +**Security Consideration:** + * This method enhances security by avoiding running PowerShell as root, but it still grants significant privileges to the PowerShell process. + +#### Utilizing Authbind + +Authbind is a tool that allows a non-root user to bind to privileged ports. + +**Setup:** + * Install Authbind, configure it to allow the desired port, and then start your PowerShell script using Authbind. + * For instance, `authbind --deep pwsh yourscript.ps1` allows the script to bind to a privileged port. + +**Advantages:** + * It provides a finer-grained control over port access and doesn't require setting special capabilities on the PowerShell binary itself. + + diff --git a/docs/Tutorials/Configuration.md b/docs/Tutorials/Configuration.md index cccf6bfb9..89c59d724 100644 --- a/docs/Tutorials/Configuration.md +++ b/docs/Tutorials/Configuration.md @@ -68,18 +68,19 @@ A "path" like `Server.Ssl.Protocols` looks like the below in the file: } ``` -| Path | Description | Docs | -| ------------------------------ | ----------------------------------------------------------------------- | ------------------------------------------ | -| Server.Ssl.Protocols | Indicates the SSL Protocols that should be used | [link](../Certificates) | -| Server.Request | Defines request timeout and maximum body size | [link](../RequestLimits) | -| Server.AutoImport | Defines the AutoImport scoping rules for Modules, SnapIns and Functions | [link](../Scoping) | -| Server.Logging | Defines extra configuration for Logging, like masking sensitive data | [link](../Logging/Overview) | -| Server.Root | Overrides root path of the server | [link](../Misc/ServerRoot) | -| Server.Restart | Defines configuration for automatically restarting the server | [link](../Restarting/Types/AutoRestarting) | -| Server.FileMonitor | Defines configuration for restarting the server based on file updates | [link](../Restarting/Types/FileMonitoring) | -| Web.Static.ValidateLast | Changes the way routes are processed. | [link](../Routes/Utilities/StaticContent) | -| Web.TransferEncoding | Sets the Request TransferEncoding | [link](../Compression/Requests) | -| Web.Compression | Sets any compression to use on the Response | [link](../Compression/Responses) | -| Web.ContentType | Define expected Content Types for certain Routes | [link](../Routes/Utilities/ContentTypes) | -| Web.ErrorPages | Defines configuration for custom error pages | [link](../Routes/Utilities/ErrorPages) | -| Web.Static | Defines configuration for static content, such as caching | [link](../Routes/Utilities/StaticContent) | +| Path | Description | Docs | +| -------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------ | +| Server.Ssl.Protocols | Indicates the SSL Protocols that should be used | [link](../Certificates) | +| Server.Request | Defines request timeout and maximum body size | [link](../RequestLimits) | +| Server.AutoImport | Defines the AutoImport scoping rules for Modules, SnapIns and Functions | [link](../Scoping) | +| Server.Logging | Defines extra configuration for Logging, like masking sensitive data | [link](../Logging/Overview) | +| Server.Root | Overrides root path of the server | [link](../Misc/ServerRoot) | +| Server.Restart | Defines configuration for automatically restarting the server | [link](../Restarting/Types/AutoRestarting) | +| Server.FileMonitor | Defines configuration for restarting the server based on file updates | [link](../Restarting/Types/FileMonitoring) | +| Web.OpenApi.DefaultDefinitionTag | Define the primary tag name for OpenAPI ( 'default' is the default) | [link](../OpenAPI/OpenAPI) | +| Web.Static.ValidateLast | Changes the way routes are processed. | [link](../Routes/Utilities/StaticContent) | +| Web.TransferEncoding | Sets the Request TransferEncoding | [link](../Compression/Requests) | +| Web.Compression | Sets any compression to use on the Response | [link](../Compression/Responses) | +| Web.ContentType | Define expected Content Types for certain Routes | [link](../Routes/Utilities/ContentTypes) | +| Web.ErrorPages | Defines configuration for custom error pages | [link](../Routes/Utilities/ErrorPages) | +| Web.Static | Defines configuration for static content, such as caching | [link](../Routes/Utilities/StaticContent) | diff --git a/docs/Tutorials/OpenAPI.md b/docs/Tutorials/OpenAPI.md deleted file mode 100644 index 52ba4a447..000000000 --- a/docs/Tutorials/OpenAPI.md +++ /dev/null @@ -1,505 +0,0 @@ -# OpenAPI - -Pode has inbuilt support for converting your routes into OpenAPI 3.0 definitions. There is also support for a enabling simple Swagger and/or ReDoc viewers. - -You can simply enable OpenAPI in Pode, and a very simple definition will be generated. However, to get a more complex definition with request bodies, parameters and response payloads, you'll need to use the relevant OpenAPI functions detailed below. - -## Enabling OpenAPI - -To enable support for generating OpenAPI definitions you'll need to use the [`Enable-PodeOpenApi`](../../Functions/OpenApi/Enable-PodeOpenApi) function. This will allow you to set a title and version for your API. You can also set a default route to retrieve the OpenAPI definition for tools like Swagger or ReDoc, the default is at `/openapi`. - -You can also set a route filter (such as `/api/*`, the default is `/*` for everything), so only those routes are included in the definition. - -An example of enabling OpenAPI is a follows: - -```powershell -Enable-PodeOpenApi -Title 'My Awesome API' -Version 9.0.0.1 -``` - -An example of setting the OpenAPI route is a follows. This will create a route accessible at `/docs/openapi`: - -```powershell -Enable-PodeOpenApi -Path '/docs/openapi' -Title 'My Awesome API' -Version 9.0.0.1 -``` - -### Default Setup - -In the very simplest of scenarios, just enabling OpenAPI will generate a minimal definition. It can be viewed in Swagger/ReDoc etc, but won't be usable for trying calls. - -When you enable OpenAPI, and don't set any other OpenAPI data, the following is the minimal data that is included: - -* Every route will have a 200 and Default response -* Although routes will be included, no request bodies, parameters or response payloads will be defined -* If you have multiple endpoints, then the servers section will be included -* Any authentication will be included - -### Get Definition - -Instead of defining a route to return the definition, you can write the definition to the response whenever you want, and in any route, using the [`Get-PodeOpenApiDefinition`](../../Functions/OpenApi/Get-PodeOpenApiDefinition) function. This could be useful in certain scenarios like in Azure Functions, where you can enable OpenAPI, and then write the definition to the response of a GET request if some query parameter is set; eg: `?openapi=1`. - -For example: - -```powershell -Add-PodeRoute -Method Get -Path '/' -ScriptBlock { - if ($WebEvent.Query.openapi -eq 1) { - Get-PodeOpenApiDefinition | Write-PodeJsonResponse - } -} -``` - -## Authentication - -Any authentication defined, either by [`Add-PodeAuthMiddleware`](../../Functions/Authentication/Add-PodeAuthMiddleware), or using the `-Authentication` parameter on Routes, will be automatically added to the `security` section of the OpenAPI definition. - -## Routes - -To extend the definition of a route, you can use the `-PassThru` switch on the [`Add-PodeRoute`](../../Functions/Routes/Add-PodeRoute) function. This will cause the route that was created to be returned, so you can pass it down the pipe into more OpenAPI functions. - -To add metadata to a route's definition you can use the [`Set-PodeOARouteInfo`](../../Functions/OpenApi/Set-PodeOARouteInfo) function. This will allow you to define a summary/description for the route, as well as tags for grouping: - -```powershell -Add-PodeRoute -Method Get -Path "/api/resources" -ScriptBlock { - Set-PodeResponseStatus -Code 200 -} -PassThru | - Set-PodeOARouteInfo -Summary 'Retrieve some resources' -Tags 'Resources' -``` - -Each of the following OpenAPI functions have a `-PassThru` switch, allowing you to chain many of them together. - -### Responses - -You can define multiple responses for a route, but only one of each status code, using the [`Add-PodeOAResponse`](../../Functions/OpenApi/Add-PodeOAResponse) function. You can either just define the response and status code, with a custom description, or with a schema defining the payload of the response. - -The following is an example of defining simple 200 and 404 responses on a route: - -```powershell -Add-PodeRoute -Method Get -Path "/api/user/:userId" -ScriptBlock { - # logic -} -PassThru | - Add-PodeOAResponse -StatusCode 200 -PassThru | - Add-PodeOAResponse -StatusCode 404 -Description 'User not found' -``` - -Whereas the following is a more complex definition, which also defines the responses JSON payload. This payload is defined as an object with a string Name, and integer UserId: - -```powershell -Add-PodeRoute -Method Get -Path '/api/users/:userId' -ScriptBlock { - Write-PodeJsonResponse -Value @{ - Name = 'Rick' - UserId = $WebEvent.Parameters['userId'] - } -} -PassThru | - Add-PodeOAResponse -StatusCode 200 -Description 'A user object' -ContentSchemas @{ - 'application/json' = (New-PodeOAObjectProperty -Properties @( - (New-PodeOAStringProperty -Name 'Name'), - (New-PodeOAIntProperty -Name 'UserId') - )) - } -``` - -the JSON response payload defined is as follows: - -```json -{ - "Name": [string], - "UserId": [integer] -} -``` - -Internally, each route is created with an empty default 200 and 500 response. You can remove these, or other added responses, by using [`Remove-PodeOAResponse`](../../Functions/OpenApi/Add-PodeOAResponse): - -```powershell -Add-PodeRoute -Method Get -Path "/api/user/:userId" -ScriptBlock { - # logic -} -PassThru | - Remove-PodeOAResponse -StatusCode 200 -``` - -### Requests - -#### Parameters - -You can set route parameter definitions, such as parameters passed in the path/query, by using the [`Set-PodeOARequest`](../../Functions/OpenApi/Set-PodeOARequest) function with the `-Parameters` parameter. The parameter takes an array of properties converted into parameters, using the [`ConvertTo-PodeOAParameter`](../../Functions/OpenApi/ConvertTo-PodeOAParameter) function. - -For example, to create some integer `userId` parameter that is supplied in the path of the request, the following will work: - -```powershell -Add-PodeRoute -Method Get -Path '/api/users/:userId' -ScriptBlock { - Write-PodeJsonResponse -Value @{ - Name = 'Rick' - UserId = $WebEvent.Parameters['userId'] - } -} -PassThru | - Set-PodeOARequest -Parameters @( - (New-PodeOAIntProperty -Name 'userId' -Required | ConvertTo-PodeOAParameter -In Path) - ) -``` - -Whereas you could use the next example to define 2 query parameters, both strings: - -```powershell -Add-PodeRoute -Method Get -Path '/api/users' -ScriptBlock { - Write-PodeJsonResponse -Value @{ - Name = 'Rick' - UserId = $WebEvent.Query['name'] - } -} -PassThru | - Set-PodeOARequest -Parameters @( - (New-PodeOAStringProperty -Name 'name' -Required | ConvertTo-PodeOAParameter -In Query), - (New-PodeOAStringProperty -Name 'city' -Required | ConvertTo-PodeOAParameter -In Query) - ) -``` - -#### Payload - -You can set request payload schemas by using the [`Set-PodeOARequest`](../../Functions/OpenApi/Set-PodeOARequest) function, with the `-RequestBody` parameter. The request body can be defined using the [`New-PodeOARequestBody`](../../Functions/OpenApi/New-PodeOARequestBody) function, and supplying schema definitions for content types - this works in very much a similar way to defining responses above. - -For example, to define a request JSON payload of some `userId` and `name` you could use the following: - -```powershell -Add-PodeRoute -Method Patch -Path '/api/users' -ScriptBlock { - Write-PodeJsonResponse -Value @{ - Name = $WebEvent.Data.name - UserId = $WebEvent.Data.userId - } -} -PassThru | - Set-PodeOARequest -RequestBody ( - New-PodeOARequestBody -Required -ContentSchemas @{ - 'application/json' = (New-PodeOAObjectProperty -Properties @( - (New-PodeOAStringProperty -Name 'name'), - (New-PodeOAIntProperty -Name 'userId') - )) - } - ) -``` - -The expected payload would look as follows: - -```json -{ - "name": [string], - "userId": [integer] -} -``` - -## Components - -You can define reusable OpenAPI components in Pode. Currently supported are Schemas, Parameters, Request Bodies, and Responses. - -### Schemas - -To define a reusable schema that can be used in request bodies, and responses, you can use the [`Add-PodeOAComponentSchema`](../../Functions/OpenApi/Add-PodeOAComponentSchema) function. You'll need to supply a Name, and a Schema that can be reused. - -The following is an example of defining a schema which is a object of Name, UserId, and Age: - -```powershell -# define a reusable schema user object -Add-PodeOAComponentSchema -Name 'UserSchema' -Schema ( - New-PodeOAObjectProperty -Properties @( - (New-PodeOAStringProperty -Name 'Name'), - (New-PodeOAIntProperty -Name 'UserId'), - (New-PodeOAIntProperty -Name 'Age') - ) -) - -# reuse the above schema in a response -Add-PodeRoute -Method Get -Path '/api/users/:userId' -ScriptBlock { - Write-PodeJsonResponse -Value @{ - Name = 'Rick' - UserId = $WebEvent.Parameters['userId'] - Age = 42 - } -} -PassThru | - Add-PodeOAResponse -StatusCode 200 -Description 'A list of users' -ContentSchemas @{ - 'application/json' = 'UserSchema' - } -``` - -### Request Bodies - -To define a reusable request bodies you can use the [`Add-PodeOAComponentRequestBody`](../../Functions/OpenApi/Add-PodeOAComponentRequestBody) function. You'll need to supply a Name, as well as the needed schemas for each content type. - -The following is an example of defining a JSON object that a Name, UserId, and an Enable flag: - -```powershell -# define a reusable request body -Add-PodeOAComponentRequestBody -Name 'UserBody' -Required -ContentSchemas @{ - 'application/json' = (New-PodeOAObjectProperty -Properties @( - (New-PodeOAStringProperty -Name 'Name'), - (New-PodeOAIntProperty -Name 'UserId'), - (New-PodeOABoolProperty -Name 'Enabled') - )) -} - -# use the request body in a route -Add-PodeRoute -Method Patch -Path '/api/users' -ScriptBlock { - Set-PodeResponseStatus -StatusCode 200 -} -PassThru | - Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Reference 'UserBody') -``` - -The JSON payload expected is of the format: - -```json -{ - "Name": [string], - "UserId": [integer], - "Enabled": [boolean] -} -``` - -### Parameters - -To define reusable parameters that are used on requests, you can use the [`Add-PodeOAComponentParameter`](../../Functions/OpenApi/Add-PodeOAComponentParameter) function. You'll need to supply a Name and the Parameter definition. - -The following is an example of defining an integer path parameter for a `userId`, and then using that parameter on a route. - -```powershell -# define a reusable {userid} path parameter -New-PodeOAIntProperty -Name 'userId' -Required | ConvertTo-PodeOAParameter -In Path |Add-PodeOAComponentParameter -Name 'UserId' - -# use this parameter in a route -Add-PodeRoute -Method Get -Path '/api/users/:userId' -ScriptBlock { - Write-PodeJsonResponse -Value @{ - Name = 'Rick' - UserId = $WebEvent.Parameters['userId'] - } -} -PassThru | - Set-PodeOARequest -Parameters @(ConvertTo-PodeOAParameter -Reference 'UserId') -``` - -### Responses - -To define a reusable response definition you can use the [`Add-PodeOAComponentResponse`](../../Functions/OpenApi/Add-PodeOAComponentResponse) function. You'll need to supply a Name, and optionally any Content/Header schemas that define the responses payload. - -The following is an example of defining a 200 response, that has a JSON payload of an array of objects for Name/UserId. This can then be used by name on a route: - -```powershell -# defines a response with a json payload -Add-PodeOAComponentResponse -Name 'OK' -Description 'A user object' -ContentSchemas @{ - 'application/json' = (New-PodeOAObjectProperty -Array -Properties @( - (New-PodeOAStringProperty -Name 'Name'), - (New-PodeOAIntProperty -Name 'UserId') - )) -} - -# reuses the above response on a route using its "OK" name -Add-PodeRoute -Method Get -Path "/api/users" -ScriptBlock { - Write-PodeJsonResponse -Value @( - @{ Name = 'Rick'; UserId = 123 }, - @{ Name = 'Geralt'; UserId = 124 } - ) -} -PassThru | - Add-PodeOAResponse -StatusCode 200 -Reference 'OK' -``` - -the JSON response payload defined is as follows: - -```json -[ - { - "Name": [string], - "UserId": [integer] - } -] -``` - -## Properties - -Properties are used to create all Parameters and Schemas in OpenAPI. You can use the simple types on their own, or you can combine multiple of them together to form complex objects. - -### Simple Types - -There are 5 simple property types: Integers, Numbers, Strings, Booleans, and Schemas. Each of which can be created using the following functions: - -* [`New-PodeOAIntProperty`](../../Functions/OpenApi/New-PodeOAIntProperty) -* [`New-PodeOANumberProperty`](../../Functions/OpenApi/New-PodeOANumberProperty) -* [`New-PodeOAStringProperty`](../../Functions/OpenApi/New-PodeOAStringProperty) -* [`New-PodeOABoolProperty`](../../Functions/OpenApi/New-PodeOABoolProperty) -* [`New-PodeOASchemaProperty`](../../Functions/OpenApi/New-PodeOASchemaProperty) - -These properties can be created with a Name, and other flags such as Required and/or a Description: - -```powershell -# simple integer -New-PodeOAIntProperty -Name 'userId' - -# a float number with a max value of 100 -New-PodeOANumberProperty -Name 'ratio' -Format Float -Maximum 100 - -# a string with a default value, and enum of options -New-PodeOAStringProperty -Name 'type' -Default 'admin' -Enum @('admin', 'user') - -# a boolean that's required -New-PodeOABoolProperty -Name 'enabled' -Required - -# a schema property that references another component schema -New-PodeOASchemaProperty -Name 'Config' -Reference 'ConfigSchema' -``` - -On their own, like above, the simple properties don't really do much. However, you can combine that together to make complex objects/arrays as defined below. - -### Arrays - -There isn't a dedicated function to create an array property, instead there is an `-Array` switch on each of the property functions - both Object and the above simple properties. - -If you supply the `-Array` switch to any of the above simple properties, this will define an array of that type - the `-Name` parameter can also be omitted if only a simple array if required. - -For example, the below will define an integer array: - -```powershell -New-PodeOAIntProperty -Array -``` - -When used in a Response, this could return the following JSON example: - -```json -[ - 0, - 1, - 2 -] -``` - -### Objects - -An object property is a combination of multiple other properties - both simple, array of more objects. - -There are two ways to define objects: - -1. Similar to arrays, you can use the `-Object` switch on the simple properties. -2. You can use the [`New-PodeOAObjectProperty`](../../Functions/OpenApi/New-PodeOAObjectProperty) function to combine multiple properties. - -#### Simple - -If you use the `-Object` switch on the simple property function, this will automatically wrap the property as an object. The Name for this is required. - -For example, the below will define a simple `userId` integer object: - -```powershell -New-PodeOAIntProperty -Name 'userId' -Object -``` - -In a response as JSON, this could look as follows: - -```json -{ - "userId": 0 -} -``` - -Furthermore, you can also supply both `-Array` and `-Object` switches: - -```powershell -New-PodeOAIntProperty -Name 'userId' -Object -Array -``` - -This wil result in something like the following JSON: - -```json -{ - "userId": [ 0, 1, 2 ] -} -``` - -#### Complex - -Unlike the `-Object` switch that simply converts a single property into an object, the [`New-PodeOAObjectProperty`](../../Functions/OpenApi/New-PodeOAObjectProperty) function can combine and convert multiple properties. - -For example, the following will create an object using an Integer, String, and a Boolean: - -```powershell -New-PodeOAObjectProperty -Properties @( - (New-PodeOAIntProperty -Name 'userId'), - (New-PodeOAStringProperty -Name 'name'), - (New-PodeOABoolProperty -Name 'enabled') -) -``` - -As JSON, this could look as follows: - -```json -{ - "userId": 0, - "name": "Gary Goodspeed", - "enabled": true -} -``` - -You can also supply the `-Array` switch to the [`New-PodeOAObjectProperty`](../../Functions/OpenApi/New-PodeOAObjectProperty) function. This will result in an array of objects. For example, if we took the above: - -```powershell -New-PodeOAObjectProperty -Array -Properties @( - (New-PodeOAIntProperty -Name 'userId'), - (New-PodeOAStringProperty -Name 'name'), - (New-PodeOABoolProperty -Name 'enabled') -) -``` - -As JSON, this could look as follows: - -```json -[ - { - "userId": 0, - "name": "Gary Goodspeed", - "enabled": true - }, - { - "userId": 1, - "name": "Kevin", - "enabled": false - } -] -``` - -You can also combine objects into other objects: - -```powershell -$usersArray = New-PodeOAObjectProperty -Name 'users' -Array -Properties @( - (New-PodeOAIntProperty -Name 'userId'), - (New-PodeOAStringProperty -Name 'name'), - (New-PodeOABoolProperty -Name 'enabled') -) - -New-PodeOAObjectProperty -Properties @( - (New-PodeOAIntProperty -Name 'found'), - $usersArray -) -``` - -As JSON, this could look as follows: - -```json -{ - "found": 2, - "users": [ - { - "userId": 0, - "name": "Gary Goodspeed", - "enabled": true - }, - { - "userId": 1, - "name": "Kevin", - "enabled": false - } - ] -} -``` - -## Swagger and ReDoc - -If you're not using a custom OpenAPI viewer, then you can use one of the inbuilt ones with Pode - either Swagger and ReDoc, or both! - -For both you can customise the path to access the page on, but by default Swagger is at `/swagger` and ReDoc is at `/redoc`. If you've written your own custom OpenAPI definition then you can also set a custom path to fetch the definition. - -To enable either you can use the [`Enable-PodeOpenApiViewer`](../../Functions/OpenApi/Enable-PodeOpenApiViewer) function: - -```powershell -# for swagger at "/docs/swagger" -Enable-PodeOpenApiViewer -Type Swagger -Path '/docs/swagger' -DarkMode - -# or ReDoc at the default "/redoc" -Enable-PodeOpenApiViewer -Type ReDoc -``` diff --git a/docs/Tutorials/OpenAPI/OpenAPI.md b/docs/Tutorials/OpenAPI/OpenAPI.md new file mode 100644 index 000000000..39f01e32d --- /dev/null +++ b/docs/Tutorials/OpenAPI/OpenAPI.md @@ -0,0 +1,1044 @@ +# Overview + + +Pode has built-in support for converting your routes into OpenAPI 3.0 definitions. There is also support for enabling simple Swagger and/or ReDoc viewers and others. + +The OpenApi module has been extended with many more functions, and some old ones have been improved. + +For more detailed information regarding OpenAPI and Pode, please refer to [OpenAPI Specification and Pode](../Specification/v3_0_3.md) + +You can enable OpenAPI in Pode, and a straightforward definition will be generated. However, to get a more complex definition with request bodies, parameters, and response payloads, you'll need to use the relevant OpenAPI functions detailed below. + +## Enabling OpenAPI + +To enable support for generating OpenAPI definitions you'll need to use the [`Enable-PodeOpenApi`] function. This will allow you to set a title and version for your API. You can also set a default route to retrieve the OpenAPI definition for tools like Swagger or ReDoc, the default is at `/openapi`. + +You can also set a route filter (such as `/api/*`, the default is `/*` for everything), so only those routes are included in the definition. + +An example of enabling OpenAPI is a follows: + +```powershell +Enable-PodeOpenApi -Title 'My Awesome API' -Version 9.0.0.1 +``` + +An example of setting the OpenAPI route is a follows. This will create a route accessible at `/docs/openapi`: + +```powershell +Enable-PodeOpenApi -Path '/docs/openapi' -Title 'My Awesome API' -Version 9.0.0.1 +``` + +### Default Setup + +In the very simplest of scenarios, just enabling OpenAPI will generate a minimal definition. It can be viewed in Swagger/ReDoc etc, but won't be usable for trying calls. + +When you enable OpenAPI, and don't set any other OpenAPI data, the following is the minimal data that is included: + +* Every route will have a 200 and Default response +* Although routes will be included, no request bodies, parameters or response payloads will be defined +* If you have multiple endpoints, then the servers section will be included +* Any authentication will be included + +This can be changed with [`Enable-PodeOpenApi`] + +For example to change the default response 404 and 500 + +```powershell +Enable-PodeOpenApi -Path '/docs/openapi' -OpenApiVersion '3.0.3' -DefaultResponses ( + New-PodeOAResponse -StatusCode 404 -Description 'User not found' | Add-PodeOAResponse -StatusCode 500 + ) +``` + +For disabling the Default Response use: + +```powershell +Enable-PodeOpenApi -Path '/docs/openapi' -OpenApiVersion '3.0.3' -NoDefaultResponses +``` + +For disabling the Minimal Definitions feature use: + +```powershell +Enable-PodeOpenApi -Path '/docs/openapi' -OpenApiVersion '3.0.3' -DisableMinimalDefinitions +``` + +### Get Definition + +Instead of defining a route to return the definition, you can write the definition to the response whenever you want, and in any route, using the [`Get-PodeOADefinition`] function. This could be useful in certain scenarios like in Azure Functions, where you can enable OpenAPI, and then write the definition to the response of a GET request if some query parameter is set; eg: `?openapi=1`. + +For example: + +```powershell +Add-PodeRoute -Method Get -Path '/' -ScriptBlock { + if ($WebEvent.Query.openapi -eq 1) { + Get-PodeOpenApiDefinition | Write-PodeJsonResponse + } +} +``` + +## OpenAPI Info object + +In previous releases some of the Info object properties like Version and Title were defined by [`Enable-PodeOpenApi`]. +Starting from version 2.10 a new [`Add-PodeOAInfo`] function has been added to create a full OpenAPI Info spec. + +```powershell +Add-PodeOAInfo -Title 'Swagger Petstore - OpenAPI 3.0' ` + -Version 1.0.17 ` + -Description $InfoDescription ` + -TermsOfService 'http://swagger.io/terms/' ` + -LicenseName 'Apache 2.0' ` + -LicenseUrl 'http://www.apache.org/licenses/LICENSE-2.0.html' ` + -ContactName 'API Support' ` + -ContactEmail 'apiteam@swagger.io' +``` + +## OpenAPI configuration Best Practice + +Pode is rich of functions to create and configure an complete OpenApi spec. Here is a typical code you should use to initiate an OpenApi spec + +```powershell +#Initialize OpenApi +Enable-PodeOpenApi -Path '/docs/openapi' -Title 'Swagger Petstore - OpenAPI 3.0' ` + -OpenApiVersion 3.1 -DisableMinimalDefinitions -NoDefaultResponses + +# OpenApi Info +Add-PodeOAInfo -Title 'Swagger Petstore - OpenAPI 3.0' ` + -Version 1.0.17 ` + -Description 'This is a sample Pet Store Server based on the OpenAPI 3.0 specification. ...' ` + -TermsOfService 'http://swagger.io/terms/' ` + -LicenseName 'Apache 2.0' ` + -LicenseUrl 'http://www.apache.org/licenses/LICENSE-2.0.html' ` + -ContactName 'API Support' ` + -ContactEmail 'apiteam@swagger.io' ` + -ContactUrl 'http://example.com/support' + +# Endpoint for the API + Add-PodeOAServerEndpoint -url '/api/v3.1' -Description 'default endpoint' + + # OpenApi external documentation links + $extDoc = New-PodeOAExternalDoc -Name 'SwaggerDocs' -Description 'Find out more about Swagger' -Url 'http://swagger.io' + $extDoc | Add-PodeOAExternalDoc + + # OpenApi documentation viewer + Enable-PodeOAViewer -Type Swagger -Path '/docs/swagger' + Enable-PodeOAViewer -Type ReDoc -Path '/docs/redoc' + Enable-PodeOAViewer -Type RapiDoc -Path '/docs/rapidoc' + Enable-PodeOAViewer -Type StopLight -Path '/docs/stoplight' + Enable-PodeOAViewer -Type Explorer -Path '/docs/explorer' + Enable-PodeOAViewer -Bookmarks -Path '/docs' +``` + +## Authentication + +Any authentication defined, either by [`Add-PodeAuthMiddleware`], or using the `-Authentication` parameter on Routes, will be automatically added to the `security` section of the OpenAPI definition. + + +## Tags + +In OpenAPI, a "tag" is used to group related operations. Tags are often used to organize and categorize endpoints in an API specification, making it easier to understand and navigate the API documentation. Each tag can be associated with one or more API operations, and these tags are then used in tools like Swagger UI to group and display operations in a more organized way. + +Here's an example of how to define and use tags: + +```powershell +# create an External Doc reference +$swaggerDocs = New-PodeOAExternalDoc -Description 'Find out more about Swagger' -Url 'http://swagger.io' + +# create a Tag +Add-PodeOATag -Name 'pet' -Description 'Everything about your Pets' -ExternalDoc $swaggerDocs + +Add-PodeRoute -PassThru -Method get -Path '/pet/findByStatus' -Authentication 'Login-OAuth2' -Scope 'read' -AllowAnon -ScriptBlock { + #route code +} | Set-PodeOARouteInfo -Summary 'Finds Pets by status' -Description 'Multiple status values can be provided with comma-separated strings' ` + -Tags 'pet' -OperationId 'findPetsByStatus' +``` + +## Routes + +To extend the definition of a route, you can use the `-PassThru` switch on the [`Add-PodeRoute`] function. This will cause the route that was created to be returned, so you can pass it down the pipe into more OpenAPI functions. + +To add metadata to a route's definition you can use the [`Set-PodeOARouteInfo`] function. This will allow you to define a summary/description for the route, as well as tags for grouping: + +```powershell +Add-PodeRoute -Method Get -Path "/api/resources" -ScriptBlock { + Set-PodeResponseStatus -Code 200 +} -PassThru | + Set-PodeOARouteInfo -Summary 'Retrieve some resources' -Tags 'Resources' +``` + +Each of the following OpenAPI functions have a `-PassThru` switch, allowing you to chain many of them together. + +### Responses + +You can define multiple responses for a route, but only one of each status code, using the [`Add-PodeOAResponse`] function. You can either just define the response and status code, with a custom description, or with a schema defining the payload of the response. + +The following is an example of defining simple 200 and 404 responses on a route: + +```powershell +Add-PodeRoute -Method Get -Path "/api/user/:userId" -ScriptBlock { + # logic +} -PassThru | + Add-PodeOAResponse -StatusCode 200 -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' +``` + +Whereas the following is a more complex definition, which also defines the responses JSON payload. This payload is defined as an object with a string Name, and integer UserId: + +```powershell +Add-PodeRoute -Method Get -Path '/api/users/:userId' -ScriptBlock { + Write-PodeJsonResponse -Value @{ + Name = 'Rick' + UserId = $WebEvent.Parameters['userId'] + } +} -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'A user object' --Content @{ + 'application/json' = (New-PodeOAStringProperty -Name 'Name'| + New-PodeOAIntProperty -Name 'UserId'| New-PodeOAObjectProperty) + } +``` + +the JSON response payload defined is as follows: + +```json +{ + "Name": [string], + "UserId": [integer] +} +``` + +In case the response JSON payload is an array + +```powershell +Add-PodeRoute -Method Get -Path '/api/users/:userId' -ScriptBlock { + Write-PodeJsonResponse -Value @{ + Name = 'Rick' + UserId = $WebEvent.Parameters['userId'] + } + } -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'A user object' -Content ( + New-PodeOAContentMediaType -ContentMediaType 'application/json' -Array -Content ( + New-PodeOAStringProperty -Name 'Name' | + New-PodeOAIntProperty -Name 'UserId' | + New-PodeOAObjectProperty + ) + ) +``` + +```json +[ + { + "Name": [string], + "UserId": [integer] + } +] +``` + +Internally, each route is created with an empty default 200 and 500 response. You can remove these, or other added responses, by using [`Remove-PodeOAResponse`]: + +```powershell +Add-PodeRoute -Method Get -Path "/api/user/:userId" -ScriptBlock { + # route logic +} -PassThru | + Remove-PodeOAResponse -StatusCode 200 +``` + +### Requests + +#### Parameters + +You can set route parameter definitions, such as parameters passed in the path/query, by using the [`Set-PodeOARequest`] function with the `-Parameters` parameter. The parameter takes an array of properties converted into parameters, using the [`ConvertTo-PodeOAParameter`] function. + +For example, to create some integer `userId` parameter that is supplied in the path of the request, the following will work: + +```powershell +Add-PodeRoute -Method Get -Path '/api/users/:userId' -ScriptBlock { + Write-PodeJsonResponse -Value @{ + Name = 'Rick' + UserId = $WebEvent.Parameters['userId'] + } +} -PassThru | + Set-PodeOARequest -Parameters @( + (New-PodeOAIntProperty -Name 'userId' -Required | ConvertTo-PodeOAParameter -In Path) + ) +``` + +Whereas you could use the next example to define 2 query parameters, both strings: + +```powershell +Add-PodeRoute -Method Get -Path '/api/users' -ScriptBlock { + Write-PodeJsonResponse -Value @{ + Name = 'Rick' + UserId = $WebEvent.Query['name'] + } +} -PassThru | + Set-PodeOARequest -Parameters ( + (New-PodeOAStringProperty -Name 'name' -Required | ConvertTo-PodeOAParameter -In Query), + (New-PodeOAStringProperty -Name 'city' -Required | ConvertTo-PodeOAParameter -In Query) + ) +``` + +#### Payload + +You can set request payload schemas by using the [`Set-PodeOARequest`]function, with the `-RequestBody` parameter. The request body can be defined using the [`New-PodeOARequestBody`] function, and supplying schema definitions for content types - this works in very much a similar way to defining responses above. + +For example, to define a request JSON payload of some `userId` and `name` you could use the following: + +```powershell +Add-PodeRoute -Method Patch -Path '/api/users' -ScriptBlock { + Write-PodeJsonResponse -Value @{ + Name = $WebEvent.Data.name + UserId = $WebEvent.Data.userId + } +} -PassThru | + Set-PodeOARequest -RequestBody ( + New-PodeOARequestBody -Required -Content ( + New-PodeOAContentMediaType -ContentMediaType 'application/json','application/xml' -Content ( New-PodeOAStringProperty -Name 'Name'| New-PodeOAIntProperty -Name 'UserId'| New-PodeOAObjectProperty ) ) + + ) +``` + +The expected payload would look as follows: + +```json +{ + "name": [string], + "userId": [integer] +} +``` + +```xml + + + + + +``` + +## Components + +You can define reusable OpenAPI components in Pode. Currently supported are Schemas, Parameters, Request Bodies, and Responses. + +### Schemas + +To define a reusable schema that can be used in request bodies, and responses, you can use the [`Add-PodeOAComponentSchema`] function. You'll need to supply a Name, and a Schema that can be reused. + +The following is an example of defining a schema which is a object of Name, UserId, and Age: + +```powershell +# define a reusable schema user object +New-PodeOAStringProperty -Name 'Name' | + New-PodeOAIntProperty -Name 'UserId' | + New-PodeOAIntProperty -Name 'Age' | + New-PodeOAObjectProperty | + Add-PodeOAComponentSchema -Name 'UserSchema' + +# reuse the above schema in a response +Add-PodeRoute -Method Get -Path '/api/users/:userId' -ScriptBlock { + Write-PodeJsonResponse -Value @{ + Name = 'Rick' + UserId = $WebEvent.Parameters['userId'] + Age = 42 + } +} -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'A list of users' -Content @{ + 'application/json' = 'UserSchema' + } +``` + +### Request Bodies + +To define a reusable request bodies you can use the [`Add-PodeOAComponentRequestBody`] function. You'll need to supply a Name, as well as the needed schemas for each content type. + +The following is an example of defining a JSON object that a Name, UserId, and an Enable flag: + +```powershell +# define a reusable request body +New-PodeOAContentMediaType -ContentMediaType 'application/json', 'application/x-www-form-urlencoded' -Content ( + New-PodeOAStringProperty -Name 'Name' | + New-PodeOAIntProperty -Name 'UserId' | + New-PodeOABoolProperty -Name 'Enabled' | + New-PodeOAObjectProperty + ) | Add-PodeOAComponentRequestBody -Name 'UserBody' -Required + +# use the request body in a route +Add-PodeRoute -Method Patch -Path '/api/users' -ScriptBlock { + Set-PodeResponseStatus -StatusCode 200 +} -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Reference 'UserBody') +``` + +The JSON payload expected is of the format: + +```json +{ + "Name": [string], + "UserId": [integer], + "Enabled": [boolean] +} +``` + +### Parameters + +To define reusable parameters that are used on requests, you can use the [`Add-PodeOAComponentParameter`] function. You'll need to supply a Name and the Parameter definition. + +The following is an example of defining an integer path parameter for a `userId`, and then using that parameter on a route. + +```powershell +# define a reusable {userid} path parameter +New-PodeOAIntProperty -Name 'userId' -Required | ConvertTo-PodeOAParameter -In Path |Add-PodeOAComponentParameter -Name 'UserId' + +# use this parameter in a route +Add-PodeRoute -Method Get -Path '/api/users/:userId' -ScriptBlock { + Write-PodeJsonResponse -Value @{ + Name = 'Rick' + UserId = $WebEvent.Parameters['userId'] + } +} -PassThru | + Set-PodeOARequest -Parameters @(ConvertTo-PodeOAParameter -Reference 'UserId') +``` + +### Responses + +To define a reusable response definition you can use the [`Add-PodeOAComponentResponse`] function. You'll need to supply a Name, and optionally any Content/Header schemas that define the responses payload. + +The following is an example of defining a 200 response with a JSON payload of an array of objects for Name/UserId. The Response component can be used by a route referencing the name: + +```powershell +# defines a response with a json payload using New-PodeOAContentMediaType +Add-PodeOAComponentResponse -Name 'OK' -Description 'A user object' -Content ( + New-PodeOAContentMediaType -MediaType 'application/json' -Array -Content ( + New-PodeOAStringProperty -Name 'Name' | + New-PodeOAIntProperty -Name 'UserId' | + New-PodeOAObjectProperty + ) + ) + +# reuses the above response on a route using its "OK" name +Add-PodeRoute -Method Get -Path "/api/users" -ScriptBlock { + Write-PodeJsonResponse -Value @( + @{ Name = 'Rick'; UserId = 123 }, + @{ Name = 'Geralt'; UserId = 124 } + ) +} -PassThru | + Add-PodeOAResponse -StatusCode 200 -Reference 'OK' +``` + +the JSON response payload defined is as follows: + +```json +[ + { + "Name": [string], + "UserId": [integer] + } +] +``` + + +### Examples + +To define a reusable example definition you can use the [`Add-PodeOAComponentExample`] function. You'll need to supply a Name, a Summary and a list of value representing the object. + +The following is an example that defines three Pet examples request bodies, and how they're used in a Route's OpenAPI definition: + +```powershell + # defines the frog example +Add-PodeOAComponentExample -name 'frog-example' -Summary "An example of a frog with a cat's name" -Value @{ + name = 'Jaguar'; petType = 'Panthera'; color = 'Lion'; gender = 'Male'; breed = 'Mantella Baroni' +} +# defines the cat example +Add-PodeOAComponentExample -Name 'cat-example' -Summary 'An example of a cat' -Value @{ + name = 'Fluffy'; petType = 'Cat'; color = 'White'; gender = 'male'; breed = 'Persian' +} +# defines the dog example +Add-PodeOAComponentExample -Name 'dog-example' -Summary "An example of a dog with a cat's name" -Value @{ + name = 'Puma'; petType = 'Dog'; color = 'Black'; gender = 'Female'; breed = 'Mixed' +} + +# reuses the examples +Add-PodeRoute -PassThru -Method Put -Path '/pet/:petId' -ScriptBlock { + # route code +} | Set-PodeOARouteInfo -Summary 'Updates a pet in the store with form data' -Tags 'pet' ` + -OperationId 'updatepet' -PassThru | + Set-PodeOARequest -Parameters @( + (New-PodeOAStringProperty -Name 'petId' -Description 'ID of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Path -Required) + ) -RequestBody ( + New-PodeOARequestBody -Description 'user to add to the system' -Content @{ 'application/json' = 'Pet' } -Examples ( + New-PodeOAExample -ContentMediaType 'application/json', 'application/xml' -Reference 'cat-example' | + New-PodeOAExample -ContentMediaType 'application/json', 'application/xml' -Reference 'dog-example' | + New-PodeOAExample -ContentMediaType 'application/json', 'application/xml' -Reference 'frog-example' + ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Pet updated.' +``` + +### Headers + +To define a reusable header definition you can use the [`Add-PodeOAComponentHeader`] function. You'll need to supply a Name, and optionally any Content/Header schemas that define the responses payload. + +```powershell + # define Headers +New-PodeOAIntProperty -Format Int32 -Description 'calls per hour allowed by the user' | + Add-PodeOAComponentHeader -Name 'X-Rate-Limit' +New-PodeOAStringProperty -Format Date-Time -Description 'date in UTC when token expires' | + Add-PodeOAComponentHeader -Name 'X-Expires-After' + +Add-PodeRoute -PassThru -Method Get -Path '/user/login' -ScriptBlock { + # route code +} | Set-PodeOARouteInfo -Summary 'Logs user into the system.' -Description 'Logs user into the system.' ` + -Tags 'user' -OperationId 'loginUser' -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' ` + -Header @('X-Rate-Limit', 'X-Expires-After') -Content ( + New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'string' + ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username/password supplied' +``` + + +### CallBacks + +To define a reusable callback definition you can use the [`Add-PodeOAComponentCallBack`] function. You'll need to supply a Name, and optionally any Content/Header schemas that define the responses payload. + +```powershell +Add-PodeRoute -PassThru -Method Post -Path '/petcallbackReference' -Authentication 'Login-OAuth2' ` + -Scope 'write' -ScriptBlock { + #route code +} | Set-PodeOARouteInfo -Summary 'Add a new pet to the store' -Description 'Add a new pet to the store' ` + -Tags 'pet' -OperationId 'petcallbackReference' -PassThru | + Set-PodeOARequest -RequestBody ( New-PodeOARequestBody -Reference 'PetBodySchema' ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content ( + New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' + ) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Validation exception' -Content @{ + 'application / json' = ( New-PodeOAStringProperty -Name 'result' | + New-PodeOAStringProperty -Name 'message' | + New-PodeOAObjectProperty ) + } -PassThru | + Add-PodeOACallBack -Name 'test1' -Reference 'test' +``` + +### Response Links + +To define a reusable response link definition you can use the [`Add-PodeOAComponentResponseLink`] function. You'll need to supply a Name, and optionally any Content/Header schemas that define the responses payload. + +```powershell +#Add link reference +Add-PodeOAComponentResponseLink -Name 'address' -OperationId 'getUserByName' -Parameters @{ + 'username' = '$request.path.username' +} + +#use link reference +Add-PodeRoute -PassThru -Method Put -Path '/userLinkByRef/:username' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 +} | Set-PodeOARouteInfo -Summary 'Update user' -Description 'This can only be done by the logged in user.' ` + -Tags 'user' -OperationId 'updateUserLinkByRef' -PassThru | + Set-PodeOARequest -Parameters ( + ( New-PodeOAStringProperty -Name 'username' -Description ' name that need to be updated.' -Required | ConvertTo-PodeOAParameter -In Path ) + ) -RequestBody ( + New-PodeOARequestBody -Required -Content ( + New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'User' ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Content @{'application/json' = 'User' } -PassThru -Links ( + New-PodeOAResponseLink -Name 'address2' -Reference 'address' + ) | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' +``` + +## Properties + +Properties are used to create all Parameters and Schemas in OpenAPI. You can use the simple types on their own, or you can combine multiple of them together to form complex objects. + +### Simple Types + +There are 5 simple property types: Integers, Numbers, Strings, Booleans, and Schemas. Each of which can be created using the following functions: + +* [`New-PodeOAIntProperty`] +* [`New-PodeOANumberProperty`] +* [`New-PodeOAStringProperty`] +* [`New-PodeOABoolProperty`] +* [`New-PodeOASchemaProperty`] +* [`New-PodeOAMultiTypeProperty`] (Note: OpenAPI 3.1 only) + +These properties can be created with a Name, and other flags such as Required and/or a Description: + +```powershell +# simple integer +New-PodeOAIntProperty -Name 'userId' + +# a float number with a max value of 100 +New-PodeOANumberProperty -Name 'ratio' -Format Float -Maximum 100 + +# a string with a default value, and enum of options +New-PodeOAStringProperty -Name 'type' -Default 'admin' -Enum @('admin', 'user') + +# a boolean that's required +New-PodeOABoolProperty -Name 'enabled' -Required + +# a schema property that references another component schema +New-PodeOASchemaProperty -Name 'Config' -Reference 'ConfigSchema' + +# a string or an integer or a null value (only available with OpenAPI 3.1) +New-PodeOAMultiTypeProperty -Name 'multi' -Type integer,string -Nullable +``` + +On their own, like above, the simple properties don't really do much. However, you can combine that together to make complex objects/arrays as defined below. + +### Arrays + +There isn't a dedicated function to create an array property, instead there is an `-Array` switch on each of the property functions - both Object and the above simple properties. + +If you supply the `-Array` switch to any of the above simple properties, this will define an array of that type - the `-Name` parameter can also be omitted if only a simple array if required. + +For example, the below will define an integer array: + +```powershell +New-PodeOAIntProperty -Array +``` + +When used in a Response, this could return the following JSON example: + +```json +[ + 0, + 1, + 2 +] +``` + +### Objects + +An object property is a combination of multiple other properties - both simple, array of more objects. + +There are two ways to define objects: + +1. Similar to arrays, you can use the `-Object` switch on the simple properties. +2. You can use the [`New-PodeOAObjectProperty`] function to combine multiple properties. + +#### Simple + +If you use the `-Object` switch on the simple property function, this will automatically wrap the property as an object. The Name for this is required. + +For example, the below will define a simple `userId` integer object: + +```powershell +New-PodeOAIntProperty -Name 'userId' -Object +``` + +In a response as JSON, this could look as follows: + +```json +{ + "userId": 0 +} +``` + +Furthermore, you can also supply both `-Array` and `-Object` switches: + +```powershell +New-PodeOAIntProperty -Name 'userId' -Object -Array +``` + +This wil result in something like the following JSON: + +```json +{ + "userId": [ 0, 1, 2 ] +} +``` + +#### Complex + +Unlike the `-Object` switch that simply converts a single property into an object, the [`New-PodeOAObjectProperty`] function can combine and convert multiple properties. + +For example, the following will create an object using an Integer, String, and a Boolean: + +Legacy Definition + +```powershell +New-PodeOAObjectProperty -Properties ( + (New-PodeOAIntProperty -Name 'userId'), + (New-PodeOAStringProperty -Name 'name'), + (New-PodeOABoolProperty -Name 'enabled') +) +``` + +Using piping (new in Pode 2.10) + +```powershell +New-PodeOAIntProperty -Name 'userId'| New-PodeOAStringProperty -Name 'name'| + New-PodeOABoolProperty -Name 'enabled' |New-PodeOAObjectProperty +``` + +As JSON, this could look as follows: + +```json +{ + "userId": 0, + "name": "Gary Goodspeed", + "enabled": true +} +``` + +You can also supply the `-Array` switch to the [`New-PodeOAObjectProperty`] function. This will result in an array of objects. For example, if we took the above: + +```powershell +New-PodeOAIntProperty -Name 'userId'| New-PodeOAStringProperty -Name 'name'| + New-PodeOABoolProperty -Name 'enabled' |New-PodeOAObjectProperty -Array +``` + +As JSON, this could look as follows: + +```json +[ + { + "userId": 0, + "name": "Gary Goodspeed", + "enabled": true + }, + { + "userId": 1, + "name": "Kevin", + "enabled": false + } +] +``` + +You can also combine objects into other objects: + +```powershell +$usersArray = New-PodeOAIntProperty -Name 'userId'| New-PodeOAStringProperty -Name 'name'| + New-PodeOABoolProperty -Name 'enabled' |New-PodeOAObjectProperty -Array + +New-PodeOAObjectProperty -Properties @( + (New-PodeOAIntProperty -Name 'found'), + $usersArray +) +``` + +As JSON, this could look as follows: + +```json +{ + "found": 2, + "users": [ + { + "userId": 0, + "name": "Gary Goodspeed", + "enabled": true + }, + { + "userId": 1, + "name": "Kevin", + "enabled": false + } + ] +} +``` + +### oneOf, anyOf and allOf Keywords + +OpenAPI 3.x provides several keywords which you can use to combine schemas. You can use these keywords to create a complex schema or validate a value against multiple criteria. + +* oneOf - validates the value against exactly one of the sub-schemas +* allOf - validates the value against all the sub-schemas +* anyOf - validates the value against any (one or more) of the sub-schemas + +You can use the [`Merge-PodeOAProperty`] will instead define a relationship between the properties. + +Unlike [`New-PodeOAObjectProperty`] which combines and converts multiple properties into an Object, [`Merge-PodeOAProperty`] will instead define a relationship between the properties. + +For example, the following will create an something like an C Union object using an Integer, String, and a Boolean: + +```powershell +Merge-PodeOAProperty -Type OneOf -ObjectDefinitions @( + (New-PodeOAIntProperty -Name 'userId' -Object), + (New-PodeOAStringProperty -Name 'name' -Object), + (New-PodeOABoolProperty -Name 'enabled' -Object) + ) +``` + +Or + +```powershell +New-PodeOAIntProperty -Name 'userId' -Object | + New-PodeOAStringProperty -Name 'name' -Object | + New-PodeOABoolProperty -Name 'enabled' -Object | + Merge-PodeOAProperty -Type OneOf +``` + +As JSON, this could look as follows: + +```json +{ + "oneOf": [ + { + "type": "object", + "properties": { + "userId": { + "type": "integer" + } + } + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "default": false + } + } + } + ] +} +``` + +You can also supply a Component Schema created using [`Add-PodeOAComponentSchema`]. For example, if we took the above: + +```powershell + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 1 -ReadOnly | + New-PodeOAStringProperty -Name 'username' -Example 'theUser' -Required | + New-PodeOAStringProperty -Name 'firstName' -Example 'John' | + New-PodeOAStringProperty -Name 'lastName' -Example 'James' | + New-PodeOAStringProperty -Name 'email' -Format email -Example 'john@email.com' | + New-PodeOAStringProperty -Name 'lastName' -Example 'James' | + New-PodeOAStringProperty -Name 'password' -Format Password -Example '12345' -Required | + New-PodeOAStringProperty -Name 'phone' -Example '12345' | + New-PodeOAIntProperty -Name 'userStatus'-Format int32 -Description 'User Status' -Example 1| + New-PodeOAObjectProperty -Name 'User' -XmlName 'user' | + Add-PodeOAComponentSchema + + New-PodeOAStringProperty -Name 'street' -Example '437 Lytton' -Required | + New-PodeOAStringProperty -Name 'city' -Example 'Palo Alto' -Required | + New-PodeOAStringProperty -Name 'state' -Example 'CA' -Required | + New-PodeOAStringProperty -Name 'zip' -Example '94031' -Required | + New-PodeOAObjectProperty -Name 'Address' -XmlName 'address' -Description 'Shipping Address' | + Add-PodeOAComponentSchema + + Merge-PodeOAProperty -Type AllOf -ObjectDefinitions 'Address','User' + +``` + +As JSON, this could look as follows: + +```json +{ + "allOf": [ + { + "$ref": "#/components/schemas/Address" + }, + { + "$ref": "#/components/schemas/User" + } + ] +} +``` +## Implementing Parameter Validation + +Is possible to validate any parameter submitted by clients against an OpenAPI schema, ensuring adherence to defined standards. + + +First, schema validation has to be enabled using : + +```powershell +Enable-PodeOpenApi -EnableSchemaValidation #any other parameters needed +``` + +This command activates the OpenAPI feature with schema validation enabled, ensuring strict adherence to specified schemas. + +Next, is possible to validate any route using `PodeOAJsonSchemaCompliance`. +In this example, we'll create a route for updating a pet: + +```powershell +Add-PodeRoute -PassThru -Method Post -Path '/user' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + $responseMediaType = Get-PodeHeader -Name 'Accept' + switch ($contentType) { + 'application/xml' { + $user = ConvertFrom-PodeXml -node $WebEvent.data | ConvertTo-Json + } + 'application/json' { $user = ConvertTo-Json $WebEvent.data } + 'application/x-www-form-urlencoded' { $user = ConvertTo-Json $WebEvent.data } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + $Validate = Test-PodeOAJsonSchemaCompliance -Json $user -SchemaReference 'User' + if ($Validate.result) { + $newUser = Add-user -User (convertfrom-json -InputObject $user -AsHashtable) + Save-PodeState -Path $using:PetDataJson + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $newUser -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $newUser -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + } +} | Set-PodeOARouteInfo -Summary 'Create user.' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'createUser' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'User' )) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' -PassThru | + Add-PodeOAResponse -Default -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'User' ) +``` +#### Explanation +- The route handles different content types (JSON/XML) and converts them to JSON for validation. +- It validates the received pet object against the 'User' schema using the 'Test-PodeOAJsonSchemaCompliance' function. +- Depending on the validation result, appropriate HTTP responses are returned. +- OpenAPI metadata such as summary, description, request body, and responses are also defined for documentation purposes. + + + +## OpenApi Documentation pages + +If you're not using a custom OpenAPI viewer, then you can use one or more of the inbuilt which Pode supports: ones with Pode: + +* Swagger +* ReDoc +* RapiDoc +* StopLight +* Explorer +* RapiPdf + +For each you can customise the Route path to access the page on, but by default Swagger is at `/swagger`, ReDoc is at `/redoc`, etc. If you've written your own custom OpenAPI definition then you can also set a custom Route path to fetch the definition on. + +To enable a viewer you can use the [`Enable-PodeOAViewer`] function: + +```powershell +# for swagger at "/docs/swagger" +Enable-PodeOpenApiViewer -Type Swagger -Path '/docs/swagger' -DarkMode + +# and ReDoc at the default "/redoc" +Enable-PodeOpenApiViewer -Type ReDoc + +# and RapiDoc at "/docs/rapidoc" +Enable-PodeOAViewer -Type RapiDoc -Path '/docs/rapidoc' -DarkMode + +# and StopLight at "/docs/stoplight" +Enable-PodeOAViewer -Type StopLight -Path '/docs/stoplight' + +# and Explorer at "/docs/explorer" +Enable-PodeOAViewer -Type Explorer -Path '/docs/explorer' + +# and RapiPdf at "/docs/rapipdf" +Enable-PodeOAViewer -Type RapiPdf -Path '/docs/rapipdf' + +# plus a bookmark page with the link to all documentation +Enable-PodeOAViewer -Bookmarks -Path '/docs' + +# there is also an OpenAPI editor (only for v3.0.x) +Enable-PodeOAViewer -Editor -Path '/docs/swagger-editor' +``` + +## Multiple OpenAPI definition + +It's possible to create multiple OpenAPI definitions inside the same Server instance. This feature could be useful in situations such as: + +* Multiple versions of the OpenAPI specification for different use cases +* The same OpenAPI definition, but one using OpenAPI v3.0.3 and another using v3.1.0 +* Different APIs based on the IP or URL + + +### How to use it +Any Pode function that interacts with OpenAPI has a `-DefinitionTag [string[]]` parameter available. This allows you to specify within which OpenAPI definition(s) the API's definition should be available. + +!!! note + These functions accept a simple string, and not an array + + * Get-PodeOADefinition + * Enable-PodeOpenApi + * Enable-PodeOAViewer + * Add-PodeOAInfo + * Test-PodeOAJsonSchemaCompliance + +A new OpenAPI definition has to be created using the `Enable-PodeOpenApi` function + +```powershell +Enable-PodeOpenApi -Path '/docs/openapi/v3.0' -OpenApiVersion '3.0.3' -DefinitionTag 'v3' +Enable-PodeOpenApi -Path '/docs/openapi/v3.1' -OpenApiVersion '3.1.0' -DefinitionTag 'v3.1' +Enable-PodeOpenApi -Path '/docs/openapi/admin' -OpenApiVersion '3.1.0' -DefinitionTag 'admin' +``` + +There is also [`Select-PodeOADefinition`], which simplifies the selection of which OpenAPI definition to use as a wrapper around multiple OpenAPI functions, or Route functions. Meaning you don't have to specify `-DefinitionTag` on embedded OpenAPI/Route calls: + +```powershell +Select-PodeOADefinition -Tag 'v3', 'v3.1' -Scriptblock { + Add-PodeRouteGroup -Path '/api/v5' -Routes { + Add-PodeRoute -Method Get -Path '/petbyRef/:petId' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 2005 + } + } +} + +Select-PodeOADefinition -Tag 'admin' -ScriptBlock { + # your admin definition +} +``` + +The default `Definition Tag` is named "default". This can be changed using the `Server.psd1` file and the `Web.OpenApi.DefaultDefinitionTag` property + +```powershell +@{ + Web=@{ + OpenApi=@{ + DefaultDefinitionTag= 'NewDfault' + } + } +} +``` + +### OpenAPI example + +A simple OpenAPI definition + +```powershell +Add-PodeOAInfo -Title 'Swagger Petstore - OpenAPI 3.0' -Version 1.0.17 -Description $InfoDescription -TermsOfService 'http://swagger.io/terms/' -LicenseName 'Apache 2.0' ` + -LicenseUrl 'http://www.apache.org/licenses/LICENSE-2.0.html' -ContactName 'API Support' -ContactEmail 'apiteam@swagger.io' -DefinitionTag 'v3' + +Add-PodeOAInfo -Title 'Swagger Petstore - OpenAPI 3.1' -Version 1.0.17 -Description $InfoDescription -TermsOfService 'http://swagger.io/terms/' -LicenseName 'Apache 2.0' ` + -LicenseUrl 'http://www.apache.org/licenses/LICENSE-2.0.html' -ContactName 'API Support' -ContactEmail 'apiteam@swagger.io' -DefinitionTag 'v3.1' + +Add-PodeOAServerEndpoint -url '/api/v3' -Description 'default endpoint' -DefinitionTag 'v3', 'v3.1' + +#OpenAPI 3.0 +Enable-PodeOAViewer -Type Swagger -Path '/docs/swagger' -DefinitionTag 'v3' +Enable-PodeOAViewer -Type Bookmarks -Path '/docs' -DefinitionTag 'v3' + +#OpenAPI 3.1 +Enable-PodeOAViewer -Type Swagger -Path '/docs/v3.1/swagger' -DefinitionTag 'v3.1' +Enable-PodeOAViewer -Type ReDoc -Path '/docs/v3.1/redoc' -DarkMode -DefinitionTag 'v3.1' +Enable-PodeOAViewer -Type Bookmarks -Path '/docs/v3.1' -DefinitionTag 'v3.1' + +Select-PodeOADefinition -Tag 'v3', 'v3.1' -ScriptBlock { + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 10 -Required | + New-PodeOAStringProperty -Name 'name' -Example 'doggie' -Required | + New-PodeOASchemaProperty -Name 'category' -Reference 'Category' | + New-PodeOAStringProperty -Name 'photoUrls' -Array -XmlWrapped -XmlItemName 'photoUrl' -Required | + New-PodeOASchemaProperty -Name 'tags' -Reference 'Tag' -Array -XmlWrapped | + New-PodeOAStringProperty -Name 'status' -Description 'pet status in the store' -Enum @('available', 'pending', 'sold') | + New-PodeOAObjectProperty -XmlName 'pet' | + Add-PodeOAComponentSchema -Name 'Pet' + + + Add-PodeRouteGroup -Path '/api/v3' -Routes { + Add-PodeRoute -PassThru -Method Put -Path '/pet' -Authentication 'merged_auth_nokey' -Scope 'write:pets', 'read:pets' -ScriptBlock { + #code + } | Set-PodeOARouteInfo -Summary 'Update an existing pet' -Description 'Update an existing pet by Id' -Tags 'pet' -OperationId 'updatePet' -PassThru | + Set-PodeOARequest -RequestBody ( + New-PodeOARequestBody -Description 'Update an existent pet in the store' -Required -Content ( + New-PodeOAContentMediaType -ContentMediaType 'application/json', 'application/xml' -Content 'Pet' ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -ContentMediaType 'application/json', 'application/xml' -Content 'Pet' ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Pet not found' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Validation exception' + } +} +``` diff --git a/docs/Tutorials/OpenAPI/Specification/v3.0.3.md b/docs/Tutorials/OpenAPI/Specification/v3.0.3.md new file mode 100644 index 000000000..ef7803c40 --- /dev/null +++ b/docs/Tutorials/OpenAPI/Specification/v3.0.3.md @@ -0,0 +1,4264 @@ +# OpenAPI v.3.0.3 Specification and Pode + +#### OpenAPI Version 3.0.3 and Pode 2.10.0 + +The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [BCP 14](https://tools.ietf.org/html/bcp14) [RFC2119](https://tools.ietf.org/html/rfc2119) [RFC8174](https://tools.ietf.org/html/rfc8174) when, and only when, they appear in all capitals, as shown here. + +This document is licensed under [The Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html). + +## Introduction + +The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. + +An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases. + + +## Table of Contents + + +- [Definitions](#definitions) + - [OpenAPI Document](#oasDocument) + - [Path Templating](#pathTemplating) + - [Media Types](#mediaTypes) + - [HTTP Status Codes](#httpCodes) +- [Specification](#specification) + - [Versions](#versions) + - [Format](#format) + - [Document Structure](#documentStructure) + - [Data Types](#dataTypes) + - [Rich Text Formatting](#richText) + - [Relative References In URLs](#relativeReferences) + - [Schema](#schema) + - [OpenAPI Object](#oasObject) + - [Info Object](#infoObject) + - [Contact Object](#contactObject) + - [License Object](#licenseObject) + - [Server Object](#serverObject) + - [Server Variable Object](#serverVariableObject) + - [Components Object](#componentsObject) + - [Paths Object](#pathsObject) + - [Path Item Object](#pathItemObject) + - [Operation Object](#operationObject) + - [External Documentation Object](#externalDocumentationObject) + - [Parameter Object](#parameterObject) + - [Request Body Object](#requestBodyObject) + - [Media Type Object](#mediaTypeObject) + - [Encoding Object](#encodingObject) + - [Responses Object](#responsesObject) + - [Response Object](#responseObject) + - [Callback Object](#callbackObject) + - [Example Object](#exampleObject) + - [Link Object](#linkObject) + - [Header Object](#headerObject) + - [Tag Object](#tagObject) + - [Reference Object](#referenceObject) + - [Schema Object](#schemaObject) + - [Discriminator Object](#discriminatorObject) + - [XML Object](#xmlObject) + - [Security Scheme Object](#securitySchemeObject) + - [OAuth Flows Object](#oauthFlowsObject) + - [OAuth Flow Object](#oauthFlowObject) + - [Security Requirement Object](#securityRequirementObject) + - [Specification Extensions](#specificationExtensions) + - [Security Filtering](#securityFiltering) +- [Appendix A: Revision History](#revisionHistory) + + + + +## Definitions + +##### OpenAPI Document +A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification. + +##### Path Templating +Path templating refers to the usage of template expressions, delimited by curly braces ({}), to mark a section of a URL path as replaceable using path parameters. + +Each template expression in the path MUST correspond to a path parameter that is included in the [Path Item](#path-item-object) itself and/or in each of the Path Item's [Operations](#operation-object). + +##### Media Types +Media type definitions are spread across several resources. +The media type definitions SHOULD be in compliance with [RFC6838](https://tools.ietf.org/html/rfc6838). + +Some examples of possible media type definitions: +``` + text/plain; charset=utf-8 + application/json + application/vnd.github+json + application/vnd.github.v3+json + application/vnd.github.v3.raw+json + application/vnd.github.v3.text+json + application/vnd.github.v3.html+json + application/vnd.github.v3.full+json + application/vnd.github.v3.diff + application/vnd.github.v3.patch +``` +##### HTTP Status Codes +The HTTP Status Codes are used to indicate the status of the executed operation. +The available status codes are defined by [RFC7231](https://tools.ietf.org/html/rfc7231#section-6) and registered status codes are listed in the [IANA Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml). + +## OpenAPI Features Unsupported by Pode + + - Relative Schema Document Example + +## Specification + +### Versions + +The OpenAPI Specification is versioned using [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) (semver) and follows the semver specification. + +The `major`.`minor` portion of the semver (for example `3.0`) SHALL designate the OAS feature set. Typically, *`.patch`* versions address errors in this document, not the feature set. Tooling which supports OAS 3.0 SHOULD be compatible with all OAS 3.0.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.0.0` and `3.0.1` for example. + +Each new minor version of the OpenAPI Specification SHALL allow any OpenAPI document that is valid against any previous minor version of the Specification, within the same major version, to be updated to the new Specification version with equivalent semantics. Such an update MUST only require changing the `openapi` property to the new minor version. + +For example, a valid OpenAPI 3.0.2 document, upon changing its `openapi` property to `3.1.0`, SHALL be a valid OpenAPI 3.1.0 document, semantically equivalent to the original OpenAPI 3.0.2 document. New minor versions of the OpenAPI Specification MUST be written to ensure this form of backward compatibility. + +An OpenAPI document compatible with OAS 3.\*.\* contains a required [`openapi`](#oasVersion) field which designates the semantic version of the OAS that it uses. (OAS 2.0 documents contain a top-level version field named [`swagger`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerObject) and value `"2.0"`.) + +### Format + +An OpenAPI document that conforms to the OpenAPI Specification is itself a JSON object, which may be represented either in JSON or YAML format. + +For example, if a field has an array value, the JSON array representation will be used: + +```json +{ + "field": [ 1, 2, 3 ] +} +``` +All field names in the specification are **case sensitive**. +This includes all fields that are used as keys in a map, except where explicitly noted that keys are **case insensitive**. + +The schema exposes two types of fields: Fixed fields, which have a declared name, and Patterned fields, which declare a regex pattern for the field name. + +Patterned fields MUST have unique names within the containing object. + +In order to preserve the ability to round-trip between YAML and JSON formats, YAML version [1.2](https://yaml.org/spec/1.2/spec.html) is RECOMMENDED along with some additional constraints: + +- Tags MUST be limited to those allowed by the [JSON Schema ruleset](https://yaml.org/spec/1.2/spec.html#id2803231). +- Keys used in YAML maps MUST be limited to a scalar string, as defined by the [YAML Failsafe schema ruleset](https://yaml.org/spec/1.2/spec.html#id2802346). + +**Note:** While APIs may be defined by OpenAPI documents in either YAML or JSON format, the API request and response bodies and other content are not required to be JSON or YAML. + +### Document Structure + +An OpenAPI document MAY be made up of a single document or be divided into multiple, connected parts at the discretion of the user. In the latter case, `$ref` fields MUST be used in the specification to reference those parts as follows from the [JSON Schema](https://json-schema.org) definitions. + +It is RECOMMENDED that the root OpenAPI document be named: `openapi.json` or `openapi.yaml`. + +### Data Types + +Primitive data types in the OAS are based on the types supported by the [JSON Schema Specification Wright Draft 00](https://tools.ietf.org/html/draft-wright-json-schema-00#section-4.2). +Note that `integer` as a type is also supported and is defined as a JSON number without a fraction or exponent part. +`null` is not supported as a type (see [`nullable`](#schemaNullable) for an alternative solution). +Models are defined using the [Schema Object](#schemaObject), which is an extended subset of JSON Schema Specification Wright Draft 00. + +Primitives have an optional modifier property: `format`. +OAS uses several known formats to define in fine detail the data type being used. +However, to support documentation needs, the `format` property is an open `string`-valued property, and can have any value. +Formats such as `"email"`, `"uuid"`, and so on, MAY be used even though undefined by this specification. +Types that are not accompanied by a `format` property follow the type definition in the JSON Schema. Tools that do not recognize a specific `format` MAY default back to the `type` alone, as if the `format` is not specified. + +The formats defined by the OAS are: + +| [`type`](#dataTypes) | [`format`](#dataTypeFormat) | [`Pode CmdLet`](https://badgerati.github.io/Pode/Tutorials/OpenAPI/) | Comments | +| -------------------- | --------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | +| `integer` | `int32` | [`New-PodeOAIntProperty -Name 'anInteger' -Format Int32`] | signed 32 bits | +| `integer` | `int64` | [`New-PodeOAIntProperty -Name 'aLong' -Format Int64`] | signed 64 bits (a.k.a long) | +| `number` | `float` | [`New-PodeOANumberProperty -Name 'aFloat' -Format Float`] | +| `number` | `double` | [`New-PodeOANumberProperty -Name 'aDouble' -Format Double`] | +| `string` | | [`New-PodeOAStringProperty -Name 'aString'`] | +| `string` | `byte` | [`New-PodeOAStringProperty -Name 'aString' -Format Byte`] | base64 encoded characters | +| `string` | `binary` | [`New-PodeOAStringProperty -Name 'aString' -Format Binary`] | any sequence of octets | +| `boolean` | | [`New-PodeOABoolProperty -Name 'aBoolean'`] | +| `string` | `date` | [`New-PodeOAStringProperty -Name 'aDate' -Format Date`] | As defined by `full-date` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) | +| `string` | `date-time` | [`New-PodeOAStringProperty -Name 'aDate' -Format Date-Time`] | As defined by `date-time` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) | +| `string` | `password` | [`New-PodeOAStringProperty -Name 'aDate' -Format Password`] | A hint to UIs to obscure input. | + + +### Rich Text Formatting +Throughout the specification `description` fields are noted as supporting CommonMark markdown formatting. +Where OpenAPI tooling renders rich text it MUST support, at a minimum, markdown syntax as described by [CommonMark 0.27](https://spec.commonmark.org/0.27/). Tooling MAY choose to ignore some CommonMark features to address security concerns. + +### Relative References in URLs + +Unless specified otherwise, all properties that are URLs MAY be relative references as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-4.2). +Relative references are resolved using the URLs defined in the [`Server Object`](#serverObject) as a Base URI. + +Relative references used in `$ref` are processed as per [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03), using the URL of the current document as the base URI. See also the [Reference Object](#referenceObject). + +### Schema + +In the following description, if a field is not explicitly **REQUIRED** or described with a MUST or SHALL, it can be considered OPTIONAL. + +#### OpenAPI Object + +This is the root document object of the [OpenAPI document](#oasDocument). + +##### Fixed Fields + +| Field Name | Type | Pode CmdLets | Description | +| ------------------------------------------ | :-----------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| openapi | `string` | [`Enable-PodeOpenApi`] | **REQUIRED**. This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is *not* related to the API [`info.version`](#infoVersion) string. | +| info | [Info Object](#infoObject) | [`Add-PodeOAInfo`] | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. | +| servers | [[Server Object](#serverObject)] | [`Add-PodeOAServerEndpoint`] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#serverObject) with a [url](#serverUrl) value of `/`. | +| paths | [Paths Object](#pathsObject) | [`Add-PodeRoute`]
[`Set-PodeOARouteInfo`] | **REQUIRED**. The available paths and operations for the API. | +| components | [Components Object](#componentsObject) | [`Add-PodeOAComponentHeader`]
[`Add-PodeOAComponentResponse`]
[`Add-PodeOAComponentRequestBody`]
[`Add-PodeOAComponentParameter`]
[`Add-PodeOAComponentSchema`]
[`Add-PodeOAComponentResponseLink`]
[`Add-PodeOAComponentCallBack`] | An element to hold various schemas for the specification. | +| security | [[Security Requirement Object](#securityRequirementObject)] | [`New-PodeAuthScheme`]
[`Merge-PodeAuthScheme`]
[`Add-PodeRoute`]
| A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition. To make security optional, an empty security requirement (`{}`) can be included in the array. | +| tags | [[Tag Object](#tagObject)] | [`Add-PodeOATag`]
[`Set-PodeOARouteInfo`] | A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the [Operation Object](#operationObject) must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique. | +| externalDocs | [External Documentation Object](#externalDocumentationObject) | [`Add-PodeOAExternalDoc`]
[`New-PodeOAExternalDoc`] | Additional external documentation. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +#### Info Object + +The object provides metadata about the API. +The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience. + +##### Fixed Fields + +| Field Name | Type | `Add-PodeOAInfo` | Description | +| ----------------------------------------------- | :------------------------------: | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| title | `string` | `-Title` | **REQUIRED**. The title of the API. | +| description | `string` | `-Description` | A short description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| termsOfService | `string` | `-TermOfService` | A URL to the Terms of Service for the API. MUST be in the format of a URL. | +| contact | [Contact Object](#contactObject) | `-ContactName` `-ContactEmail` `-ContactUrl` | The contact information for the exposed API. | +| license | [License Object](#licenseObject) | `-LicenseName` `-LicenseUrl` | The license information for the exposed API. | +| version | `string` | `-Version` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oasVersion) or the API implementation version). | + + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Info Object Example +```Powershell +Add-PodeOAInfo -Title 'Sample Pet Store App' -Version 1.0.1 -Description 'This is a sample server for a pet store.' ` + -TermsOfService 'http://example.com/terms/' -LicenseName 'Apache 2.0' ` + -LicenseUrl 'http://www.apache.org/licenses/LICENSE-2.0.html' -ContactName 'API Support' ` + -ContactEmail 'support@example.com' -ContactUrl 'http://example.com/support' +``` + +```json +{ + "title": "Sample Pet Store App", + "description": "This is a sample server for a pet store.", + "termsOfService": "http://example.com/terms/", + "contact": { + "name": "API Support", + "url": "http://www.example.com/support", + "email": "support@example.com" + }, + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0.1" +} +``` + +```yaml +title: Sample Pet Store App +description: This is a sample server for a pet store. +termsOfService: http://example.com/terms/ +contact: + name: API Support + url: http://www.example.com/support + email: support@example.com +license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html +version: 1.0.1 +``` + + + +#### Contact Object + +Contact information for the exposed API. + +##### Fixed Fields + +| Field Name | Type | `Add-PodeOAInfo` | Description | +| -------------------------------- | :------: | ---------------- | ------------------------------------------------------------------------------------------------ | +| name | `string` | `-ContactName` | The identifying name of the contact person/organization. | +| url | `string` | `-ContactUrl` | The URL pointing to the contact information. MUST be in the format of a URL. | +| email | `string` | `-ContactEmail` | The email address of the contact person/organization. MUST be in the format of an email address. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Contact Object Example + +```Powershell +Add-PodeOAInfo -ContactName 'API Support' -ContactUrl 'http://example.com/support' -ContactEmail 'support@example.com' +``` + +```json +{ + "name": "API Support", + "url": "http://www.example.com/support", + "email": "support@example.com" +} +``` + +```yaml +name: API Support +url: http://www.example.com/support +email: support@example.com +``` + +#### License Object + +License information for the exposed API. + +##### Fixed Fields + +| Field Name | Type | `Add-PodeOAInfo` | Description | +| ------------------------------ | :------: | ---------------- | ---------------------------------------------------------------------- | +| name | `string` | `-LicenseName` | **REQUIRED**. The license name used for the API. | +| url | `string` | `-LicenseUrl` | A URL to the license used for the API. MUST be in the format of a URL. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### License Object Example +```Powershell +Add-PodeOAInfo -LicenseName 'Apache 2.0' -LicenseUrl 'http://www.apache.org/licenses/LICENSE-2.0.html' +``` + +```json +{ + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" +} +``` + +```yaml +name: Apache 2.0 +url: https://www.apache.org/licenses/LICENSE-2.0.html +``` + +#### Server Object + +An object representing a Server. + +##### Fixed Fields + +| Field Name | Type | `Add-PodeOAServerEndpoint` | Description | +| ------------------------------------------- | :------------------------------------------------------------: | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| url | `string` | `-Url` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`. | +| description | `string` | `-Description` | An optional string describing the host designated by the URL. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| variables | Map[`string`, [Server Variable Object](#serverVariableObject)] | `-Variable` | A map between a variable name and its value. The value is used for substitution in the server's URL template. In Pode the OpenAPI Object's [`servers`](#oasServers) with variables can be defined using a `[ordered]@{}` [System.Collections.Specialized.OrderedDictionary](https://learn.microsoft.com/en-us/dotnet/api/system.collections.specialized.ordereddictionary?view=net-7.0) | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Server Object Example + +A single server would be described as: + +```Powershell +Add-PodeOAServerEndpoint -Url 'https://development.gigantic-server.com/v1' -Description 'Development server' +``` + +```json +{ + "url": "https://development.gigantic-server.com/v1", + "description": "Development server" +} +``` + +```yaml +url: https://development.gigantic-server.com/v1 +description: Development server +``` + + + +The following shows how multiple servers can be described, for example, at the OpenAPI Object's [`servers`](#oasServers): +```Powershell +Add-PodeOAServerEndpoint -url 'https://development.gigantic-server.com/v1' -Description 'Development server' +Add-PodeOAServerEndpoint -url 'https://staging.gigantic-server.com/v1' -Description 'Staging server' +Add-PodeOAServerEndpoint -url 'https://api.gigantic-server.com/v1' -Description 'Production server' +``` +```json +{ + "servers": [ + { + "url": "https://development.gigantic-server.com/v1", + "description": "Development server" + }, + { + "url": "https://staging.gigantic-server.com/v1", + "description": "Staging server" + }, + { + "url": "https://api.gigantic-server.com/v1", + "description": "Production server" + } + ] +} +``` + +```yaml +servers: +- url: https://development.gigantic-server.com/v1 + description: Development server +- url: https://staging.gigantic-server.com/v1 + description: Staging server +- url: https://api.gigantic-server.com/v1 + description: Production server +``` + + + +The following shows how variables can be used for a server configuration: + +```Powershell +Add-PodeOAServerEndpoint -Url "https://{username}.gigantic-server.com:{port}/{basePath}" ` + -Description "The production API server" -Variable $( + [ordered]@{ + username = @{ + default = 'demo' + description = 'this value is assigned by the service provider, in this example gigantic-server.com' + } + port = @{ + enum = @( 8443, 443 ) + default = 8443 + } + basePath = @{ + default = 'v2' + } + }) +``` +```json +{ + "servers": [ + { + "url": "https://{username}.gigantic-server.com:{port}/{basePath}", + "description": "The production API server", + "variables": { + "username": { + "default": "demo", + "description": "this value is assigned by the service provider, in this example `gigantic-server.com`" + }, + "port": { + "enum": [ + "8443", + "443" + ], + "default": "8443" + }, + "basePath": { + "default": "v2" + } + } + } + ] +} +``` + +```yaml +servers: +- url: https://{username}.gigantic-server.com:{port}/{basePath} + description: The production API server + variables: + username: + # note! no enum here means it is an open value + default: demo + description: this value is assigned by the service provider, in this example `gigantic-server.com` + port: + enum: + - '8443' + - '443' + default: '8443' + basePath: + # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` + default: v2 +``` + + +#### Server Variable Object + +An object representing a Server Variable for server URL template substitution. + +##### Fixed Fields + +| Field Name | Type | Description | +| --------------------------------------------------- | :--------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty. | +| default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. Note this behavior is different than the [Schema Object's](#schemaObject) treatment of default values, because in those cases parameter values are optional. If the [`enum`](#serverVariableEnum) is defined, the value SHOULD exist in the enum's values. | +| description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +#### Components Object + +Holds a set of reusable objects for different aspects of the OAS. +All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. + + +##### Fixed Fields + +| Field Name | Type | Pode | Description | +| -------------------------------------------------------- | :----------------------------------------------------------------------------------------------------- | ----------------------------------- | ---------------------------------------------------------------------------- | +| schemas | Map[`string`, [Schema Object](#schemaObject) \| [Reference Object](#referenceObject)] | [`Add-PodeOAComponentSchema`] | An object to hold reusable [Schema Objects](#schemaObject). | +| responses | Map[`string`, [Response Object](#responseObject) \| [Reference Object](#referenceObject)] | [`Add-PodeOAComponentResponse`] | An object to hold reusable [Response Objects](#responseObject). | +| parameters | Map[`string`, [Parameter Object](#parameterObject) \| [Reference Object](#referenceObject)] | [`Add-PodeOAComponentParameter`] | An object to hold reusable [Parameter Objects](#parameterObject). | PodeOAComponentExample | +| examples | Map[`string`, [Example Object](#exampleObject) \| [Reference Object](#referenceObject)] | [`Add-PodeOAComponentExample`] | An object to hold reusable [Example Objects](#exampleObject). | +| requestBodies | Map[`string`, [Request Body Object](#requestBodyObject) \| [Reference Object](#referenceObject)] | [`Add-PodeOAComponentRequestBody`] | An object to hold reusable [Request Body Objects](#requestBodyObject). | +| headers | Map[`string`, [Header Object](#headerObject) \| [Reference Object](#referenceObject)] | [`Add-PodeOAComponentHeader`] | An object to hold reusable [Header Objects](#headerObject). | +| securitySchemes | Map[`string`, [Security Scheme Object](#securitySchemeObject) \| [Reference Object](#referenceObject)] | [`New-PodeAuthScheme`] | An object to hold reusable [Security Scheme Objects](#securitySchemeObject). | +| links | Map[`string`, [Link Object](#linkObject) \| [Reference Object](#referenceObject)] | [`Add-PodeOAComponentResponseLink`] | An object to hold reusable [Link Objects](#linkObject). | +| callbacks | Map[`string`, [Callback Object](#callbackObject) \| [Reference Object](#referenceObject)] | [`Add-PodeOAComponentCallBack`] | An object to hold reusable [Callback Objects](#callbackObject). | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +All the fixed fields declared above are objects that MUST use keys that match the regular expression: `^[a-zA-Z0-9\.\-_]+$`. + +Field Name Examples: + +``` +User +User_1 +User_Name +user-name +my.org.User +``` + +##### Components Object Example +```powershell +New-PodeOAIntProperty -Name 'code' -Format Int32 | + New-PodeOAStringProperty -Name 'message' | + New-PodeOAObjectProperty | + Add-PodeOAComponentSchema -Name 'GeneralError' + +New-PodeOAStringProperty -Name 'name' | + New-PodeOAIntProperty -Name 'id' -Format Int64 | + New-PodeOAObjectProperty | + Add-PodeOAComponentSchema -Name 'Category' + +New-PodeOAStringProperty -Name 'name' | + New-PodeOAIntProperty -Name 'id' -Format Int64 | + New-PodeOAObjectProperty | + Add-PodeOAComponentSchema -Name 'Tag' + +Add-PodeOAComponentParameter -Name 'skipParam' -Parameter ( + New-PodeOAIntProperty -Name 'skip' -Format int32 -Description 'number of items to skip' -Required | + ConvertTo-PodeOAParameter -In Query +) + +Add-PodeOAComponentParameter -Name 'limitParam' -Parameter ( + New-PodeOAIntProperty -Name 'limit' -Format int32 -Description 'max records to return' -Required | + ConvertTo-PodeOAParameter -In Query +) + +Add-PodeOAComponentResponse -Name 'NotFound' -Description 'Entity not found.' +Add-PodeOAComponentResponse -Name 'IllegalInput' -Description 'Illegal input for operation.' +Add-PodeOAComponentResponse -Name 'GeneralError' -Description 'General Error' ` + -Content (@{'application/json' = 'GeneralError'}) + +New-PodeAuthScheme -ApiKey -Location Header | Add-PodeAuth -Name 'api_key' -Sessionless -ScriptBlock { + param($key) + #logic goes here +} + +New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'read:pets' -Description 'read your pets' +New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'write:pets' -Description 'modify pets in your account' + +New-PodeAuthScheme -OAuth2 -ClientId $ClientId -ClientSecret $ClientSecret -AuthoriseUrl "http://example.org/api/oauth/dialog" ` + -TokenUrl 'http://example.org/api/oauth/token' -Scope 'read:pets', 'write:pets' | + Add-PodeAuth -Name 'petstore_auth' -FailureUrl 'http://example.org/api/oauth/dialog' -SuccessUrl '/' -ScriptBlock { + param($user, $accessToken, $refreshToken) + return @{ User = $user } + } +``` +```json +"components": { + "schemas": { + "GeneralError": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + } + } + }, + "Category": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + } + }, + "Tag": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + } + } + }, + "parameters": { + "skipParam": { + "name": "skip", + "in": "query", + "description": "number of items to skip", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + "limitParam": { + "name": "limit", + "in": "query", + "description": "max records to return", + "required": true, + "schema" : { + "type": "integer", + "format": "int32" + } + } + }, + "responses": { + "NotFound": { + "description": "Entity not found." + }, + "IllegalInput": { + "description": "Illegal input for operation." + }, + "GeneralError": { + "description": "General Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GeneralError" + } + } + } + } + }, + "securitySchemes": { + "api_key": { + "type": "apiKey", + "name": "api_key", + "in": "header" + }, + "petstore_auth": { + "type": "oauth2", + "flows": { + "password": { + "authorizationUrl": "http://example.org/api/oauth/dialog", + "tokenUrl": "http://example.org/api/oauth/token", + "scopes": { + "write:pets": "modify pets in your account", + "read:pets": "read your pets" + } + } + } + } + } +} +``` + +```yaml +components: + schemas: + GeneralError: + type: object + properties: + code: + type: integer + format: int32 + message: + type: string + Category: + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + Tag: + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + parameters: + skipParam: + name: skip + in: query + description: number of items to skip + required: true + schema: + type: integer + format: int32 + limitParam: + name: limit + in: query + description: max records to return + required: true + schema: + type: integer + format: int32 + responses: + NotFound: + description: Entity not found. + IllegalInput: + description: Illegal input for operation. + GeneralError: + description: General Error + content: + application/json: + schema: + $ref: '#/components/schemas/GeneralError' + securitySchemes: + api_key: + type: apiKey + name: api_key + in: header + petstore_auth: + type: oauth2 + flows: + password: + authorizationUrl: http://example.org/api/oauth/dialog + tokenUrl: http://example.org/api/oauth/token + scopes: + write:pets: modify pets in your account + read:pets: read your pets +``` + + +#### Paths Object + +Holds the relative paths to the individual endpoints and their operations. +The path is appended to the URL from the [`Server Object`](#serverObject) in order to construct the full URL. The Paths MAY be empty, due to [ACL constraints](#securityFiltering). + +##### Patterned Fields + +| Field Pattern | Type | Description | +| ------------------------------- | :---------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| /{path} | [Path Item Object](#pathItemObject) | A relative path to an individual endpoint. The field name MUST begin with a forward slash (`/`). The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#serverObject)'s `url` field in order to construct the full URL. [Path templating](#pathTemplating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Path Templating Matching + +Assuming the following paths, the concrete definition, `/pets/mine`, will be matched first if used: + +``` + /pets/{petId} + /pets/mine +``` + +The following paths are considered identical and invalid: + +``` + /pets/{petId} + /pets/{name} +``` + +The following may lead to ambiguous resolution: + +``` + /{entity}/me + /books/{id} +``` + +##### Paths Object Example + +```powershell + Add-PodeRoute -PassThru -Method Get -Path '/pets' -ScriptBlock { + Write-PodeJsonResponse -Value (Get-Pets -All) -StatusCode 200 + } | Set-PodeOARouteInfo -Description 'Returns all pets from the system that the user has access to' -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'A list of pets.' -Default -Content (@{ 'application/json' = New-PodeOASchemaProperty -Reference 'Pet' -array }) + +``` + +```json +{ + "/pets": { + "get": { + "description": "Returns all pets from the system that the user has access to", + "responses": { + "200": { + "description": "A list of pets.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pet" + } + } + } + } + } + } + } + } +} +``` + +```yaml +/pets: + get: + description: Returns all pets from the system that the user has access to + responses: + '200': + description: A list of pets. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pet' +``` + +#### Path Item Object + +Describes the operations available on a single path. +A Path Item MAY be empty, due to [ACL constraints](#securityFiltering). +The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available. + +##### Fixed Fields + +| Field Name | Type | Description | +| --------------------------------------------- | :----------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | (Unsupported by Pode) Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#pathItemObject). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. | +| summary | `string` | An optional, string summary, intended to apply to all operations in this path. | +| description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| get | [Operation Object](#operationObject) | A definition of a GET operation on this path. | +| put | [Operation Object](#operationObject) | A definition of a PUT operation on this path. | +| post | [Operation Object](#operationObject) | A definition of a POST operation on this path. | +| delete | [Operation Object](#operationObject) | A definition of a DELETE operation on this path. | +| options | [Operation Object](#operationObject) | A definition of a OPTIONS operation on this path. | +| head | [Operation Object](#operationObject) | A definition of a HEAD operation on this path. | +| patch | [Operation Object](#operationObject) | A definition of a PATCH operation on this path. | +| trace | [Operation Object](#operationObject) | A definition of a TRACE operation on this path. | +| servers | [[Server Object](#serverObject)] | An alternative `server` array to service all operations in this path. | +| parameters | [[Parameter Object](#parameterObject) \| [Reference Object](#referenceObject)] | A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#referenceObject) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | + + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Path Item Object Example +```powershell +Add-PodeRoute -PassThru -Method Get -Path '/peta/:id' -ScriptBlock { + Write-PodeJsonResponse -Value (Get-Pet -Id $WebEvent.Parameters['id']) -StatusCode 200 + } | + Set-PodeOARouteInfo -Summary 'Find pets by ID' -Description 'Returns pets based on ID' -OperationId 'getPetsById' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + (New-PodeOAStringProperty -Name 'id' -Description 'ID of pet to use' -array | ConvertTo-PodeOAParameter -In Path -Style Simple -Required )) | + Add-PodeOAResponse -StatusCode 200 -Description 'pet response' -Content (@{ '*/*' = New-PodeOASchemaProperty -Reference 'Pet' -array }) -PassThru | + Add-PodeOAResponse -Default -Description 'error payload' -Content (@{'text/html' = 'ErrorModel' }) -PassThru +``` +```json +{ + "get": { + "description": "Returns pets based on ID", + "summary": "Find pets by ID", + "operationId": "getPetsById", + "responses": { + "200": { + "description": "pet response", + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + } + } + }, + "default": { + "description": "error payload", + "content": { + "text/html": { + "schema": { + "$ref": "#/components/schemas/ErrorModel" + } + } + } + } + } + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ID of pet to use", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "simple" + } + ] +} +``` + +```yaml +get: + description: Returns pets based on ID + summary: Find pets by ID + operationId: getPetsById + responses: + '200': + description: pet response + content: + '*/*' : + schema: + type: array + items: + $ref: '#/components/schemas/Pet' + default: + description: error payload + content: + 'text/html': + schema: + $ref: '#/components/schemas/ErrorModel' +parameters: +- name: id + in: path + description: ID of pet to use + required: true + schema: + type: array + items: + type: string + style: simple +``` + +##### Path Item Object Example with External Servers + +```powershell +Add-PodeOAExternalRoute -PassThru -Method Get -Path '/peta/:id' -Servers ( + New-PodeOAServerEndpoint -Url 'http://ext.server.com/api/v12' -Description 'ext test server' | + New-PodeOAServerEndpoint -Url 'http://ext13.server.com/api/v12' -Description 'ext test server 13' + ) | + Set-PodeOARouteInfo -Summary 'Find pets by ID' -Description 'Returns pets based on ID' ` + -OperationId 'getPetsById' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + (New-PodeOAStringProperty -Name 'id' -Description 'ID of pet to use' -array | ConvertTo-PodeOAParameter -In Path -Style Simple -Required ) + ) | + Add-PodeOAResponse -StatusCode 200 -Description 'pet response' -Content ( + @{ '*/*' = New-PodeOASchemaProperty -Reference 'Pet' -array } + ) -PassThru | + Add-PodeOAResponse -Default -Description 'error payload' -Content ( + @{'text/html' = 'ErrorModel' } + ) +``` + +```json +{ + "get": { + "description": "Returns pets based on ID", + "summary": "Find pets by ID", + "operationId": "getPetsById", + "responses": { + "200": { + "description": "pet response", + "content": { + "*/*": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Pet" + } + } + } + } + }, + "default": { + "description": "error payload", + "content": { + "text/html": { + "schema": { + "$ref": "#/components/schemas/ErrorModel" + } + } + } + } + } + }, + "servers": [ + { + "description": "ext test server", + "url": "http://ext.server.com/api/v12" + }, + { + "description": "ext test server 13", + "url": "http://ext13.server.com/api/v12" + } + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ID of pet to use", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "simple" + } + ] +} +``` + +```yaml +get: + description: Returns pets based on ID + summary: Find pets by ID + operationId: getPetsById + responses: + '200': + description: pet response + content: + '*/*' : + schema: + type: array + items: + $ref: '#/components/schemas/Pet' + default: + description: error payload + content: + 'text/html': + schema: + $ref: '#/components/schemas/ErrorModel' + servers: + - description : ext test server + url : http://ext.server.com/api/v12 + - description : ext test server 13 + url : http://ext13.server.com/api/v12 +parameters: +- name: id + in: path + description: ID of pet to use + required: true + schema: + type: array + items: + type: string + style: simple +``` + +#### Operation Object + +Describes a single API operation on a path. + +##### Fixed Fields +```powershell +# Authentication Login-OAuth2 +New-PodeAuthScheme ` + -OAuth2 ` + -ClientId $ClientId ` + -ClientSecret $ClientSecret ` + -AuthoriseUrl 'http://example.org/api/oauth/dialog' ` + -TokenUrl 'http://example.org/api/oauth/token' ` + -Scope 'read', 'write' | Add-PodeAuth -Name 'Login-OAuth2' -FailureUrl '/LoginOAuth2' -SuccessUrl '/' -ScriptBlock { + param($user, $accessToken, $refreshToken) + return @{ User = $user } + } + +# Reference to external documentation +New-PodeOAExternalDoc -Name 'OpenApiDocs' -Description 'Find out more about OpenApi' ` + -Url 'https://www.openapis.org/' + +# The variable $Route used in this table is defined as: +$Route = Add-PodeRoute -PassThru -Method Get -Path '/pet/:petId' -ScriptBlock { + Write-PodeJsonResponse -Value (Get-Pet -Id $WebEvent.Parameters['id']) -StatusCode 200 + } +``` + +| Field Name | Type | `Set-PodeOARouteInfo` | Description | +| ------------------------------------------------ | :---------------------------------------------------------------------------------------: | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| tags | `string` | `-Tags` | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | +| summary | `string` | `-Summary` | A short summary of what the operation does. | +| description | `string` | `-Description` | A verbose explanation of the operation behavior. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#externalDocumentationObject) | `-ExternalDocs` | Additional external documentation for this operation. | +| operationId | `string` | `-OperationId` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. | +| callbacks | Map[`string`, [Callback Object](#callbackObject) \| [Reference Object](#referenceObject)] | TBD | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callbackObject) that describes a request that may be initiated by the API provider and the expected responses. | +| deprecated | `boolean` | `-Deprecated` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | +| servers | [[Server Object](#serverObject)] | TBD | An alternative `server` array to service this operation. If an alternative `server` object is specified at the Path Item Object or Root level, it will be overridden by this value. | + +| Field Name | Type | `Set-PodeOARequest` | Description | +| ---------------------------------------------- | :-------------------------------------------------------------------------------: | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| parameters | [[Parameter Object](#parameterObject) \| [Reference Object](#referenceObject)] | `-Parameters` | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#referenceObject) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | +| requestBody | [Request Body Object](#requestBodyObject) \| [Reference Object](#referenceObject) | `-RequestBody` | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers. | + + + +| Field Name | Type | `Set-PodeOAResponse` | Description | +| ------------------------------------------ | :----------------------------------: | -------------------- | ------------------------------------------------------------------------------------------------ | +| responses | [Responses Object](#responsesObject) | | **REQUIRED**. The list of possible responses as they are returned from executing this operation. | + + + +| Field Name | Type | `Add-PodeRoute` | Description | +| ---------------------------------------- | :---------------------------------------------------------: | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| security | [[Security Requirement Object](#securityRequirementObject)] | `-Authentication` `-Scope ` | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. To make security optional, an empty security requirement (`{}`) can be included in the array. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. | + + +| Field Name | Type | Unsupported | Description | +| ------------------------------------------ | :---------------------------------------------------------------------------------------: | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| callbacks | Map[`string`, [Callback Object](#callbackObject) \| [Reference Object](#referenceObject)] | | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callbackObject) that describes a request that may be initiated by the API provider and the expected responses. | +| servers | [[Server Object](#serverObject)] | | An alternative `server` array to service this operation. If an alternative `server` object is specified at the Path Item Object or Root level, it will be overridden by this value. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Operation Object Example +```powershell +Add-PodeRoute -PassThru -Method Put -Path '/pet' -Authentication 'petstore_auth' ` + -Scope 'write:pets', 'read:pets' -ScriptBlock { + $JsonPet = ConvertTo-Json $WebEvent.data + if ( Update-Pet -Id $WebEvent.Parameters['id'] -Data $JsonPet) { + Write-PodeJsonResponse -Value @{} -StatusCode 200 + } else { + Write-PodeJsonResponse -Value @{} -StatusCode 405 + } +} | Set-PodeOARouteInfo -Summary 'Updates a pet in the store with form data' -Tags 'pet' ` + -OperationId 'updatePetWithForm' -PassThru | + Set-PodeOARequest -Parameters ( + (New-PodeOAStringProperty -Name 'petId' -Description 'ID of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Path -Required) + ) -RequestBody ( + New-PodeOARequestBody -Required -Content @{ + 'application/x-www-form-urlencoded' = New-PodeOAObjectProperty -Properties ( + (New-PodeOAStringProperty -Name 'name' -Description 'Updated name of the pet'), + (New-PodeOAStringProperty -Name 'status' -Description 'Updated status of the pet' -Required) + ) + } + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Pet updated.' -Content ( + @{ 'application/json' = '' ; 'application/xml' = '' } + ) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Method Not Allowed' -Content ( + @{ 'application/json' = '' ; 'application/xml' = '' } + ) +``` + +```json +{ + "tags": [ + "pet" + ], + "summary": "Updates a pet in the store with form data", + "operationId": "updatePetWithForm", + "parameters": [ + { + "name": "petId", + "in": "path", + "description": "ID of pet that needs to be updated", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Updated name of the pet", + "type": "string" + }, + "status": { + "description": "Updated status of the pet", + "type": "string" + } + }, + "required": ["status"] + } + } + } + }, + "responses": { + "200": { + "description": "Pet updated.", + "content": { + "application/json": {}, + "application/xml": {} + } + }, + "405": { + "description": "Method Not Allowed", + "content": { + "application/json": {}, + "application/xml": {} + } + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] +} +``` + +```yaml +tags: +- pet +summary: Updates a pet in the store with form data +operationId: updatePetWithForm +parameters: +- name: petId + in: path + description: ID of pet that needs to be updated + required: true + schema: + type: string +requestBody: + content: + 'application/x-www-form-urlencoded': + schema: + properties: + name: + description: Updated name of the pet + type: string + status: + description: Updated status of the pet + type: string + required: + - status +responses: + '200': + description: Pet updated. + content: + 'application/json': {} + 'application/xml': {} + '405': + description: Method Not Allowed + content: + 'application/json': {} + 'application/xml': {} +security: +- petstore_auth: + - write:pets + - read:pets +``` + +#### External Documentation Object + +Allows referencing an external resource for extended documentation. + +##### Fixed Fields + +| Field Name | Type | `New-PodeOAExternalDoc` | Description | +| ------------------------------------------------ | :------: | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | `-Description` | A short description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| url | `string` | `-Url` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### External Documentation Object Example +```powershell +$ExampleDoc = New-PodeOAExternalDoc -Description 'Find more info here' -Url 'https://example.com' + +Add-PodeRoute -PassThru -Method Put -Path '/pet' -Authentication 'petstore_auth' -Scope 'write:pets', 'read:pets' -ScriptBlock { # code here + } | Set-PodeOARouteInfo -ExternalDoc 'ExampleDoc' -Summary 'Updates a pet in the store with form data' -Tags 'pet' -OperationId 'updatePetWithForm' -PassThru | # Continue ..... +``` + +```json +{ + "description": "Find more info here", + "url": "https://example.com" +} +``` + +```yaml +description: Find more info here +url: https://example.com +``` + +#### Parameter Object + +Describes a single operation parameter. + +A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). + +##### Parameter Locations +There are four possible parameter locations specified by the `in` field: +* path - Used together with [Path Templating](#pathTemplating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. +* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. +* header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. +* cookie - Used to pass a specific cookie value to the API + +##### Fixed Fields + +| Field Name | Type | `ConvertTo-PodeOAParameter` | Description | +| ------------------------------------------------------- | :-------: | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| name | `string` | `-Name` | **REQUIRED**. The name of the parameter. Parameter names are *case sensitive*.
  • If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to a template expression occurring within the [path](#pathsPath) field in the [Paths Object](#pathsObject). See [Path Templating](#pathTemplating) for further information.
  • If [`in`](#parameterIn) is `"header"` and the `name` field is `"Accept"`, `"Content-Type"` or `"Authorization"`, the parameter definition SHALL be ignored.
  • For all other cases, the `name` corresponds to the parameter name used by the [`in`](#parameterIn) property.
Note. In Pode if the -Name parameter is not used the name of the Property created by `New-PodeOAIntProperty`, `New-PodeOANumberProperty`, `New-PodeOABoolProperty `, `New-PodeOAStringProperty`, `New-PodeOAObjectProperty` is used. | +| in | `string` | `-In` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"header"`, `"path"` or `"cookie"`. | +| description | `string` | `-Description` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| required | `boolean` | `-Required` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is `"path"`, this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. | +| deprecated | `boolean` | `-Deprecated` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | +| allowEmptyValue | `boolean` | `-AllowEmptyValue` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision. | + +The rules for serialization of the parameter are specified in one of two ways. +For simpler scenarios, a [`schema`](#parameterSchema) and [`style`](#parameterStyle) can describe the structure and syntax of the parameter. + +| Field Name | Type | `ConvertTo-PodeOAParameter` | Description | +| -------------------------------------------------- | :--------------------------------------------------------------------------------------: | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| style | `string` | `-Style` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. | +| explode | `boolean` | `-Explode` | When this is true, parameter values of type `array` or `object` generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When [`style`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. | +| allowReserved | `boolean` | `-AllowReserved` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. | +| schema | [Schema Object](#schemaObject) \| [Reference Object](#referenceObject) | `-Schema` | The schema defining the type used for the parameter. | +| example | Any | `-Example` | Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` that contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. | +| examples | Map[ `string`, [Example Object](#exampleObject) \| [Reference Object](#referenceObject)] | `-Examples` | Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` that contains an example, the `examples` value SHALL _override_ the example provided by the schema. | + +For more complex scenarios, the [`content`](#parameterContent) property can define the media type and schema of the parameter. +A parameter MUST contain either a `schema` property, or a `content` property, but not both. +When `example` or `examples` are provided in conjunction with the `schema` object, the example MUST follow the prescribed serialization strategy for the parameter. + + +| Field Name | Type | `ConvertTo-PodeOAParameter` | Description | +| -------------------------------------- | :--------------------------------------------------: | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| content | Map[`string`, [Media Type Object](#mediaTypeObject)] | `-Content` | A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry. | + +##### Style Values + +In order to support common ways of serializing simple parameters, a set of `style` values are defined. + +| `style` | [`type`](#dataTypes) | `in` | Comments | +| -------------- | ------------------------------ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) | +| label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) | +| form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. | +| simple | `array` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. | +| spaceDelimited | `array` | `query` | Space separated array values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | +| pipeDelimited | `array` | `query` | Pipe separated array values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | +| deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters. | + +##### Style Examples + +Assume a parameter named `color` has one of the following values: + +``` + string -> "blue" + array -> ["blue","black","brown"] + object -> { "R": 100, "G": 200, "B": 150 } +``` +The following table shows examples of rendering differences for each value. + +| [`style`](#dataTypeFormat) | `explode` | `empty` | `string` | `array` | `object` | +| -------------------------- | --------- | ------- | ----------- | ----------------------------------- | -------------------------------------- | +| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | +| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | +| label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150 | +| label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 | +| form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | +| form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 | +| simple | false | n/a | blue | blue,black,brown | R,100,G,200,B,150 | +| simple | true | n/a | blue | blue,black,brown | R=100,G=200,B=150 | +| spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150 | +| pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200\|B\|150 | +| deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150 | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Parameter Object Examples + +A header parameter with an array of 64 bit integer numbers: +```powershell +New-PodeOAIntProperty -Name 'token' -Description 'token to be passed as a header' -Array -Format Int64 | + ConvertTo-PodeOAParameter -In Header -Style Simple -Required +``` +```json +{ + "name": "token", + "in": "header", + "description": "token to be passed as a header", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "integer", + "format": "int64" + } + }, + "style": "simple" +} +``` + +```yaml +name: token +in: header +description: token to be passed as a header +required: true +schema: + type: array + items: + type: integer + format: int64 +style: simple +``` + +A path parameter of a string value: +```powershell +New-PodeOAStringProperty -Name 'username' -Description 'username to fetch' | + ConvertTo-PodeOAParameter -In Path -Required +``` + +```json +{ + "name": "username", + "in": "path", + "description": "username to fetch", + "required": true, + "schema": { + "type": "string" + } +} +``` + +```yaml +name: username +in: path +description: username to fetch +required: true +schema: + type: string +``` + +An optional query parameter of a string value, allowing multiple values by repeating the query parameter: +```powershell +New-PodeOAStringProperty -Name 'id' -Description 'ID of the object to fetch' -Array | + ConvertTo-PodeOAParameter -In Query -Style Form +``` + +```json +{ + "name": "id", + "in": "query", + "description": "ID of the object to fetch", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "style": "form", + "explode": true +} +``` + +```yaml +name: id +in: query +description: ID of the object to fetch +required: false +schema: + type: array + items: + type: string +style: form +explode: true +``` + +A free-form query parameter, allowing undefined parameters of a specific type: + +```powershell +New-PodeOAIntProperty -Name 'freeForm' -Object | + ConvertTo-PodeOAParameter -In Query -Style Form +``` + +```json +{ + "in": "query", + "name": "freeForm", + "schema": { + "type": "object", + "additionalProperties": { + "type": "integer" + }, + }, + "style": "form" +} +``` + +```yaml +in: query +name: freeForm +schema: + type: object + additionalProperties: + type: integer +style: form +``` + +A complex parameter using `content` to define serialization: + +```powershell + New-PodeOANumberProperty -Name 'lat' -Required | + New-PodeOANumberProperty -Name 'long' -Required | + New-PodeOAObjectProperty|ConvertTo-PodeOAParameter -In Query -ContentType 'application/json' +``` + +```json +{ + "in": "query", + "name": "coordinates", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "lat", + "long" + ], + "properties": { + "lat": { + "type": "number" + }, + "long": { + "type": "number" + } + } + } + } + } +} +``` + +```yaml +in: query +name: coordinates +content: + application/json: + schema: + type: object + required: + - lat + - long + properties: + lat: + type: number + long: + type: number +``` + +#### Request Body Object + +Describes a single request body. + +##### Fixed Fields +| Field Name | Type | `New-PodeOARequestBody` | Description | +| ------------------------------------------------ | :--------------------------------------------------: | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | `-Description` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| content | Map[`string`, [Media Type Object](#mediaTypeObject)] | `-Content` | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* | +| required | `boolean` | `-Required` | Determines if the request body is required in the request. Defaults to `false`. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Request Body Examples + +A request body with a referenced model definition. +```powershell +New-PodeOARequestBody -Description 'user to add to the system' -Content @{ 'application/json' = 'User'; 'application/xml' = 'User'} -Examples ( + New-PodeOAExample -MediaType 'application/json' -Name 'user' -Summary 'User Example' -ExternalValue 'http://foo.bar/examples/user-example.json' | + New-PodeOAExample -MediaType 'application/xml' -Name 'user' -Summary 'User Example in XML' -ExternalValue 'http://foo.bar/examples/user-example.xml' | + New-PodeOAExample -MediaType 'text/plain' -Name 'user' -Summary 'User Example in Plain text' -ExternalValue 'http://foo.bar/examples/user-example.txt' | + New-PodeOAExample -MediaType '*/*' -Name 'user' -Summary 'User example in other format' -ExternalValue 'http://foo.bar/examples/user-example.whatever' + ) +``` + +```json +{ + "description": "user to add to the system", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + }, + "examples": { + "user" : { + "summary": "User Example", + "externalValue": "http://foo.bar/examples/user-example.json" + } + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/User" + }, + "examples": { + "user" : { + "summary": "User example in XML", + "externalValue": "http://foo.bar/examples/user-example.xml" + } + } + }, + "text/plain": { + "examples": { + "user" : { + "summary": "User example in Plain text", + "externalValue": "http://foo.bar/examples/user-example.txt" + } + } + }, + "*/*": { + "examples": { + "user" : { + "summary": "User example in other format", + "externalValue": "http://foo.bar/examples/user-example.whatever" + } + } + } + } +} +``` + +```yaml +description: user to add to the system +content: + 'application/json': + schema: + $ref: '#/components/schemas/User' + examples: + user: + summary: User Example + externalValue: 'http://foo.bar/examples/user-example.json' + 'application/xml': + schema: + $ref: '#/components/schemas/User' + examples: + user: + summary: User Example in XML + externalValue: 'http://foo.bar/examples/user-example.xml' + 'text/plain': + examples: + user: + summary: User example in text plain format + externalValue: 'http://foo.bar/examples/user-example.txt' + '*/*': + examples: + user: + summary: User example in other format + externalValue: 'http://foo.bar/examples/user-example.whatever' +``` + +A body parameter that is an array of string values: + +```powershell +New-PodeOARequestBody -Description 'user to add to the system' -Content @{ + 'text/plain' = New-PodeOAStringProperty -Name 'breed' -array +} +``` + +```json +{ + "description": "user to add to the system", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } +} +``` + +```yaml +description: user to add to the system +required: true +content: + text/plain: + schema: + type: array + items: + type: string +``` + +#### Media Type Object +Each Media Type Object provides schema and examples for the media type identified by its key. + +##### Fixed Fields +| Field Name | Type | `New-PodeOARequestBody` | Description | +| ---------------------------------------- | :--------------------------------------------------------------------------------------: | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| schema | [Schema Object](#schemaObject) \| [Reference Object](#referenceObject) | `-Schema` | The schema defining the content of the request, response, or parameter. | +| example | Any | `Not Supported` | Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. | +| examples | Map[ `string`, [Example Object](#exampleObject) \| [Reference Object](#referenceObject)] | `-Examples` | Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. | +| encoding | Map[`string`, [Encoding Object](#encodingObject)] | `Not Supported` | A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to `requestBody` objects when the media type is `multipart` or `application/x-www-form-urlencoded`. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Media Type Examples + +```powershell +New-PodeOARequestBody -Content @{ 'application/json' = 'Pet' } -Examples ( + New-PodeOAExample -MediaType 'application/json' -Name 'cat' -Summary 'An example of a cat' -Value @{name = 'Fluffy'; petType = 'Cat'; color = 'White'; gender = 'male'; breed = 'Persian' } | + New-PodeOAExample -MediaType 'application/json' -Name 'dog' -Summary "An example of a dog with a cat's name" -Value @{name = 'Puma'; petType = 'Dog'; color = 'Black'; gender = 'Female'; breed = 'Mixed' }| + New-PodeOAExample -MediaType 'application/json' -Reference 'frog-example' + ) +``` + +```json +{ + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + }, + "examples": { + "cat" : { + "summary": "An example of a cat", + "value": + { + "name": "Fluffy", + "petType": "Cat", + "color": "White", + "gender": "male", + "breed": "Persian" + } + }, + "dog": { + "summary": "An example of a dog with a cat's name", + "value" : { + "name": "Puma", + "petType": "Dog", + "color": "Black", + "gender": "Female", + "breed": "Mixed" + }, + "frog": { + "$ref": "#/components/examples/frog-example" + } + } + } + } +} +``` + +```yaml +application/json: + schema: + $ref: "#/components/schemas/Pet" + examples: + cat: + summary: An example of a cat + value: + name: Fluffy + petType: Cat + color: White + gender: male + breed: Persian + dog: + summary: An example of a dog with a cat's name + value: + name: Puma + petType: Dog + color: Black + gender: Female + breed: Mixed + frog: + $ref: "#/components/examples/frog-example" +``` + +##### Considerations for File Uploads + +In contrast with the 2.0 specification, `file` input/output content in OpenAPI is described with the same semantics as any other schema type. Specifically: + +```yaml +# content transferred with base64 encoding +schema: + type: string + format: base64 +``` + +```yaml +# content transferred in binary (octet-stream): +schema: + type: string + format: binary +``` + +These examples apply to either input payloads of file uploads or response payloads. + +A `requestBody` for submitting a file in a `POST` operation may look like the following example: + +```powershell + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Content @{'application/octet-stream' = (New-PodeOAStringProperty -Format binary)}) +``` + +```yaml +requestBody: + content: + application/octet-stream: + schema: + # a binary file of any type + type: string + format: binary +``` + +In addition, specific media types MAY be specified: +```powershell + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Content @{ + 'image/jpeg' = (New-PodeOAStringProperty -Format binary) + 'image/png' = (New-PodeOAStringProperty -Format binary) + }) +``` +or + +```powershell +New-PodeOAContentMediaType -MediaType 'image/jpeg','image/png' -Content (New-PodeOAStringProperty -Format binary) +``` + +```yaml +# multiple, specific media types may be specified: +requestBody: + content: + # a binary file of type png or jpeg + 'image/jpeg': + schema: + type: string + format: binary + 'image/png': + schema: + type: string + format: binary +``` + +To upload multiple files, a `multipart` media type MUST be used: +```powershell + Set-PodeOARequest -Properties -RequestBody (New-PodeOARequestBody -Content @{ + 'multipart/form-data' = (New-PodeOAStringProperty -Name 'file' -Format binary -Array) + }) +``` + +```yaml +requestBody: + content: + multipart/form-data: + schema: + properties: + # The property name 'file' will be used for all files. + file: + type: array + items: + type: string + format: binary +``` + +Note the use of the `-Properties` Parameter without that the result is + +```yaml +requestBody: + content: + multipart/form-data: + schema: + type: array + items: + type: string + format: binary +``` + +##### Support for x-www-form-urlencoded Request Bodies + +To submit content using form url encoding via [RFC1866](https://tools.ietf.org/html/rfc1866), the following +definition may be used: +```powershell + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Content @{ + 'application/x-www-form-urlencoded' = (New-PodeOAObjectProperty -Properties @( + (New-PodeOAStringProperty -name 'id' -format 'uuid'), (New-PodeOAObjectProperty -name 'address' -NoProperties))) +}) +``` + +```yaml +requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + id: + type: string + format: uuid + address: + # complex types are stringified to support RFC 1866 + type: object + properties: {} +``` + +In this example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when passed to the server. In addition, the `address` field complex object will be stringified. + +When passing complex objects in the `application/x-www-form-urlencoded` content type, the default serialization strategy of such properties is described in the [`Encoding Object`](#encodingObject)'s [`style`](#encodingStyle) property as `form`. + +##### Special Considerations for `multipart` Content + +It is common to use `multipart/form-data` as a `Content-Type` when transferring request bodies to operations. In contrast to 2.0, a `schema` is REQUIRED to define the input parameters to the operation when using `multipart` content. This supports complex structures as well as supporting mechanisms for multiple file uploads. + +When passing in `multipart` types, boundaries MAY be used to separate sections of the content being transferred — thus, the following default `Content-Type`s are defined for `multipart`: + +* If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain` +* If the property is complex, or an array of complex values, the default Content-Type is `application/json` +* If the property is a `type: string` with `format: binary` or `format: base64` (aka a file object), the default Content-Type is `application/octet-stream` + + +Examples: + +```powershell + Set-PodeOARequest -RequestBody ( + New-PodeOARequestBody -Content ( + New-PodeOAContentMediaType -MediaType 'multipart/form-data' -Content ( + New-PodeOAStringProperty -name 'id' -format 'uuid' | + New-PodeOAObjectProperty -name 'address' -NoProperties | + New-PodeOAStringProperty -name 'children' -array | + New-PodeOASchemaProperty -Name 'addresses' -Reference 'Address' -Array | + New-PodeOAObjectProperty + ) + ) + ) +``` + +```yaml +requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + id: + type: string + format: uuid + address: + # default Content-Type for objects is `application/json` + type: object + properties: {} + profileImage: + # default Content-Type for string/binary is `application/octet-stream` + type: string + format: binary + children: + # default Content-Type for arrays is based on the `inner` type (text/plain here) + type: array + items: + type: string + addresses: + # default Content-Type for arrays is based on the `inner` type (object shown, so `application/json` in this example) + type: array + items: + type: '#/components/schemas/Address' +``` + +An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies. This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies. + +#### Encoding Object + +A single encoding definition applied to a single schema property. + +##### Fixed Fields +| Field Name | Type | `New-PodeOAEncodingObject` | Description | +| ------------------------------------------------- | :-----------------------------------------------------------------------------------: | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| contentType | `string` | `-ContentType` | The Content-Type for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types. | +| headers | Map[`string`, [Header Object](#headerObject) \| [Reference Object](#referenceObject)] | `-Headers` | A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`. | +| style | `string` | `-Style` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameterObject) for details on the [`style`](#parameterStyle) property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | +| explode | `boolean` | `-Explode` | When this is true, property values of type `array` or `object` generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | +| allowReserved | `boolean` | `-AllowReserved` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Encoding Object Example + +```powershell +New-PodeOARequestBody -Content (New-PodeOAContentMediaType -MediaType 'multipart/mixed' -Content ( + New-PodeOAStringProperty -name 'id' -format 'uuid' | + New-PodeOAObjectProperty -name 'address' -NoProperties | + New-PodeOAObjectProperty -name 'historyMetadata' -Description 'metadata in XML format' -NoProperties | + New-PodeOAStringProperty -name 'profileImage' -Format Binary | + New-PodeOAObjectProperty + )) -Encoding ( + New-PodeOAEncodingObject -Name 'historyMetadata' -ContentType 'application/xml; charset=utf-8' | + New-PodeOAEncodingObject -Name 'profileImage' -ContentType 'image/png, image/jpeg' -Headers ( + New-PodeOAIntProperty -name 'X-Rate-Limit-Limit' ` + -Description 'The number of allowed requests in the current period' + ) +) +``` + +```yaml +requestBody: + content: + multipart/mixed: + schema: + type: object + properties: + id: + # default is text/plain + type: string + format: uuid + address: + # default is application/json + type: object + properties: {} + historyMetadata: + # need to declare XML format! + description: metadata in XML format + type: object + properties: {} + profileImage: + # default is application/octet-stream, need to declare an image type only! + type: string + format: binary + encoding: + historyMetadata: + # require XML Content-Type in utf-8 encoding + contentType: application/xml; charset=utf-8 + profileImage: + # only accept png/jpeg + contentType: image/png, image/jpeg + headers: + X-Rate-Limit-Limit: + description: The number of allowed requests in the current period + schema: + type: integer +``` + +#### Responses Object + +A container for the expected responses of an operation. +The container maps a HTTP response code to the expected response. + +The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. +However, documentation is expected to cover a successful operation response and any known errors. + +The `default` MAY be used as a default response object for all HTTP codes +that are not covered individually by the specification. + +The `Responses Object` MUST contain at least one response code, and it +SHOULD be the response for a successful operation call. + +##### Fixed Fields +| Field Name | Type | `Add-PodeOAResponse` | Description | +| -------------------------------------- | :------------------------------------------------------------------------: | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| default | [Response Object](#responseObject) \| [Reference Object](#referenceObject) | `-Default` | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](#referenceObject) can link to a response that the [OpenAPI Object's components/responses](#componentsResponses) section defines. | + +##### Patterned Fields +| Field Pattern | Type | `Add-PodeOAResponse` | Description | +| ---------------------------------------------------------- | :------------------------------------------------------------------------: | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [HTTP Status Code](#httpCodes) | [Response Object](#responseObject) \| [Reference Object](#referenceObject) | `-StatusCode` | Any [HTTP status code](#httpCodes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A [Reference Object](#referenceObject) can link to a response that is defined in the [OpenAPI Object's components/responses](#componentsResponses) section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. | + + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Responses Object Example + +A 200 response for a successful operation and a default response for others (implying an error): + +```powershell +Add-PodeOAResponse -StatusCode 200 -Description 'a pet to be returned' -Content (@{'application/json' = 'Pet' }) -PassThru | +Add-PodeOAResponse -Default -Description 'Unexpected error' -Content (@{'application/json' = 'ErrorModel' }) +``` + +```json +{ + "200": { + "description": "a pet to be returned", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pet" + } + } + } + }, + "default": { + "description": "Unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorModel" + } + } + } + } +} +``` + +```yaml +'200': + description: a pet to be returned + content: + application/json: + schema: + $ref: '#/components/schemas/Pet' +default: + description: Unexpected error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorModel' +``` + +#### Response Object +Describes a single response from an API Operation, including design-time, static +`links` to operations based on the response. + +##### Fixed Fields +| Field Name | Type | `Add-PodeOAResponse` | Description | +| --------------------------------------------- | :------------------------------------------------------------------------------------: | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | `-Description` | **REQUIRED**. A short description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| headers | Map[`string`, [Header Object](#headerObject) \| [Reference Object](#referenceObject)] | `-Headers` | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | +| content | Map[`string`, [Media Type Object](#mediaTypeObject)] | `-Content` | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* | +| links | Map[`string`, [Link Object](#linkObject) \| [Reference Object](#referenceObject)] | TBD | A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for [Component Objects](#componentsObject). | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Response Object Examples + +Response of an array of a complex type: + +```powershell +Add-PodeOAResponse -StatusCode 200 -Description 'A complex object array response' -Content ( + New-PodeOAMediaContentType -MediaType 'application/json' -Content 'VeryComplexType' -Array +) +``` + +```json +{ + "200": { + "description": "A complex object array response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VeryComplexType" + } + } + } + } + } +} +``` + +```yaml +'200': + description: A complex object array response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VeryComplexType' +``` + +Response with a string type: + +```powershell +Add-PodeOAResponse -StatusCode 200 -Description 'A simple string response' -Content (New-PodeOAMediaContentType -MediaType 'text/plain' -Content (New-PodeOAStringProperty) -Array) +``` + +or + +```powershell +Add-PodeOAResponse -StatusCode 200 -Description 'A simple string response' -Content (New-PodeOAMediaContentType -MediaType 'text/plain' -Content 'string' -Array) +``` + +```json +{ + "200": { + "description": "A simple string response", + "content": { + "text/plain": { + "schema": { + "type": "string" + } + } + } + + } +} +``` + +```yaml +'200': + description: A simple string response + content: + text/plain: + schema: + type: string +``` + +Plain text response with headers: + +```powershell + Add-PodeOAResponse -StatusCode 200 -Description 'A simple string response' -Content @{ + 'text/plain' = ( New-PodeOAStringProperty -Example 'whoa!') + } -Headers ( + New-PodeOAIntProperty -Name 'X-Rate-Limit-Limit' -Description 'The number of allowed requests in the current period' | + New-PodeOAIntProperty -Name 'X-Rate-Limit-Remaining' -Description 'The number of remaining requests in the current period' | + New-PodeOAIntProperty -Name 'X-Rate-Limit-Reset' -Description 'The number of seconds left in the current period' + ) +``` + +```json +{ + "200": { + "description": "A simple string response", + "content": { + "text/plain": { + "schema": { + "type": "string", + "example": "whoa!" + } + } + }, + "headers": { + "X-Rate-Limit-Limit": { + "description": "The number of allowed requests in the current period", + "schema": { + "type": "integer" + } + }, + "X-Rate-Limit-Remaining": { + "description": "The number of remaining requests in the current period", + "schema": { + "type": "integer" + } + }, + "X-Rate-Limit-Reset": { + "description": "The number of seconds left in the current period", + "schema": { + "type": "integer" + } + } + } + } +} +``` + +```yaml +'200': + description: A simple string response + content: + text/plain: + schema: + type: string + example: 'whoa!' + headers: + X-Rate-Limit-Limit: + description: The number of allowed requests in the current period + schema: + type: integer + X-Rate-Limit-Remaining: + description: The number of remaining requests in the current period + schema: + type: integer + X-Rate-Limit-Reset: + description: The number of seconds left in the current period + schema: + type: integer +``` + +Response with no return value: +```powershell +Add-PodeOAResponse -StatusCode 200 -Description 'object created' +``` + +```json +{ + "200": { + "description": "object created" + } +} +``` + +```yaml +'200': + description: object created +``` + +#### Callback Object + +A map of possible out-of band callbacks related to the parent operation. +Each value in the map is a [Path Item Object](#pathItemObject) that describes a set of requests that may be initiated by the API provider and the expected responses. +The key value used to identify the path item object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation. + +##### Patterned Fields +| Field Pattern | Type | Description | +| --------------------------------------------- | :---------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {expression} | [Path Item Object](#pathItemObject) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Key Expression + +The key that identifies the [Path Item Object](#pathItemObject) is a [runtime expression](#runtimeExpression) that can be evaluated in the context of a runtime HTTP request/response to identify the URL to be used for the callback request. +A simple example might be `$request.body#/url`. +However, using a [runtime expression](#runtimeExpression) the complete HTTP message can be accessed. +This includes accessing any part of a body that a JSON Pointer [RFC6901](https://tools.ietf.org/html/rfc6901) can reference. + +For example, given the following HTTP request: + +```http +POST /subscribe/myevent?queryUrl=http://clientdomain.com/stillrunning HTTP/1.1 +Host: example.org +Content-Type: application/json +Content-Length: 187 + +{ + "failedUrl" : "http://clientdomain.com/failed", + "successUrls" : [ + "http://clientdomain.com/fast", + "http://clientdomain.com/medium", + "http://clientdomain.com/slow" + ] +} + +201 Created +Location: http://example.org/subscription/1 +``` + +The following examples show how the various expressions evaluate, assuming the callback operation has a path parameter named `eventType` and a query parameter named `queryUrl`. + +| Expression | Value | +| ---------------------------- | :--------------------------------------------------------------------------------- | +| $url | http://example.org/subscribe/myevent?queryUrl=http://clientdomain.com/stillrunning | +| $method | POST | +| $request.path.eventType | myevent | +| $request.query.queryUrl | http://clientdomain.com/stillrunning | +| $request.header.content-Type | application/json | +| $request.body#/failedUrl | http://clientdomain.com/failed | +| $request.body#/successUrls/2 | http://clientdomain.com/medium | +| $response.header.Location | http://example.org/subscription/1 | + + +##### Callback Object Examples + +The following example uses the user provided `queryUrl` query string parameter to define the callback URL. This is an example of how to use a callback object to describe a WebHook callback that goes with the subscription operation to enable registering for the WebHook. + +```powershell +Add-PodeOACallBacks -Title 'test' -Path '{$request.query.queryUrl}' -Method Post ` + -RequestBody (New-PodeOARequestBody -Description 'Callback payload' ` + -Content @{'application/json' = 'SomePayload' } ) ` + -Response ( Add-PodeOACallBacksResponse -StatusCode 200 -Description 'callback successfully processed' ) +``` + +```yaml +myCallback: + '{$request.query.queryUrl}': + post: + requestBody: + description: Callback payload + content: + 'application/json': + schema: + $ref: '#/components/schemas/SomePayload' + responses: + '200': + description: callback successfully processed +``` + +The following example shows a callback where the server is hard-coded, but the query string parameters are populated from the `id` and `email` property in the request body. + +```yaml +transactionCallback: + 'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}': + post: + requestBody: + description: Callback payload + content: + 'application/json': + schema: + $ref: '#/components/schemas/SomePayload' + responses: + '200': + description: callback successfully processed +``` + +#### Example Object + +##### Fixed Fields +| Field Name | Type | `New-PodeOAExample ` | Description | +| ------------------------------------------------ | :------: | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| summary | `string` | `-Summary` | Short description for the example. | +| description | `string` | `-Description` | Long description for the example. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| value | Any | `-Value` | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. | +| externalValue | `string` | `-ExternalValue` | A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The `value` field and `externalValue` field are mutually exclusive. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +In all cases, the example value is expected to be compatible with the type schema +of its associated value. Tooling implementations MAY choose to +validate compatibility automatically, and reject the example value(s) if incompatible. + +##### Example Object Examples + +In a request body: + +```powershell +New-PodeOARequestBody -Content @{ 'application/json' = 'Address' } -Examples ( + New-PodeOAExample -MediaType 'application/json' -Name 'foo' -Summary 'A foo example' -Value @{foo = 'bar' } | + New-PodeOAExample -MediaType 'application/json' -Name 'bar' -Summary 'A bar example' -Value @{'bar' = 'baz' }| + New-PodeOAExample -MediaType 'application/xml' -Name 'xmlExample' -Summary 'This is an example in XML' -ExternalValue 'http://example.org/examples/address-example.xml' | + New-PodeOAExample -MediaType 'text/plain' -Name 'textExample' -Summary 'This is an example' -ExternalValue 'http://example.org/examples/address-example.txt' | + ) +``` + +```yaml +requestBody: + content: + 'application/json': + schema: + $ref: '#/components/schemas/Address' + examples: + foo: + summary: A foo example + value: {"foo": "bar"} + bar: + summary: A bar example + value: {"bar": "baz"} + 'application/xml': + examples: + xmlExample: + summary: This is an example in XML + externalValue: 'http://example.org/examples/address-example.xml' + 'text/plain': + examples: + textExample: + summary: This is a text example + externalValue: 'http://foo.bar/examples/address-example.txt' +``` + +In a parameter: + +```powershell +New-PodeOAStringProperty -Name 'zipCode' -format 'zip-code' | + ConvertTo-PodeOAParameter -In Query -Examples ( + New-PodeOAExample -Name 'zip-example' -Refence 'zip-example' + ) +``` + +```yaml +parameters: + - name: 'zipCode' + in: 'query' + schema: + type: 'string' + format: 'zip-code' + examples: + zip-example: + $ref: '#/components/examples/zip-example' +``` + +In a response: + +```yaml +responses: + '200': + description: your car appointment has been booked + content: + application/json: + schema: + $ref: '#/components/schemas/SuccessResponse' + examples: + confirmation-success: + $ref: '#/components/examples/confirmation-success' +``` + + +#### Link Object + +The `Link object` represents a possible design-time link for a response. +The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations. + +Unlike _dynamic_ links (i.e. links provided **in** the response payload), the OAS linking mechanism does not require link information in the runtime response. + +For computing links, and providing instructions to execute them, a [runtime expression](#runtimeExpression) is used for accessing values in an operation and using them as parameters while invoking the linked operation. + +##### Fixed Fields + +| Field Name | Type | Description | +| ------------------------------------------- | :------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| operationRef | `string` | A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operationObject). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operationObject) in the OpenAPI definition. | +| operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | +| parameters | Map[`string`, Any \| [{expression}](#runtimeExpression)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id). | +| requestBody | Any \| [{expression}](#runtimeExpression) | A literal value or [{expression}](#runtimeExpression) to use as a request body when calling the target operation. | +| description | `string` | A description of the link. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| server | [Server Object](#serverObject) | A server object to be used by the target operation. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +A linked operation MUST be identified using either an `operationRef` or `operationId`. +In the case of an `operationId`, it MUST be unique and resolved in the scope of the OAS document. +Because of the potential for name clashes, the `operationRef` syntax is preferred +for specifications with external references. + +##### Examples + +Computing a link from a request operation where the `$request.path.id` is used to pass a request parameter to the linked operation. + +```yaml +paths: + /users/{id}: + parameters: + - name: id + in: path + required: true + description: the user identifier, as userId + schema: + type: string + get: + responses: + '200': + description: the user being returned + content: + application/json: + schema: + type: object + properties: + uuid: # the unique user id + type: string + format: uuid + links: + address: + # the target link operationId + operationId: getUserAddress + parameters: + # get the `id` field from the request path parameter named `id` + userId: $request.path.id + # the path item of the linked operation + /users/{userid}/address: + parameters: + - name: userid + in: path + required: true + description: the user identifier, as userId + schema: + type: string + # linked operation + get: + operationId: getUserAddress + responses: + '200': + description: the user's address +``` + +When a runtime expression fails to evaluate, no parameter value is passed to the target operation. + +Values from the response body can be used to drive a linked operation. + +```yaml +links: + address: + operationId: getUserAddressByUUID + parameters: + # get the `uuid` field from the `uuid` field in the response body + userUuid: $response.body#/uuid +``` + +Clients follow all links at their discretion. +Neither permissions, nor the capability to make a successful call to that link, is guaranteed +solely by the existence of a relationship. + + +##### OperationRef Examples + +As references to `operationId` MAY NOT be possible (the `operationId` is an optional +field in an [Operation Object](#operationObject)), references MAY also be made through a relative `operationRef`: + +```yaml +links: + UserRepositories: + # returns array of '#/components/schemas/repository' + operationRef: '#/paths/~12.0~1repositories~1{username}/get' + parameters: + username: $response.body#/username +``` + +or an absolute `operationRef`: + +```yaml +links: + UserRepositories: + # returns array of '#/components/schemas/repository' + operationRef: 'https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get' + parameters: + username: $response.body#/username +``` + +Note that in the use of `operationRef`, the _escaped forward-slash_ is necessary when +using JSON references. + + +##### Runtime Expressions + +Runtime expressions allow defining values based on information that will only be available within the HTTP message in an actual API call. +This mechanism is used by [Link Objects](#linkObject) and [Callback Objects](#callbackObject). + +The runtime expression is defined by the following [ABNF](https://tools.ietf.org/html/rfc5234) syntax + +```abnf + expression = ( "$url" / "$method" / "$statusCode" / "$request." source / "$response." source ) + source = ( header-reference / query-reference / path-reference / body-reference ) + header-reference = "header." token + query-reference = "query." name + path-reference = "path." name + body-reference = "body" ["#" json-pointer ] + json-pointer = *( "/" reference-token ) + reference-token = *( unescaped / escaped ) + unescaped = %x00-2E / %x30-7D / %x7F-10FFFF + ; %x2F ('/') and %x7E ('~') are excluded from 'unescaped' + escaped = "~" ( "0" / "1" ) + ; representing '~' and '/', respectively + name = *( CHAR ) + token = 1*tchar + tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "." / + "^" / "_" / "`" / "|" / "~" / DIGIT / ALPHA +``` + +Here, `json-pointer` is taken from [RFC 6901](https://tools.ietf.org/html/rfc6901), `char` from [RFC 7159](https://tools.ietf.org/html/rfc7159#section-7) and `token` from [RFC 7230](https://tools.ietf.org/html/rfc7230#section-3.2.6). + +The `name` identifier is case-sensitive, whereas `token` is not. + +The table below provides examples of runtime expressions and examples of their use in a value: + +##### Examples + +| Source Location | example expression | notes | +| --------------------- | :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | +| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. | +| Requested media type | `$request.header.accept` | +| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. | +| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. | +| Request URL | `$url` | +| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. | +| Response header | `$response.header.Server` | Single header values only are available | + +Runtime expressions preserve the type of the referenced value. +Expressions can be embedded into string values by surrounding the expression with `{}` curly braces. + +#### Header Object + +The Header Object follows the structure of the [Parameter Object](#parameterObject) with the following changes: + +1. `name` MUST NOT be specified, it is given in the corresponding `headers` map. +1. `in` MUST NOT be specified, it is implicitly in `header`. +1. All traits that are affected by the location MUST be applicable to a location of `header` (for example, [`style`](#parameterStyle)). + +##### Header Object Example + +A simple header of type `integer`: + +```json +{ + "description": "The number of allowed requests in the current period", + "schema": { + "type": "integer" + } +} +``` + +```yaml +description: The number of allowed requests in the current period +schema: + type: integer +``` + +#### Tag Object + +Adds metadata to a single tag that is used by the [Operation Object](#operationObject). +It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. + +##### Fixed Fields +| Field Name | Type | `Add-PodeOATag` | Description | +| ------------------------------------------ | :-----------------------------------------------------------: | --------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | `-Name` | **REQUIRED**. The name of the tag. | +| description | `string` | `-Description` | A short description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#externalDocumentationObject) | `-ExternalDocs` | Additional external documentation for this tag. In Pode is an ExternalDoc object created with `New-PodeOAExternalDoc` | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Tag Object Example +```powershell + Add-PodeOATag -Name 'pet' -Description 'Pets operations' +``` + +```json +{ + "name": "pet", + "description": "Pets operations" +} +``` + +```yaml +name: pet +description: Pets operations +``` + +#### Reference Object + +A simple object to allow referencing other components in the specification, internally and externally. + +The Reference Object is defined by [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03) and follows the same structure, behavior and rules. + +For this specification, reference resolution is accomplished as defined by the JSON Reference specification and not by the JSON Schema specification. + +##### Fixed Fields +| Field Name | Type | Description | +| ------------------------------- | :------: | ----------------------------------- | +| $ref | `string` | **REQUIRED**. The reference string. | + +This object cannot be extended with additional properties and any properties added SHALL be ignored. + +Multiple cmdlets support `$ref` : `Merge-PodeOAProperty`, `New-PodeOASchemaProperty`, `Add-PodeOAResponse`, `New-PodeOAResponse` `New-PodeOARequestBody` +##### Reference Object Example + +```powershell +New-PodeOASchemaProperty -Name 'something' -Reference 'Pet' +``` + +```powershell +Merge-PodeOAProperty -Type AllOf -ObjectDefinitions 'Pet','Animal' +``` + +```powershell +Add-PodeOAResponse -Default -Content (New-PodeOAMediaContentType -Content 'Pet') +``` + +```powershell +New-PodeOAResponse -Default -Content (New-PodeOAMediaContentType -Content 'Pet') +``` + +```powershell +New-PodeOAComponentResponse -Name 'Pet' -Default -Content (New-PodeOAMediaContentType -Content 'Pet') +``` + +```json +{ + "$ref": "#/components/schemas/Pet" +} +``` + +```yaml +$ref: '#/components/schemas/Pet' +``` + +##### Relative Schema Document Example +```json +{ + "$ref": "Pet.json" +} +``` + +```yaml +$ref: Pet.yaml +``` + +##### Relative Documents With Embedded Schema Example + +```json +{ + "$ref": "definitions.json#/Pet" +} +``` + +```yaml +$ref: definitions.yaml#/Pet +``` + +#### Schema Object + +The Schema Object allows the definition of input and output data types. +These types can be objects, but also primitives and arrays. +This object is an extended subset of the [JSON Schema Specification Wright Draft 00](https://json-schema.org/). + +For more information about the properties, see [JSON Schema Core](https://tools.ietf.org/html/draft-wright-json-schema-00) and [JSON Schema Validation](https://tools.ietf.org/html/draft-wright-json-schema-validation-00). +Unless stated otherwise, the property definitions follow the JSON Schema. + +##### Properties + +The following properties are taken directly from the JSON Schema definition and follow the same specifications: + +type - Value MUST be a string. Multiple types via an array are not supported. + +| type | cmdlet | +| ------ | -------------------------- | +| int | `New-PodeOAIntProperty` | +| string | `New-PodeOAStringProperty` | +| object | `New-PodeOAObjectProperty` | +| bool | `New-PodeOABoolProperty` | +| number | `New-PodeOANumberProperty` | +| | | + +| Field Name | `New-PodeOAIntProperty` \| `New-PodeOAStringProperty` \| `New-PodeOAObjectProperty` \| `New-PodeOABoolProperty` \| `New-PodeOANumberProperty` | Description | +| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| title | `-Name` or `-Title` | +| multipleOf | `-MultipleOf` | `New-PodeOANumberProperty` \| `New-PodeOAIntProperty` | +| maximum | `-Maximum` | `New-PodeOANumberProperty` \| `New-PodeOAIntProperty` | +| exclusiveMaximum | `-ExclusiveMaximum` | `New-PodeOANumberProperty` \| `New-PodeOAIntProperty` | +| minimum | `-Minimum` | `New-PodeOANumberProperty` \| `New-PodeOAIntProperty` | +| exclusiveMinimum | `-ExclusiveMinimum` | `New-PodeOANumberProperty` \| `New-PodeOAIntProperty` | +| maxLength | `-MaxLength` | `New-PodeOAStringProperty` | +| minLength | `-MinLength` | `New-PodeOAStringProperty` | +| pattern | `-Pattern` | `New-PodeOAStringProperty` - (This string SHOULD be a valid regular expression, according to the [Ecma-262 Edition 5.1 regular expression](https://www.ecma-international.org/ecma-262/5.1/#sec-15.10.1) dialect) | +| maxItems | `-MaxItems` | Used in combination with `-Array` with any New-PodeOAxxxProperty cmdlet | +| minItems | `-MinItems` | Used in combination with `-Array` with any New-PodeOAxxxProperty cmdlet | +| uniqueItems | `-UniqueItems` | Used in combination with `-Array` with any New-PodeOAxxxProperty cmdlet | +| maxProperties | `-MaxProperties` | `New-PodeOAObjectProperty` | +| minProperties | `-MinProperties` | `New-PodeOAObjectProperty` | +| required | `-Required` | `New-PodeOAIntProperty` \| `New-PodeOAStringProperty` \| `New-PodeOABoolProperty` \| `New-PodeOANumberProperty` \| `New-PodeOAObjectProperty` | +| enum | `-Enum` | `New-PodeOAIntProperty` \| `New-PodeOAStringProperty` \| `New-PodeOABoolProperty` \| `New-PodeOANumberProperty` \| `New-PodeOAObjectProperty` | +| items | `-Array` | `New-PodeOAIntProperty` \| `New-PodeOAStringProperty` \| `New-PodeOABoolProperty` \| `New-PodeOANumberProperty` \| `New-PodeOAObjectProperty` | +| description | `-Description` | [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| default | `-Default` | The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level. For example, if `type` is `string`, then `default` can be `"foo"` but cannot be `1`. | +| properties | `-properties` | `New-PodeOAObjectProperty` Property definitions MUST be a [Schema Object](#schemaObject) and not a standard JSON Schema (inline or referenced). | + +| type | `Merge-PodeOAProperty` | Note | +| ----------------------------------------------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| allOf | `-Type AllOf` | | +| oneOf | `-Type OneOf` | (Pode) Doesn't support schema validation | +| anyOf | `-Type AnyOf` | (Pode)Doesn't support schema validation | +| not | Not supported | Will be supported in a future release | +| discriminator | `-Discriminator` | [Discriminator Object](#discriminatorObject) - Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description. See [Composition and Inheritance](#schemaComposition) for more details. | + + + + + +- additionalProperties - Value can be boolean or object. Inline or referenced schema MUST be of a [Schema Object](#schemaObject) and not a standard JSON Schema. Consistent with JSON Schema, `additionalProperties` defaults to `true`. +- format - See [Data Type Formats](#dataTypeFormat) for further details. While relying on JSON Schema's defined formats, the OAS offers a few additional predefined formats. + + +Alternatively, any time a Schema Object can be used, a [Reference Object](#referenceObject) can be used in its place. This allows referencing definitions instead of defining them inline. + +Additional properties defined by the JSON Schema specification that are not mentioned here are strictly unsupported. + +Other than the JSON Schema subset fields, the following fields MAY be used for further schema documentation: + +##### Fixed Fields +| Field Name | Type | | Description | +| --------------------------------------------- | :-----------------------------------------------------------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| nullable | `boolean` | `-Nullable` | A `true` value adds `"null"` to the allowed type specified by the `type` keyword, only if `type` is explicitly defined within the same Schema Object. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of `null` as a value. A `false` value leaves the specified or default `type` unmodified. The default value is `false`. | +| readOnly | `boolean` | `-ReadOnly` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as `readOnly` being `true` and is in the `required` list, the `required` will take effect on the response only. A property MUST NOT be marked as both `readOnly` and `writeOnly` being `true`. Default value is `false`. | +| writeOnly | `boolean` | `-WriteOnly` | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as `writeOnly` being `true` and is in the `required` list, the `required` will take effect on the request only. A property MUST NOT be marked as both `readOnly` and `writeOnly` being `true`. Default value is `false`. | +| xml | [XML Object](#xmlObject) | `-Xml` | This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. | +| externalDocs | [External Documentation Object](#externalDocumentationObject) | `-ExternalDocs` | Additional external documentation for this schema. | +| example | Any | `-Example` | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. | +| deprecated | `boolean` | `-Deprecated` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +###### Composition and Inheritance (Polymorphism) + +The OpenAPI Specification allows combining and extending model definitions using the `allOf` property of JSON Schema, in effect offering model composition. +`allOf` takes an array of object definitions that are validated *independently* but together compose a single object. + +While composition offers model extensibility, it does not imply a hierarchy between the models. +To support polymorphism, the OpenAPI Specification adds the `discriminator` field. +When used, the `discriminator` will be the name of the property that decides which schema definition validates the structure of the model. +As such, the `discriminator` field MUST be a required field. +There are two ways to define the value of a discriminator for an inheriting instance. +- Use the schema name. +- Override the schema name by overriding the property with a new value. If a new value exists, this takes precedence over the schema name. +As such, inline schema definitions, which do not have a given id, *cannot* be used in polymorphism. + +###### XML Modeling + +The [xml](#schemaXml) property allows extra definitions when translating the JSON definition to XML. +The [XML Object](#xmlObject) contains additional information about the available options. + +##### Schema Object Examples + +###### Primitive Sample + +```powershell +New-PodeOAStringProperty -Format 'email' +``` + +```json +{ + "type": "string", + "format": "email" +} +``` + +```yaml +type: string +format: email +``` + +###### Simple Model + +```powershell +New-PodeOAStringProperty -Name 'name'| New-PodeOASchemaProperty -Name 'Address' -Reference 'Address'| + New-PodeOAIntProperty -Name 'age' -Minimum 0 -Format Int32 | New-PodeOAObjectProperty +``` + +```json +{ + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string" + }, + "address": { + "$ref": "#/components/schemas/Address" + }, + "age": { + "type": "integer", + "format": "int32", + "minimum": 0 + } + } +} +``` + +```yaml +type: object +required: +- name +properties: + name: + type: string + address: + $ref: '#/components/schemas/Address' + age: + type: integer + format: int32 + minimum: 0 +``` + +###### Model with Map/Dictionary Properties + +For a simple string to string mapping: + +```powershell +New-PodeOAObjectProperty -AdditionalProperties (New-PodeOAStringProperty ) +``` + +```json +{ + "type": "object", + "additionalProperties": { + "type": "string" + } +} +``` + +```yaml +type: object +additionalProperties: + type: string +``` + +For a string to model mapping: + + +```powershell +New-PodeOAObjectProperty -AdditionalProperties (New-PodeOASchemaProperty -Reference 'ComplexModel') +``` + +```json +{ + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ComplexModel" + } +} +``` + +```yaml +type: object +additionalProperties: + $ref: '#/components/schemas/ComplexModel' +``` + +###### Model with Example + +```powershell +New-PodeOAIntProperty -Name 'id' -Format Int64 | New-PodeOAStringProperty -Name 'name' -Required | + New-PodeOAObjectProperty -Example @{"name"= "Puma"; "id"= 1} +``` + +```json +{ + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + } + }, + "required": [ + "name" + ], + "example": { + "name": "Puma", + "id": 1 + } +} +``` + +```yaml +type: object +properties: + id: + type: integer + format: int64 + name: + type: string +required: +- name +example: + name: Puma + id: 1 +``` + +###### Models with Composition + +```powershell +#Define ErrorModel schema +New-PodeOAStringProperty -Name 'message' | + New-PodeOAIntProperty -Name 'code' -Minimum 100 -Maximum 600 | + New-PodeOAObjectProperty | + Add-PodeOAComponentSchema -Name 'ErrorModel' + +#Define ExtendedErrorModel schema +Merge-PodeOAProperty -Type AllOf -ObjectDefinitions 'ErrorModel', (New-PodeOAStringProperty -Name 'rootCause' -required -object) | + Add-PodeOAComponentSchema -Name 'ExtendedErrorModel' +``` + +```json +{ + "components": { + "schemas": { + "ErrorModel": { + "type": "object", + "required": [ + "message", + "code" + ], + "properties": { + "message": { + "type": "string" + }, + "code": { + "type": "integer", + "minimum": 100, + "maximum": 600 + } + } + }, + "ExtendedErrorModel": { + "allOf": [ + { + "$ref": "#/components/schemas/ErrorModel" + }, + { + "type": "object", + "required": [ + "rootCause" + ], + "properties": { + "rootCause": { + "type": "string" + } + } + } + ] + } + } + } +} +``` + +```yaml +components: + schemas: + ErrorModel: + type: object + required: + - message + - code + properties: + message: + type: string + code: + type: integer + minimum: 100 + maximum: 600 + ExtendedErrorModel: + allOf: + - $ref: '#/components/schemas/ErrorModel' + - type: object + required: + - rootCause + properties: + rootCause: + type: string +``` + +###### Models with Polymorphism Support + +```powershell +#Define Pet schema +New-PodeOAStringProperty -Name 'name'| New-PodeOAStringProperty -Name 'petType' | + New-PodeOAObjectProperty -DiscriminatorProperty 'petType' | Add-PodeOAComponentSchema -Name 'Pet' + +#Define Cat schema +Merge-PodeOAProperty -Type AllOf -ObjectDefinitions 'Pet', +(New-PodeOAStringProperty -Name 'huntingSkill' -Description "The measured skill for hunting" -Default "lazy" -Enum "clueless", "lazy", "adventurous", "aggressive" -Required -Object ) | + Add-PodeOAComponentSchema -Name 'Cat' -Description "A representation of a cat. Note that `Cat` will be used as the discriminator value." + +#Define Dog schema +Merge-PodeOAProperty -Type AllOf -ObjectDefinitions 'Pet', +(New-PodeOAIntProperty -Name 'packSize' -Description "the size of the pack the dog is from" -Default 0 -Minimum 0 -Format Int32 -Required -Object ) | + Add-PodeOAComponentSchema -Name 'Dog' -Description "A representation of a dog. Note that `Dog` will be used as the discriminator value." +``` + +```json +{ + "components": { + "schemas": { + "Pet": { + "type": "object", + "discriminator": { + "propertyName": "petType" + }, + "properties": { + "name": { + "type": "string" + }, + "petType": { + "type": "string" + } + }, + "required": [ + "name", + "petType" + ] + }, + "Cat": { + "description": "A representation of a cat. Note that `Cat` will be used as the discriminator value.", + "allOf": [ + { + "$ref": "#/components/schemas/Pet" + }, + { + "type": "object", + "properties": { + "huntingSkill": { + "type": "string", + "description": "The measured skill for hunting", + "default": "lazy", + "enum": [ + "clueless", + "lazy", + "adventurous", + "aggressive" + ] + } + }, + "required": [ + "huntingSkill" + ] + } + ] + }, + "Dog": { + "description": "A representation of a dog. Note that `Dog` will be used as the discriminator value.", + "allOf": [ + { + "$ref": "#/components/schemas/Pet" + }, + { + "type": "object", + "properties": { + "packSize": { + "type": "integer", + "format": "int32", + "description": "the size of the pack the dog is from", + "default": 0, + "minimum": 0 + } + }, + "required": [ + "packSize" + ] + } + ] + } + } + } +} +``` + +```yaml +components: + schemas: + Pet: + type: object + discriminator: + propertyName: petType + properties: + name: + type: string + petType: + type: string + required: + - name + - petType + Cat: ## "Cat" will be used as the discriminator value + description: A representation of a cat + allOf: + - $ref: '#/components/schemas/Pet' + - type: object + properties: + huntingSkill: + type: string + description: The measured skill for hunting + enum: + - clueless + - lazy + - adventurous + - aggressive + required: + - huntingSkill + Dog: ## "Dog" will be used as the discriminator value + description: A representation of a dog + allOf: + - $ref: '#/components/schemas/Pet' + - type: object + properties: + packSize: + type: integer + format: int32 + description: the size of the pack the dog is from + default: 0 + minimum: 0 + required: + - packSize +``` + +#### Discriminator Object + +When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. + +When using the discriminator, _inline_ schemas will not be considered. + +##### Fixed Fields +| Field Name | Type | `New-PodeOAObjectProperty` | Description | +| ------------------------------------------- | :---------------------: | -------------------------- | --------------------------------------------------------------------------------------------- | +| propertyName | `string` | `-DiscriminatorProperty` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value. | +| mapping | Map[`string`, `string`] | `-DiscriminatorMapping` | An object to hold mappings between payload values and schema names or references. | + +The discriminator object is legal only when using one of the composite keywords `oneOf`, `anyOf`, `allOf`. + +In OAS 3.0, a response payload MAY be described to be exactly one of any number of types: + +```powershell +Merge-PodeOAProperty -Type OneOf -ObjectDefinitions 'Cat','Dog','Lizard' +``` + +```yaml +MyResponseType: + oneOf: + - $ref: '#/components/schemas/Cat' + - $ref: '#/components/schemas/Dog' + - $ref: '#/components/schemas/Lizard' +``` + +which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. In this case, a discriminator MAY act as a "hint" to shortcut validation and selection of the matching schema which may be a costly operation, depending on the complexity of the schema. We can then describe exactly which field tells us which schema to use: + +```powershell +Merge-PodeOAProperty -Type OneOf -ObjectDefinitions 'Cat','Dog','Lizard' -DiscriminatorProperty 'petType' +``` + +```yaml +MyResponseType: + oneOf: + - $ref: '#/components/schemas/Cat' + - $ref: '#/components/schemas/Dog' + - $ref: '#/components/schemas/Lizard' + discriminator: + propertyName: petType +``` + +The expectation now is that a property with name `petType` _MUST_ be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload: + +```json +{ + "id": 12345, + "petType": "Cat" +} +``` + +Will indicate that the `Cat` schema be used in conjunction with this payload. + +In scenarios where the value of the discriminator field does not match the schema name or implicit mapping is not possible, an optional `mapping` definition MAY be used: + +```powershell +Merge-PodeOAProperty -Type OneOf -ObjectDefinitions 'Cat','Dog','Lizard' ` + -DiscriminatorProperty 'petType' -DiscriminatorMapping @{ + 'dog' = '#/components/schemas/Dog' + 'monster' = 'https://gigantic-server.com/schemas/Monster/schema.json' + } +``` + +```yaml +MyResponseType: + oneOf: + - $ref: '#/components/schemas/Cat' + - $ref: '#/components/schemas/Dog' + - $ref: '#/components/schemas/Lizard' + - $ref: 'https://gigantic-server.com/schemas/Monster/schema.json' + discriminator: + propertyName: petType + mapping: + dog: '#/components/schemas/Dog' + monster: 'https://gigantic-server.com/schemas/Monster/schema.json' +``` + +Here the discriminator _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `Dog`. If the discriminator _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison. + +When used in conjunction with the `anyOf` construct, the use of the discriminator can avoid ambiguity where multiple schemas may satisfy a single payload. + +In both the `oneOf` and `anyOf` use cases, all possible schemas MUST be listed explicitly. To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas comprising the parent schema in an `allOf` construct may be used as an alternate schema. + +For example: + +```powershell +New-PodeOAStringProperty -Name 'petType' -Required |New-PodeOAObjectProperty -DiscriminatorProperty 'petType' -DiscriminatorMapping @{ 'dog'='Dog'} | + Add-PodeOAComponentSchema -Name 'Pet' + +Merge-PodeOAProperty -Name -Type AllOf -ObjectDefinitions 'Pet', ( New-PodeOAStringProperty -Name 'name' -Object) | + Add-PodeOAComponentSchema -Name 'Cat' + +Merge-PodeOAProperty -Name -Type AllOf -ObjectDefinitions 'Pet', ( New-PodeOAStringProperty -Name 'bark' -Object) | + Add-PodeOAComponentSchema -Name 'Dog' + + Merge-PodeOAProperty -Name -Type AllOf -ObjectDefinitions 'Pet', ( New-PodeOABoolProperty -Name 'lovesRocks' -Object) | + Add-PodeOAComponentSchema -Name 'Lizard' +``` + +```yaml +components: + schemas: + Pet: + type: object + required: + - petType + properties: + petType: + type: string + discriminator: + propertyName: petType + mapping: + dog: Dog + Cat: + allOf: + - $ref: '#/components/schemas/Pet' + - type: object + # all other properties specific to a `Cat` + properties: + name: + type: string + Dog: + allOf: + - $ref: '#/components/schemas/Pet' + - type: object + # all other properties specific to a `Dog` + properties: + bark: + type: string + Lizard: + allOf: + - $ref: '#/components/schemas/Pet' + - type: object + # all other properties specific to a `Lizard` + properties: + lovesRocks: + type: boolean +``` + +a payload like this: + +```json +{ + "petType": "Cat", + "name": "misty" +} +``` + +will indicate that the `Cat` schema be used. Likewise this schema: + +```json +{ + "petType": "dog", + "bark": "soft" +} +``` + +will map to `Dog` because of the definition in the `mappings` element. + + +#### XML Object + +A metadata object that allows for more fine-tuned XML model definitions. + +When using arrays, XML element names are *not* inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. +See examples for expected behavior. + +##### Fixed Fields +| Field Name | Type | `New-PodeOA(*)Property` | Description | +| ------------------------------------ | :-------: | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | `-XmlName` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. | +| namespace | `string` | `-XmlNameSpace` | The URI of the namespace definition. Value MUST be in the form of an absolute URI. | +| prefix | `string` | `-XmlPrefix` | The prefix to be used for the [name](#xmlName). | +| attribute | `boolean` | `-XmlAttribute` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. | +| wrapped | `boolean` | `-XmlWrapped` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). | + +(*) `New-PodeOAIntProperty` \| `New-PodeOAStringProperty` \| `New-PodeOABoolProperty` \| `New-PodeOANumberProperty` \| `New-PodeOAObjectProperty` \|`New-PodeOASchemaProperty` + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### XML Object Examples + +The examples of the XML object definitions are included inside a property definition of a [Schema Object](#schemaObject) with a sample of the XML representation of it. + +###### No XML Element + +Basic string property: + +```powershell +New-PodeOAStringProperty -Name 'animals' +``` + +```json +{ + "animals": { + "type": "string" + } +} +``` + +```yaml +animals: + type: string +``` + +```xml +... +``` + +Basic string array property ([`wrapped`](#xmlWrapped) is `false` by default): + +```powershell +New-PodeOAStringProperty -Name 'animals' -Array +``` + +```json +{ + "animals": { + "type": "array", + "items": { + "type": "string" + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string +``` + +```xml +... +... +... +``` + +###### XML Name Replacement + +```powershell +New-PodeOAStringProperty -Name 'animals' -XmlName 'animal' +``` + +```json +{ + "animals": { + "type": "string", + "xml": { + "name": "animal" + } + } +} +``` + +```yaml +animals: + type: string + xml: + name: animal +``` + +```xml +... +``` + + +###### XML Attribute, Prefix and Namespace + +In this example, a full model definition is shown. + +```powershell +New-PodeOAIntProperty -Name 'id' -Format Int32 -XmlAttribute | New-PodeOAStringProperty -Name 'name' -XmlPrefix 'sample' -XmlNamespace 'http://example.com/schema/sample' | + New-PodeOAObjectProperty | Add-PodeOAComponentSchema -Name 'Person' +``` + +```json +{ + "Person": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "xml": { + "attribute": true + } + }, + "name": { + "type": "string", + "xml": { + "namespace": "http://example.com/schema/sample", + "prefix": "sample" + } + } + } + } +} +``` + +```yaml +Person: + type: object + properties: + id: + type: integer + format: int32 + xml: + attribute: true + name: + type: string + xml: + namespace: http://example.com/schema/sample + prefix: sample +``` + +```xml + + example + +``` + +###### XML Arrays + +Changing the element names: + +```powershell +New-PodeOAStringProperty -Array -XmlItemName 'animal' | Add-PodeOAComponentSchema -Name 'animals' +``` + +```json +{ + "animals": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "animal" + } + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string + xml: + name: animal +``` + +```xml +value +value +``` + +The external `name` property has no effect on the XML: + +```powershell +New-PodeOAStringProperty -Array -XmlItemName 'animal' -XmlName 'aliens' | Add-PodeOAComponentSchema -Name 'animals' +``` + +```json +{ + "animals": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "animal" + } + }, + "xml": { + "name": "aliens" + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string + xml: + name: animal + xml: + name: aliens +``` + +```xml +value +value +``` + +Even when the array is wrapped, if a name is not explicitly defined, the same name will be used both internally and externally: + +```powershell +New-PodeOAStringProperty -Array -XmlWrapped | Add-PodeOAComponentSchema -Name 'animals' +``` + +```json +{ + "animals": { + "type": "array", + "items": { + "type": "string" + }, + "xml": { + "wrapped": true + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string + xml: + wrapped: true +``` + +```xml + + value + value + +``` + +To overcome the naming problem in the example above, the following definition can be used: + +```powershell +New-PodeOAStringProperty -Array -XmlWrapped -XmlItemName 'animal' | Add-PodeOAComponentSchema -Name 'animals' +``` + +```json +{ + "animals": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "animal" + } + }, + "xml": { + "wrapped": true + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string + xml: + name: animal + xml: + wrapped: true +``` + +```xml + + value + value + +``` + +Affecting both internal and external names: + +```powershell +New-PodeOAStringProperty -Array -XmlWrapped -XmlItemName 'animal' -XmlName 'aliens' | Add-PodeOAComponentSchema -Name 'animals' +``` + +```json +{ + "animals": { + "type": "array", + "items": { + "type": "string", + "xml": { + "name": "animal" + } + }, + "xml": { + "name": "aliens", + "wrapped": true + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string + xml: + name: animal + xml: + name: aliens + wrapped: true +``` + +```xml + + value + value + +``` + +If we change the external element but not the internal ones: + +```json +{ + "animals": { + "type": "array", + "items": { + "type": "string" + }, + "xml": { + "name": "aliens", + "wrapped": true + } + } +} +``` + +```yaml +animals: + type: array + items: + type: string + xml: + name: aliens + wrapped: true +``` + +```xml + + value + value + +``` + +#### Security Scheme Object + +Defines a security scheme that can be used by the operations. +Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in [RFC6749](https://tools.ietf.org/html/rfc6749), and [OpenID Connect Discovery](https://tools.ietf.org/html/draft-ietf-oauth-discovery-06). + +##### Fixed Fields +| Field Name | Type | Applies To | Description | +| ------------------------------------------------------------- | :-------------------------------------: | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. | +| description | `string` | Any | A short description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | +| in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. | +| scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). | +| bearerFormat | `string` | `http` (`"bearer"`) | A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes. | +| flows | [OAuth Flows Object](#oauthFlowsObject) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | +| openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### Security Scheme Object Example + +###### Basic Authentication Sample + +```powershell +New-PodeAuthScheme -Basic | Add-PodeAuth -Name 'basic' -ScriptBlock { + param($username, $password) + # check if the user is valid + return @{ User = $user } +} +``` + +```json +{ + "type": "http", + "scheme": "basic" +} +``` + +```yaml +type: http +scheme: basic +``` + +###### API Key Sample + +```powershell + New-PodeAuthScheme -ApiKey -Location 'Header' | Add-PodeAuth -Name 'ApiKey' -ScriptBlock { + param($key) + # check if the key is valid, and get user + return @{ User = $user } + } +``` + +```json +{ + "type": "apiKey", + "name": "api_key", + "in": "header" +} +``` + +```yaml +type: apiKey +name: api_key +in: header +``` + +###### JWT Bearer Sample + +```powershell +New-PodeAuthScheme -Bearer -AsJWT | Add-PodeAuth -Name 'Example' -Sessionless -ScriptBlock { + param($payload) + # check if the key is valid, and get user + return @{ User = $user } +} +``` + +```json +{ + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT", +} +``` + +```yaml +type: http +scheme: bearer +bearerFormat: JWT +``` + +###### Implicit OAuth2 Sample +```powershell +New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'read:pets' -Description 'read your pets' +New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'write:pets' -Description 'modify pets in your account' + +New-PodeAuthScheme -OAuth2 -ClientId $ClientId -ClientSecret $ClientSecret -AuthoriseUrl "http://example.org/api/oauth/dialog" ` + -TokenUrl 'http://example.org/api/oauth/token' -Scope 'read:pets', 'write:pets' | + Add-PodeAuth -Name 'petstore_auth' -FailureUrl 'http://example.org/api/oauth/dialog' -SuccessUrl '/' -ScriptBlock { + param($user, $accessToken, $refreshToken) + return @{ User = $user } + } +``` + +```json +{ + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://example.com/api/oauth/dialog", + "tokenUrl": "http://example.org/api/oauth/token" + "scopes": { + "write:pets": "modify pets in your account", + "read:pets": "read your pets" + } + } + } +} +``` + +```yaml +type: oauth2 +flows: + implicit: + authorizationUrl: https://example.com/api/oauth/dialog + tokenUrl: http://example.org/api/oauth/token + scopes: + write:pets: modify pets in your account + read:pets: read your pets +``` + +#### OAuth Flows Object + +Allows configuration of the supported OAuth Flows. + +##### Fixed Fields +| Field Name | Type | Description | +| ----------------------------------------------------------- | :-----------------------------------: | ----------------------------------------------------------------------------------------------------- | +| implicit | [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Implicit flow | +| password | [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Resource Owner Password flow | +| clientCredentials | [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. | +| authorizationCode | [OAuth Flow Object](#oauthFlowObject) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +#### OAuth Flow Object + +Configuration details for a supported OAuth Flow + +##### Fixed Fields +| Field Name | Type | Applies To | Description | +| -------------------------------------------------------- | :---------------------: | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. | +| tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. | +| refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. | +| scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. | + +This object MAY be extended with [Specification Extensions](#specificationExtensions). + +##### OAuth Flow Object Examples + +```json +{ + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://example.com/api/oauth/dialog", + "scopes": { + "write:pets": "modify pets in your account", + "read:pets": "read your pets" + } + }, + "authorizationCode": { + "authorizationUrl": "https://example.com/api/oauth/dialog", + "tokenUrl": "https://example.com/api/oauth/token", + "scopes": { + "write:pets": "modify pets in your account", + "read:pets": "read your pets" + } + } + } +} +``` + +```yaml +type: oauth2 +flows: + implicit: + authorizationUrl: https://example.com/api/oauth/dialog + scopes: + write:pets: modify pets in your account + read:pets: read your pets + authorizationCode: + authorizationUrl: https://example.com/api/oauth/dialog + tokenUrl: https://example.com/api/oauth/token + scopes: + write:pets: modify pets in your account + read:pets: read your pets +``` + +#### Security Requirement Object + +Lists the required security schemes to execute this operation. +The name used for each property MUST correspond to a security scheme declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#componentsObject). + +Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. +This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information. + +When a list of Security Requirement Objects is defined on the [OpenAPI Object](#oasObject) or [Operation Object](#operationObject), only one of the Security Requirement Objects in the list needs to be satisfied to authorize the request. + +##### Patterned Fields + +| Field Pattern | Type | Description | +| --------------------------------------------- | :--------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#componentsObject). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MUST be empty. | + +##### Security Requirement Object Examples + +###### Non-OAuth2 Security Requirement + +```powershell +New-PodeAuthScheme -ApiKey | Add-PodeAuth -Name 'api_key' -Sessionless -ScriptBlock { + param($username, $password) + # check if the user is valid + return @{ User = $user } +} +Add-PodeRoute -PassThru -Method Get -Path '/pet/#id' -Authentication 'api_key' -ScriptBlock { + #code here +} +``` + +```json +{ + "/pet2/{petId}": { + "get": { + "petId": { + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "ID of the pet", + "required": true, + "in": "path" + } + }, + "security": [ + { + "api_key": [] + } + ] + } +} +``` + +```yaml +/pet2/{petId} : + get : + petId : + schema : + type : integer + format : int64 + description : ID of the pet + required : true + in : path + security: + - api_key: [] +``` + +###### OAuth2 Security Requirement + +```powershell +New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'read:pets' -Description 'read your pets' +New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'write:pets' -Description 'modify pets in your account' + +New-PodeAuthScheme -OAuth2 -ClientId $ClientId -ClientSecret $ClientSecret -AuthoriseUrl 'http://example.org/api/oauth/dialog' ` + -TokenUrl 'http://example.org/api/oauth/token' -Scope 'read:pets', 'write:pets' | + Add-PodeAuth -Name 'petstore_auth' -FailureUrl 'http://example.org/api/oauth/dialog' -SuccessUrl '/' -ScriptBlock { + param($user, $accessToken, $refreshToken) + #Auth here + return @{ User = $user } + } + +Add-PodeRoute -PassThru -Method post -Path '/pet/#id' -Authentication 'petstore_auth' -Scope 'write:pets', +'read:pets' -ScriptBlock { + #code here +} +``` + +```json +{ + "/pet2/{petId}": { + "post": { + "petId": { + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "ID of the pet", + "required": true, + "in": "path" + } + }, + "security": [ + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } +} +``` + +```yaml +/pet2/{petId} : + post : + petId : + schema : + type : integer + format : int64 + description : ID of the pet + required : true + in : path + security: + - petstore_auth: + - write:pets + - read:pets +``` + +###### Optional OAuth2 Security + +Optional OAuth2 security as would be defined in an OpenAPI Object or an Operation Object: + +```powershell +New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'read:pets' -Description 'read your pets' +New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'write:pets' -Description 'modify pets in your account' + +New-PodeAuthScheme -OAuth2 -ClientId $ClientId -ClientSecret $ClientSecret -AuthoriseUrl 'http://example.org/api/oauth/dialog' ` + -TokenUrl 'http://example.org/api/oauth/token' -Scope 'read:pets', 'write:pets' | + Add-PodeAuth -Name 'petstore_auth' -FailureUrl 'http://example.org/api/oauth/dialog' -SuccessUrl '/' -ScriptBlock { + param($user, $accessToken, $refreshToken) + #Auth here + return @{ User = $user } + } + +Add-PodeRoute -PassThru -Method put -Path '/pet/#id' -Authentication 'petstore_auth' -Scope 'write:pets', +'read:pets' -AllowAnon -ScriptBlock { + #code here +} +``` + +```json +{ + "/pet2/{petId}": { + "post": { + "petId": { + "schema": { + "type": "integer", + "format": "int64" + }, + "description": "ID of the pet", + "required": true, + "in": "path" + } + }, + "security": [ + {}, + { + "petstore_auth": [ + "write:pets", + "read:pets" + ] + } + ] + } +} +``` + +```yaml +/pet2/{petId} : + put : + petId : + schema : + type : integer + format : int64 + description : ID of the pet + required : true + in : path + security: + - petstore_auth: + - write:pets + - read:pets + - {} +``` + +### Specification Extensions + +While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points. + +The extensions properties are implemented as patterned fields that are always prefixed by `"x-"`. + +| Field Pattern | Type | Description | +| -------------------------------- | :---: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. Can have any valid JSON format value. | + +The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced). + +### Security Filtering + +Some objects in the OpenAPI Specification MAY be declared and remain empty, or be completely removed, even though they are inherently the core of the API documentation. + +The reasoning is to allow an additional layer of access control over the documentation. +While not part of the specification itself, certain libraries MAY choose to allow access to parts of the documentation based on some form of authentication/authorization. + +Two examples of this: + +1. The [Paths Object](#pathsObject) MAY be empty. It may be counterintuitive, but this may tell the viewer that they got to the right place, but can't access any documentation. They'd still have access to the [Info Object](#infoObject) which may contain additional information regarding authentication. +2. The [Path Item Object](#pathItemObject) MAY be empty. In this case, the viewer will be aware that the path exists, but will not be able to see any of its operations or parameters. This is different from hiding the path itself from the [Paths Object](#pathsObject), because the user will be aware of its existence. This allows the documentation provider to finely control what the viewer can see. + +## Appendix A: Revision History + +| Version | Date | Notes | +| ---------- | ---------- | ------------------------------------------------- | +| 3.0.3-Pode | 2023-11-20 | OpenAPI Specification 3.0.3 Pode Version | +| 3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 | +| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 | +| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 | +| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | +| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | +| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | +| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | +| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative | +| 2.0 | 2014-09-08 | Release of Swagger 2.0 | +| 1.2 | 2014-03-14 | Initial release of the formal document. | +| 1.1 | 2012-08-22 | Release of Swagger 1.1 | +| 1.0 | 2011-08-10 | First release of the Swagger Specification | diff --git a/examples/OpenApiTuttiFrutti.ps1 b/examples/OpenApiTuttiFrutti.ps1 new file mode 100644 index 000000000..691c1043b --- /dev/null +++ b/examples/OpenApiTuttiFrutti.ps1 @@ -0,0 +1,974 @@ +$path = Split-Path -Parent -Path (Split-Path -Parent -Path $MyInvocation.MyCommand.Path) +if (Test-Path -Path "$($path)/src/Pode.psm1" -PathType Leaf) { + Import-Module "$($path)/src/Pode.psm1" -Force -ErrorAction Stop +} else { + Import-Module -Name 'Pode' +} + +Start-PodeServer -Threads 2 -ScriptBlock { + Add-PodeEndpoint -Address localhost -Port 8081 -Protocol Http -Default + New-PodeLoggingMethod -Terminal | Enable-PodeErrorLogging + $InfoDescription = @' +This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at [http://swagger.io](http://swagger.io). +In the third iteration of the pet store, we've switched to the design first approach! +You can now help us improve the API whether it's by making changes to the definition itself or to the code. +That way, with time, we can improve the API in general, and expose some of the new features in OAS3. + +Some useful links: +- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore) +- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml) +'@ + + + + #Enable-PodeOpenApi -Path '/docs/openapi' -OpenApiVersion '3.0.0' -EnableSchemaValidation -DisableMinimalDefinitions -DefaultResponses @{} + # New-PodeOAExternalDoc -Name 'SwaggerDocs' -Description 'Find out more about Swagger' -Url 'http://swagger.io' + # Add-PodeOAExternalDoc -Reference 'SwaggerDocs' + + Enable-PodeOpenApi -Path '/docs/openapi/v3.0' -OpenApiVersion '3.0.3' -EnableSchemaValidation -DisableMinimalDefinitions -NoDefaultResponses -DefinitionTag 'v3' + Enable-PodeOpenApi -Path '/docs/openapi/v3.1' -OpenApiVersion '3.1.0' -EnableSchemaValidation -DisableMinimalDefinitions -NoDefaultResponses -DefinitionTag 'v3.1' + $swaggerDocs = New-PodeOAExternalDoc -Description 'Find out more about Swagger' -Url 'http://swagger.io' + + $swaggerDocs | Add-PodeOAExternalDoc -DefinitionTag 'v3', 'v3.1' + + + # Add-PodeOAInfo -Title 'Swagger Petstore - OpenAPI 3.0' -Version 1.0.17 -Description $InfoDescription -TermsOfService 'http://swagger.io/terms/' -LicenseName 'Apache 2.0' -LicenseUrl 'http://www.apache.org/licenses/LICENSE-2.0.html' -ContactName 'API Support' -ContactEmail 'apiteam@swagger.io' -ContactUrl 'http://example.com/support' + + + Add-PodeOAServerEndpoint -url '/api/v3' -Description 'default endpoint' -DefinitionTag 'v3', 'v3.1' + + Add-PodeOAInfo -Title 'Swagger Petstore - OpenAPI 3.0' -Version 1.0.17 -Description $InfoDescription -TermsOfService 'http://swagger.io/terms/' -LicenseName 'Apache 2.0' ` + -LicenseUrl 'http://www.apache.org/licenses/LICENSE-2.0.html' -ContactName 'API Support' -ContactEmail 'apiteam@swagger.io' -DefinitionTag 'v3' + + Add-PodeOAInfo -Title 'Swagger Petstore - OpenAPI 3.1' -Version 1.0.17 -Description $InfoDescription -TermsOfService 'http://swagger.io/terms/' -LicenseName 'Apache 2.0' ` + -LicenseUrl 'http://www.apache.org/licenses/LICENSE-2.0.html' -ContactName 'API Support' -ContactEmail 'apiteam@swagger.io' -DefinitionTag 'v3.1' + + + Enable-PodeOAViewer -Type Swagger -Path '/docs/swagger' -DefinitionTag 'v3' + Enable-PodeOAViewer -Type ReDoc -Path '/docs/redoc' -DarkMode -DefinitionTag 'v3' + Enable-PodeOAViewer -Type RapiDoc -Path '/docs/rapidoc' -DarkMode -DefinitionTag 'v3' + Enable-PodeOAViewer -Type StopLight -Path '/docs/stoplight' -DarkMode -DefinitionTag 'v3' + Enable-PodeOAViewer -Type Explorer -Path '/docs/explorer' -DarkMode -DefinitionTag 'v3' + Enable-PodeOAViewer -Type RapiPdf -Path '/docs/rapipdf' -DarkMode -DefinitionTag 'v3' + Enable-PodeOAViewer -Editor -DefinitionTag 'v3' + Enable-PodeOAViewer -Bookmarks -Path '/docs' -DefinitionTag 'v3' + + + Enable-PodeOAViewer -Type Swagger -Path '/docs/v3.1/swagger' -DefinitionTag 'v3.1' + Enable-PodeOAViewer -Type ReDoc -Path '/docs/v3.1/redoc' -DarkMode -DefinitionTag 'v3.1' + Enable-PodeOAViewer -Type RapiDoc -Path '/docs/v3.1/rapidoc' -DarkMode -DefinitionTag 'v3.1' + Enable-PodeOAViewer -Type StopLight -Path '/docs/v3.1/stoplight' -DarkMode -DefinitionTag 'v3.1' + Enable-PodeOAViewer -Type Explorer -Path '/docs/v3.1/explorer' -DarkMode -DefinitionTag 'v3.1' + + Enable-PodeOAViewer -Bookmarks -Path '/docs/v3.1' -DefinitionTag 'v3.1' + + Select-PodeOADefinition -Tag 'v3', 'v3.1' -Scriptblock { + + Add-PodeOATag -Name 'user' -Description 'Operations about user' -ExternalDoc $swaggerDocs + Add-PodeOATag -Name 'store' -Description 'Access to Petstore orders' -ExternalDoc $swaggerDocs + Add-PodeOATag -Name 'pet' -Description 'Everything about your Pets' -ExternalDoc $swaggerDocs + + + <# Add-PodeOAComponentSchema -Name 'Address' -Schema ( + New-PodeOAObjectProperty -Name 'Address' -XmlName 'address' } -Description 'Shipping Address' -Properties ( + New-PodeOAStringProperty -Name 'street' -Example '437 Lytton' -Required | + New-PodeOAStringProperty -Name 'city' -Example 'Palo Alto' -Required | + New-PodeOAStringProperty -Name 'state' -Example 'CA' -Required | + New-PodeOAStringProperty -Name 'zip' -Example '94031' -Required + )) + Merge-PodeOAProperty -Type OneOf -ObjectDefinitions @( + (New-PodeOAIntProperty -Name 'userId' -Object), + (New-PodeOAStringProperty -Name 'name' -Object), + (New-PodeOABoolProperty -Name 'enabled' -Object) + )|Add-PodeOAComponentSchema -Name 'Test123' + + New-PodeOAStringProperty -Name 'lastName' -Example 'James' | + New-PodeOAObjectProperty -Name 'User' -XmlName 'user' } -Properties ( + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 1 -ReadOnly | + New-PodeOAStringProperty -Name 'username' -Example 'theUser' -Required ) | + New-PodeOAStringProperty -Name 'username' -Example 'theUser' -Required | + New-PodeOAStringProperty -Name 'firstName' -Example 'John' | + New-PodeOAStringProperty -Name 'lastName' -Example 'James' | + New-PodeOAObjectProperty -Name 'test' | Add-PodeOAComponentSchema -Name 'Test' + +#> + New-PodeOAStringProperty -Name 'street' -Example '437 Lytton' -Required | + New-PodeOAStringProperty -Name 'city' -Example 'Palo Alto' -Required | + New-PodeOAStringProperty -Name 'state' -Example 'CA' -Required | + New-PodeOAStringProperty -Name 'zip' -Example '94031' -Required | + New-PodeOAObjectProperty -Name 'Address' -XmlName 'address' -Description 'Shipping Address' | + Add-PodeOAComponentSchema -Name 'Address' + + + New-PodeOAIntProperty -Name 'id'-Format Int64 -ReadOnly -Example 10 | + New-PodeOAIntProperty -Name 'petId' -Format Int64 -Example 198772 | + New-PodeOAIntProperty -Name 'quantity' -Format Int32 -Example 7 | + New-PodeOAStringProperty -Name 'shipDate' -Format Date-Time | + New-PodeOAStringProperty -Name 'status' -Description 'Order Status' -Example 'approved' -Enum @('placed', 'approved', 'delivered') | + New-PodeOABoolProperty -Name 'complete' | + New-PodeOASchemaProperty -Name 'Address' -Reference 'Address' | + New-PodeOAObjectProperty -Name 'Order' -XmlName 'order' -AdditionalProperties (New-PodeOAStringProperty ) | + Add-PodeOAComponentSchema -Name 'Order' + + Add-PodeOAComponentSchema -Name 'Category' -Schema ( + New-PodeOAObjectProperty -Name 'Category' -XmlName 'category' -Properties ( + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 1 | + New-PodeOAStringProperty -Name 'name' -Example 'Dogs' + )) + + Add-PodeOAComponentSchema -Name 'User' -Schema ( + New-PodeOAObjectProperty -Name 'User' -XmlName 'user' -Properties ( + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 1 -ReadOnly | + New-PodeOAStringProperty -Name 'username' -Example 'theUser' -Required | + New-PodeOAStringProperty -Name 'firstName' -Example 'John' | + New-PodeOAStringProperty -Name 'lastName' -Example 'James' | + New-PodeOAStringProperty -Name 'email' -Format email -Example 'john@email.com' | + New-PodeOAStringProperty -Name 'lastName' -Example 'James' | + New-PodeOAStringProperty -Name 'password' -Format Password -Example '12345' -Required | + New-PodeOAStringProperty -Name 'phone' -Example '12345' | + New-PodeOAIntProperty -Name 'userStatus'-Format int32 -Description 'User Status' -Example 1 + )) + + Merge-PodeOAProperty -Type AllOf -ObjectDefinitions 'Address', 'User' | Add-PodeOAComponentSchema -Name 'aaaaa' + Add-PodeOAComponentSchema -Name 'Tag' -Component ( + New-PodeOAObjectProperty -Name 'Tag' -XmlName 'tag' -Properties ( + New-PodeOAIntProperty -Name 'id'-Format Int64 | + New-PodeOAStringProperty -Name 'name' + )) + + Add-PodeOAComponentSchema -Name 'Pet' -Component ( + New-PodeOAObjectProperty -Name 'Pet' -XmlName 'pet' -Properties ( + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example @(10, 2, 4) -ReadOnly | + New-PodeOAStringProperty -Name 'name' -Example 'doggie' -Required | + New-PodeOASchemaProperty -Name 'category' -Reference 'Category' | + New-PodeOAStringProperty -Name 'petType' -Example 'dog' -Required | + New-PodeOAStringProperty -Name 'photoUrls' -Array | + New-PodeOASchemaProperty -Name 'tags' -Reference 'Tag' | + New-PodeOAStringProperty -Name 'status' -Description 'pet status in the store' -Enum @('available', 'pending', 'sold') + )) + + Merge-PodeOAProperty -Type AllOf -ObjectDefinitions 'Pet', ( + New-PodeOAStringProperty -Name 'huntingSkill' -Description 'The measured skill for hunting' -Enum @( 'clueless', 'lazy', 'adventurous', 'aggressive') | New-PodeOAObjectProperty + ) | Add-PodeOAComponentSchema -Name 'NewCat' + + #XML teest + New-PodeOAIntProperty -Name 'id' -Format Int32 -XmlAttribute | New-PodeOAStringProperty -Name 'name' -XmlPrefix 'sample' -XmlNamespace 'http://example.com/schema/sample' | + New-PodeOAObjectProperty | Add-PodeOAComponentSchema -Name 'XmlPrefixAndNamespace' + + New-PodeOAStringProperty -Array -XmlItemName 'animal' | Add-PodeOAComponentSchema -Name 'animals' + + New-PodeOAStringProperty -Array -XmlItemName 'animal' -XmlName 'aliens' | Add-PodeOAComponentSchema -Name 'AnimalsNoAliens' + + New-PodeOAStringProperty -Array -XmlWrapped | Add-PodeOAComponentSchema -Name 'WrappedAnimals' + + New-PodeOAStringProperty -Array -XmlWrapped -XmlItemName 'animal' | Add-PodeOAComponentSchema -Name 'WrappedAnimal' + + New-PodeOAStringProperty -Array -XmlWrapped -XmlItemName 'animal' -XmlName 'aliens' | Add-PodeOAComponentSchema -Name 'WrappedAliens' + + New-PodeOAStringProperty -Array -XmlWrapped -XmlName 'aliens' | Add-PodeOAComponentSchema -Name 'WrappedAliensWithItems' + + + New-PodeOAStringProperty -Name 'name' | + New-PodeOAStringProperty -Name 'type' | + New-PodeOASchemaProperty -Name 'children' -Array -Reference 'StructPart' | + New-PodeOAObjectProperty | + Add-PodeOAComponentSchema -Name 'StructPart' + + + #Define Pet schema + New-PodeOAStringProperty -Name 'name' | New-PodeOAStringProperty -Name 'petType' | + New-PodeOAObjectProperty -DiscriminatorProperty 'petType' | Add-PodeOAComponentSchema -Name 'Pet2' + + #Define Cat schema + Merge-PodeOAProperty -Type AllOf -ObjectDefinitions 'Pet2', +(New-PodeOAStringProperty -Name 'huntingSkill' -Description 'The measured skill for hunting' -Default 'lazy' -Enum 'clueless', 'lazy', 'adventurous', 'aggressive' -Required -Object ) | + Add-PodeOAComponentSchema -Name 'Cat2' -Description "A representation of a cat. Note that `Cat` will be used as the discriminator value." + + + #Define Dog schema + Merge-PodeOAProperty -Type AllOf -ObjectDefinitions 'Pet2', +(New-PodeOAIntProperty -Name 'packSize' -Description 'the size of the pack the dog is from' -Default 0 -Minimum 0 -Format Int32 -Required -Object ) | + Add-PodeOAComponentSchema -Name 'Dog2' -Description "A representation of a dog. Note that `Dog` will be used as the discriminator value." + + + <# Alternative : + Add-PodeOAComponentSchema -Name 'Pet' -Schema ( + New-PodeOAObjectProperty -Name 'Pet' -XmlName 'pet' } -Properties @( + (New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 10 -ReadOnly), + (New-PodeOAStringProperty -Name 'name' -Example 'doggie' -Required), + (New-PodeOASchemaProperty -Name 'category' -Component 'Category'), + (New-PodeOAStringProperty -Name 'petType' -Example 'dog' -Required), + (New-PodeOAStringProperty -Name 'photoUrls' -Array), + (New-PodeOASchemaProperty -Name 'tags' -Component 'Tag') + (New-PodeOAStringProperty -Name 'status' -Description 'pet status in the store' -Enum @('available', 'pending', 'sold')) + )) #> + + <# Add-PodeOAComponentSchema -Name 'Cat' -Schema ( New-PodeOAObjectProperty -Name 'testcat' -Description 'Type of cat' -Properties ( + New-PodeOAStringProperty -Name 'breed' -Description 'Type of Breed' -Enum @( 'Abyssinian', 'Balinese-Javanese', 'Burmese', 'British Shorthair') | + Merge-PodeOAProperty -Type AllOf -ObjectDefinitions @( 'Pet', + (New-PodeOAStringProperty -Name 'huntingSkill' -Description 'The measured skill for hunting' -Enum @( 'clueless', 'lazy', 'adventurous', 'aggressive') -Object) + ) + ) + )#> + Merge-PodeOAProperty -Type AllOf -ObjectDefinitions 'Pet', (New-PodeOAStringProperty -Name 'rootCause' -required -object) | + Add-PodeOAComponentSchema -Name 'ExtendedErrorModel' + + New-PodeOAStringProperty -Name 'huntingSkill' -Description 'The measured skill for hunting' -Enum @( 'clueless', 'lazy', 'adventurous', 'aggressive') -Object | + Merge-PodeOAProperty -Type AllOf -ObjectDefinitions 'Pet' | + New-PodeOAStringProperty -Name 'breed' -Description 'Type of Breed' -Enum @( 'Abyssinian', 'Balinese-Javanese', 'Burmese', 'British Shorthair') | + + New-PodeOAObjectProperty -Description 'Type of cat' | Add-PodeOAComponentSchema -Name 'Cat' + + + + + + Add-PodeOAComponentSchema -Name 'Dog' -Component ( + Merge-PodeOAProperty -Type AllOf -ObjectDefinitions @( 'Pet', ( New-PodeOAObjectProperty -Properties ( + New-PodeOAStringProperty -Name 'breed' -Description 'Type of Breed' -Enum @( 'Dingo', 'Husky', 'Retriever', 'Shepherd') | + New-PodeOABoolProperty -Name 'bark' + )) + ) + ) + + + Add-PodeOAComponentSchema -Name 'Pets' -Component ( + Merge-PodeOAProperty -Type OneOf -ObjectDefinitions @( 'Cat', 'Dog') -DiscriminatorProperty 'petType') + + + Add-PodeOAComponentSchema -Name 'ApiResponse' -Component ( + New-PodeOAObjectProperty -Name 'ApiResponse' -XmlName '##default' -Properties ( + New-PodeOAIntProperty -Name 'code'-Format Int32 | + New-PodeOAStringProperty -Name 'type' -Example 'doggie' | + New-PodeOAStringProperty -Name 'message' + ) + ) + + New-PodeOAStringProperty -Name 'message' | New-PodeOAIntProperty -Name 'code'-Format Int32 | New-PodeOAObjectProperty | Add-PodeOAComponentSchema -Name 'ErrorModel' + + + Add-PodeRoute -PassThru -Method Get -Path '/peta/:id' -ScriptBlock { + Write-PodeJsonResponse -Value (Get-Pet -Id $WebEvent.Parameters['id']) -StatusCode 200 + } | + Set-PodeOARouteInfo -Summary 'Find pets by ID' -Description 'Returns pets based on ID' -OperationId 'getPetsById' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + ( New-PodeOAStringProperty -Name 'id' -Description 'ID of pet to use' -array | ConvertTo-PodeOAParameter -In Path -Style Simple -Required )) | + Add-PodeOAResponse -StatusCode 200 -Description 'pet response' -Content (@{ '*/*' = New-PodeOASchemaProperty -Reference 'Pet' -array }) -PassThru | + Add-PodeOAResponse -Default -Description 'error payload' -Content (@{ 'text/html' = 'ApiResponse' }) -PassThru + + + + + + New-PodeOAIntProperty -Format Int32 -Description 'calls per hour allowed by the user' | Add-PodeOAComponentHeader -Name 'X-Rate-Limit' + New-PodeOAStringProperty -Format Date-Time -Description 'date in UTC when token expires' | Add-PodeOAComponentHeader -Name 'X-Expires-After' + + #define '#/components/responses/' + Add-PodeOAComponentResponse -Name 'UserOpSuccess' -Description 'Successful operation' -ContentSchemas (@{'application/json' = 'User' ; 'application/xml' = 'User' }) + + Add-PodeOAComponentRequestBody -Name 'PetBodySchema' -Required -Description 'Pet in the store' -ContentSchemas (@{ 'application/json' = 'Pets'; 'application/xml' = 'Pets'; 'application/x-www-form-urlencoded' = 'Pets' }) + + + #define '#/components/parameters/' + Add-PodeOAComponentParameter -Name 'PetIdParam' -Parameter ( New-PodeOAIntProperty -Name 'petId' -Format Int64 -Description 'ID of the pet' -Required | ConvertTo-PodeOAParameter -In Path ) + } + + + + # setup apikey authentication to validate a user + New-PodeAuthScheme -ApiKey -LocationName 'api_key' | Add-PodeAuth -Name 'api_key' -Sessionless -ScriptBlock { + param($key) + if ($key) { + # here you'd check a real storage, this is just for example + if ($key -eq 'test-key') { + return @{ + User = @{ + 'ID' = 'M0R7Y302' + 'Name' = 'Morty' + 'Type' = 'Human' + } + } + } + + # authentication failed + return @{ + Code = 401 + Challenge = 'qop="auth", nonce=""' + } + } else { + return @{ + Message = 'No Authorization header found' + Code = 401 + } + + } + } + New-PodeAuthScheme -Basic | Add-PodeAuth -Name 'Login' -Sessionless -ScriptBlock { + param($username, $password) + # check if the user is valid + return @{ User = $user } + } + New-PodeAuthScheme -ApiKey | Add-PodeAuth -Name 'LoginApiKey' -Sessionless -ScriptBlock { + param($username, $password) + # check if the user is valid + return @{ User = $user } + } + # jwt with no signature: + New-PodeAuthScheme -Bearer -AsJWT | Add-PodeAuth -Name 'Jwt' -Sessionless -ScriptBlock { + param($payload) + + return ConvertFrom-PodeJwt -Token $payload + } + + + New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'read' -Description 'Grant read-only access to all your data except for the account and user info' + New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'write' -Description 'Grant write-only access to all your data except for the account and user info' + New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'profile' -Description 'Grant read-only access to the account and user info only' + # setup session details + Enable-PodeSessionMiddleware -Duration 120 -Extend + + $clientId = '123123123' + $clientSecret = 'acascascasca>zzzcz' + $tenantId = '56456232' + + <# $InnerScheme = New-PodeAuthScheme -Form + $scheme = New-PodeAuthScheme ` + -OAuth2 ` + -ClientId $ClientId ` + -ClientSecret $ClientSecret ` + -AuthoriseUrl "https://login.microsoftonline.com/$($tenantId)/oauth2/v2.0/authorize" ` + -TokenUrl "https://login.microsoftonline.com/$($tenantId)/oauth2/v2.0/token" ` + -UserUrl 'https://graph.microsoft.com/oidc/userinfo' ` + -RedirectUrl $RedirectUrl ` + -InnerScheme $InnerScheme ` + # -Middleware $Middleware ` + -Scope 'read', 'write', 'profile' + $scheme | Add-PodeAuth -Name 'Login-OAuth2' -FailureUrl '/LoginOAuth2' -SuccessUrl '/' -ScriptBlock { + param($user, $accessToken, $refreshToken) + return @{ User = $user } + }#> + New-PodeAuthScheme ` + -OAuth2 ` + -ClientId $ClientId ` + -ClientSecret $ClientSecret ` + -AuthoriseUrl 'http://example.org/api/oauth/dialog' ` + -TokenUrl 'http://example.org/api/oauth/token' ` + -Scope 'read', 'write' | Add-PodeAuth -Name 'Login-OAuth2' -FailureUrl '/LoginOAuth2' -SuccessUrl '/' -ScriptBlock { + param($user, $accessToken, $refreshToken) + return @{ User = $user } + } + Merge-PodeAuth -Name 'test' -Authentication 'Login-OAuth2', 'api_key' + + $ex = + New-PodeOAExample -MediaType 'application/json' -Name 'user' -Summary 'User Example' -ExternalValue 'http://foo.bar/examples/user-example.json' | + New-PodeOAExample -MediaType 'application/xml' -Name 'user' -Summary 'User Example in XML' -ExternalValue 'http://foo.bar/examples/user-example.xml' | + New-PodeOAExample -MediaType 'text/plain' -Name 'user' -Summary 'User Example in Plain text' -ExternalValue 'http://foo.bar/examples/user-example.txt' | + New-PodeOAExample -MediaType '*/*' -Name 'user' -Summary 'User example in other forma' -ExternalValue 'http://foo.bar/examples/user-example.whatever' + Select-PodeOADefinition -Tag 'v3' -Scriptblock { + Add-PodeRouteGroup -Path '/api/v4' -Routes { + + Add-PodeRoute -PassThru -Method Put -Path '/pat/:petId' -ScriptBlock { + $JsonPet = ConvertTo-Json $WebEvent.data + if ( Update-Pet -Id $WebEvent.Parameters['petId'] -Data $JsonPet) { + Write-PodeJsonResponse -Value @{} -StatusCode 200 + } else { + Write-PodeJsonResponse -Value @{} -StatusCode 405 + } + } | Set-PodeOARouteInfo -Summary 'Updates a pet in the store with form data' -Tags 'pet' -OperationId 'updatePasdadaetWithForm' -PassThru | + Set-PodeOARequest -Parameters @( + (New-PodeOAStringProperty -Name 'petId' -Description 'ID of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Path -Required) + ) -RequestBody ( + New-PodeOARequestBody -Description 'user to add to the system' -Content @{ 'application/json' = 'User'; 'application/xml' = 'User' } -Examples $ex + + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Pet updated.' -Content (@{ 'application/json' = '' ; 'application/xml' = '' }) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Method Not Allowed' -Content (@{ 'application/json' = '' ; 'application/xml' = '' }) + + Add-PodeRoute -PassThru -Method Put -Path '/paet/:petId' -ScriptBlock { + $JsonPet = ConvertTo-Json $WebEvent.data + if ( Update-Pet -Id $WebEvent.Parameters['id'] -Data $JsonPet) { + Write-PodeJsonResponse -Value @{} -StatusCode 200 + } else { + Write-PodeJsonResponse -Value @{} -StatusCode 405 + } + } | Set-PodeOARouteInfo -Summary 'Updates a pet in the store with form data' -Tags 'pet' -OperationId 'updatepaet' -PassThru | + Set-PodeOARequest -Parameters @( + (New-PodeOAStringProperty -Name 'petId' -Description 'ID of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Path -Required -Examples ( + New-PodeOAExample -Name 'user' -Summary 'User Example' -Value 'http://foo.bar/examples/user-example.json' | + New-PodeOAExample -Name 'user1' -Summary 'User Example in XML' -Value 'http://foo.bar/examples/user-example.xml' | + New-PodeOAExample -Name 'user2' -Summary 'User Example in Plain text' -Value 'http://foo.bar/examples/user-example.txt' | + New-PodeOAExample -Name 'user3' -Summary 'User example in other forma' -Value 'http://foo.bar/examples/user-example.whatever' )) + ) -RequestBody (New-PodeOARequestBody -Required -Content (@{ + 'application/x-www-form-urlencoded' = New-PodeOAObjectProperty -Properties @( + (New-PodeOAStringProperty -Name 'name' -Description 'Updated name of the pet'), + (New-PodeOAStringProperty -Name 'status' -Description 'Updated status of the pet' -Required) + ) + }) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Pet updated.' -Content (@{ 'application/json' = '' ; 'application/xml' = '' }) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Method Not Allowed' -Content (@{ 'application/json' = '' ; 'application/xml' = '' }) + + + #Start 3.1 + Select-PodeOADefinition -Tag 'v3.1' -Scriptblock { + + Add-PodeOAComponentPathItem -Name 'GetPetByIdWithRef' -Method Get -PassThru | Set-PodeOARouteInfo -Summary 'Find pet by ID' -Description 'Returns a single pet.' -Tags 'pet' -OperationId 'getPetByIdWithRef' -PassThru | + Set-PodeOARequest -PassThru -Parameters ( + New-PodeOAIntProperty -Name 'petId' -Description 'ID of pet to return' -Format Int64 | + ConvertTo-PodeOAParameter -In Path -Required ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet') -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Pet not found' -PassThru | + Add-PodeOAResponse -StatusCode 415 + + Add-PodeOAWebhook -Name 'newPet' -Method Post -PassThru | Set-PodeOARouteInfo -Description 'Information about a new pet in the system' -PassThru | + Set-PodeOARequest -PassThru -RequestBody ( + New-PodeOARequestBody -Content @{ 'application/json' = 'Pets' } + ) | Add-PodeOAResponse -StatusCode 200 -Description 'Return a 200 status to indicate that the data was received successfully' + + } + #end 3.1 + Add-PodeRoute -PassThru -Method Put -Path '/paet2/:petId' -ScriptBlock { + $JsonPet = ConvertTo-Json $WebEvent.data + if ( Update-Pet -Id $WebEvent.Parameters['id'] -Data $JsonPet) { + Write-PodeJsonResponse -Value @{} -StatusCode 200 + } else { + Write-PodeJsonResponse -Value @{} -StatusCode 405 + } + } | Set-PodeOARouteInfo -Summary 'Updates a pet in the store with form data' -Tags 'pet' -OperationId 'updatepaet2' -PassThru | + Set-PodeOARequest -Parameters @( + (New-PodeOAStringProperty -Name 'petId' -Description 'ID of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Path -Required) + ) -RequestBody (New-PodeOARequestBody -Description 'user to add to the system' -Content @{ 'text/plain' = New-PodeOAStringProperty -array } ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Pet updated.' -Content (@{ 'application/json' = '' ; 'application/xml' = '' }) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Method Not Allowed' -Content (@{ 'application/json' = '' ; 'application/xml' = '' }) + + + + $ex = + New-PodeOAExample -MediaType 'application/json' -Name 'user' -Summary 'User Example' -ExternalValue 'http://foo.bar/examples/user-example.json' | + New-PodeOAExample -MediaType 'application/xml' -Name 'user' -Summary 'User Example in XML' -ExternalValue 'http://foo.bar/examples/user-example.xml' | + New-PodeOAExample -MediaType 'text/plain' -Name 'user' -Summary 'User Example in Plain text' -ExternalValue 'http://foo.bar/examples/user-example.txt' | + New-PodeOAExample -MediaType '*/*' -Name 'user' -Summary 'User example in other forma' -ExternalValue 'http://foo.bar/examples/user-example.whatever' + + Add-PodeOAComponentExample -name 'frog-example' -Summary "An example of a frog with a cat's name" -Value @{name = 'Jaguar'; petType = 'Panthera'; color = 'Lion'; gender = 'Male'; breed = 'Mantella Baroni' } + + Add-PodeRoute -PassThru -Method Put -Path '/paet3/:petId' -ScriptBlock { + $JsonPet = ConvertTo-Json $WebEvent.data + if ( Update-Pet -Id $WebEvent.Parameters['id'] -Data $JsonPet) { + Write-PodeJsonResponse -Value @{} -StatusCode 200 + } else { + Write-PodeJsonResponse -Value @{} -StatusCode 405 + } + } | Set-PodeOARouteInfo -Summary 'Updates a pet in the store with form data' -Tags 'pet' -OperationId 'updatepaet3' -PassThru | + Set-PodeOARequest -Parameters @( + (New-PodeOAStringProperty -Name 'petId' -Description 'ID of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Path -Required) + ) -RequestBody (New-PodeOARequestBody -Description 'user to add to the system' -Content @{ 'application/json' = 'NewCat' } -Examples ( + New-PodeOAExample -MediaType 'application/json' -Name 'cat' -Summary 'An example of a cat' -Value @{name = 'Fluffy'; petType = 'Cat'; color = 'White'; gender = 'male'; breed = 'Persian' } | + New-PodeOAExample -MediaType 'application/json' -Name 'dog' -Summary "An example of a dog with a cat's name" -Value @{name = 'Puma'; petType = 'Dog'; color = 'Black'; gender = 'Female'; breed = 'Mixed' } | + New-PodeOAExample -MediaType 'application/json' -Reference 'frog-example' + ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Pet updated.' -Content (@{ 'application/json' = '' ; 'application/xml' = '' }) -PassThru | + Add-PodeOAResponse -StatusCode 4XX -Description 'Method Not Allowed' -Content (@{ 'application/json' = '' ; 'application/xml' = '' }) + + + Add-PodeRoute -PassThru -Method Put -Path '/paet4/:petId' -ScriptBlock { + $JsonPet = ConvertTo-Json $WebEvent.data + if ( Update-Pet -Id $WebEvent.Parameters['id'] -Data $JsonPet) { + Write-PodeJsonResponse -Value @{} -StatusCode 200 + } else { + Write-PodeJsonResponse -Value @{} -StatusCode 405 + } + } | Set-PodeOARouteInfo -Summary 'Updates a pet in the store with form data' -Tags 'pet' -OperationId 'updatepaet4' -PassThru | + Set-PodeOARequest -Parameters @( + (New-PodeOAStringProperty -Name 'petId' -Description 'ID of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Path -Required -ContentType 'application/json') + ) -RequestBody (New-PodeOARequestBody -Description 'user to add to the system' -Content @{ 'application/json' = 'Pet' } -Examples ( + New-PodeOAExample -MediaType 'application/json' -Name 'cat' -Summary 'An example of a cat' -Value @{name = 'Fluffy'; petType = 'Cat'; color = 'White'; gender = 'male'; breed = 'Persian' } | + New-PodeOAExample -MediaType 'application/json' -Name 'dog' -Summary "An example of a dog with a cat's name" -Value @{name = 'Puma'; petType = 'Dog'; color = 'Black'; gender = 'Female'; breed = 'Mixed' } | + New-PodeOAExample -MediaType 'application/json' -Reference 'frog-example' + ) + + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Pet updated.' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content '') -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Method Not Allowed' -Content (@{ 'application/json' = '' ; 'application/xml' = '' }) + + } + } + Add-PodeAuthMiddleware -Name test -Authentication 'test' -Route '/api/*' + Select-PodeOADefinition -Tag 'v3.1', 'v3' -Scriptblock { + Add-PodeRouteGroup -Path '/api/v3' -Routes { + #PUT + Add-PodeRoute -PassThru -Method Put -Path '/pet' -ScriptBlock { + $JsonPet = ConvertTo-Json $WebEvent.data + $Validate = Test-PodeOAJsonSchemaCompliance -Json $JsonPet -SchemaReference 'Pet' + if ($Validate.result) { + $Pet = $WebEvent.data + $Pet.tags.id = Get-Random -Minimum 1 -Maximum 9999999 + Write-PodeJsonResponse -Value ($Pet | ConvertTo-Json -Depth 20 ) -StatusCode 200 + } else { + Write-PodeJsonResponse -StatusCode 405 -Value @{ + result = $Validate.result + message = $Validate.message -join ', ' + } + } + } | Set-PodeOARouteInfo -Summary 'Update an existing pet' -Description 'Update an existing pet by Id' -Tags 'pet' -OperationId 'updatePet' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Reference 'PetBodySchema' ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Pet not found' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Validation exception' -Content @{ + 'application/json' = (New-PodeOAObjectProperty -Properties @( (New-PodeOAStringProperty -Name 'result'), (New-PodeOAStringProperty -Name 'message') )) + } + + Add-PodeRoute -PassThru -Method Post -Path '/pet' -Authentication 'Login-OAuth2' -Scope 'write' -ScriptBlock { + + $JsonPet = ConvertTo-Json $WebEvent.data + $Validate = Test-PodeOAJsonSchemaCompliance -Json $JsonPet -SchemaReference 'Pet' + if ($Validate.result) { + $Pet = $WebEvent.data + $Pet.tags.id = Get-Random -Minimum 1 -Maximum 9999999 + Write-PodeJsonResponse -Value ($Pet | ConvertTo-Json -Depth 20 ) -StatusCode 200 + } else { + Write-PodeJsonResponse -StatusCode 405 -Value @{ + result = $Validate.result + message = $Validate.message -join ', ' + } + } + } | Set-PodeOARouteInfo -Summary 'Add a new pet to the store' -Description 'Add a new pet to the store' -Tags 'pet' -OperationId 'addPet' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Reference 'PetBodySchema' ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Validation exception' -Content @{ + 'application/json' = (New-PodeOAObjectProperty -Properties @( (New-PodeOAStringProperty -Name 'result'), (New-PodeOAStringProperty -Name 'message') )) + } + + Add-PodeRoute -PassThru -Method Post -Path '/petcallback' -Authentication 'Login-OAuth2' -Scope 'write' -ScriptBlock { + $JsonPet = ConvertTo-Json $WebEvent.data + $Validate = Test-PodeOAJsonSchemaCompliance -Json $JsonPet -SchemaReference 'Pet' + if ($Validate.result) { + $Pet = $WebEvent.data + $Pet.tags.id = Get-Random -Minimum 1 -Maximum 9999999 + Write-PodeJsonResponse -Value ($Pet | ConvertTo-Json -Depth 20 ) -StatusCode 200 + } else { + Write-PodeJsonResponse -StatusCode 405 -Value @{ + result = $Validate.result + message = $Validate.message -join ', ' + } + } + } | Set-PodeOARouteInfo -Summary 'Add a new pet to the store' -Description 'Add a new pet to the store' -Tags 'pet' -OperationId 'addPetcallback' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Reference 'PetBodySchema' ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Validation exception' -Content @{ + 'application/json' = (New-PodeOAObjectProperty -Properties @( (New-PodeOAStringProperty -Name 'result'), (New-PodeOAStringProperty -Name 'message') )) + } -PassThru | + Add-PodeOACallBack -Name 'test' -Path '{$request.body#/id}' -Method Post -RequestBody (New-PodeOARequestBody -Content @{'*/*' = (New-PodeOAStringProperty -Name 'id') } ) ` + -Response ( + New-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' -Array) | + New-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' | + New-PodeOAResponse -StatusCode 404 -Description 'Pet not found' | + New-PodeOAResponse -Default -Description 'Something is wrong' + ) + + #Define CallBack Reference + + Add-PodeOAComponentCallBack -Name 'test' -Path '{$request.body#/id}' -Method Post -RequestBody (New-PodeOARequestBody -Content @{'*/*' = (New-PodeOAStringProperty -Name 'id') } ) ` + -Response ( + New-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' -Array) | + New-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' | + New-PodeOAResponse -StatusCode 404 -Description 'Pet not found' | + New-PodeOAResponse -Default -Description 'Something is wrong' + ) + + + Add-PodeRoute -PassThru -Method Post -Path '/petcallbackReference' -Authentication 'Login-OAuth2' -Scope 'write' -ScriptBlock { + $JsonPet = ConvertTo-Json $WebEvent.data + $Validate = Test-PodeOAJsonSchemaCompliance -Json $JsonPet -SchemaReference 'Pet' + if ($Validate.result) { + $Pet = $WebEvent.data + $Pet.tags.id = Get-Random -Minimum 1 -Maximum 9999999 + Write-PodeJsonResponse -Value ($Pet | ConvertTo-Json -Depth 20 ) -StatusCode 200 + } else { + Write-PodeJsonResponse -StatusCode 405 -Value @{ + result = $Validate.result + message = $Validate.message -join ', ' + } + } + } | Set-PodeOARouteInfo -Summary 'Add a new pet to the store' -Description 'Add a new pet to the store' -Tags 'pet' -OperationId 'petcallbackReference' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Reference 'PetBodySchema' ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Validation exception' -Content @{ + 'application/json' = ( New-PodeOAStringProperty -Name 'result' | New-PodeOAStringProperty -Name 'message' | New-PodeOAObjectProperty ) + } -PassThru | + Add-PodeOACallBack -Name 'test1' -Reference 'test' + + + Add-PodeRoute -PassThru -Method get -Path '/pet/findByStatus' -Authentication 'Login-OAuth2' -Scope 'read' -AllowAnon -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Finds Pets by status' -Description 'Multiple status values can be provided with comma separated strings' -Tags 'pet' -OperationId 'findPetsByStatus' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + ( New-PodeOAStringProperty -Name 'status' -Description 'Status values that need to be considered for filter' -Default 'available' -Enum @('available', 'pending', 'sold') | ConvertTo-PodeOAParameter -In Query ) + ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' -Array) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid status value' + + + + + + + + + + Add-PodeRoute -PassThru -Method get -Path '/pet/findByTag' -Authentication 'test' -Scope 'read' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Finds Pets by tags' -Description 'Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.' -Tags 'pet' -OperationId 'findPetsByTags' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + ( New-PodeOAStringProperty -Name 'tag' -Description 'Tags to filter by' -Array | ConvertTo-PodeOAParameter -In Query -Explode) + ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) -PassThru | #missing array application/json: + # schema: + # type: array + # items: + # $ref: '#/components/schemas/Pet' + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid status value' -PassThru | + Add-PodeOAResponse -Default -Description 'Unexpected error' -Content (New-PodeOAContentMediaType -MediaType 'application/json' -Content 'ErrorModel' ) + + Add-PodeRoute -PassThru -Method Get -Path '/pet/:petId' -Authentication 'Login-OAuth2' -Scope 'read' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Find pet by ID' -Description 'Returns a single pet.' -Tags 'pet' -OperationId 'getPetById' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( ConvertTo-PodeOAParameter -Reference 'PetIdParam' ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (@{ 'application/json' = 'Pet' ; 'application/xml' = 'Pet' }) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Pet not found' + + Add-PodeRoute -PassThru -Method post -Path '/pet/:petId' -Authentication 'Login-OAuth2' -Scope 'write' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Updates a pet in the store' -Description 'Updates a pet in the store with form data' -Tags 'pet' -OperationId 'updatePetWithForm' -PassThru | + Set-PodeOARequest -PassThru -Parameters @(( ConvertTo-PodeOAParameter -Reference 'PetIdParam' ), + ( New-PodeOAStringProperty -Name 'name' -Description 'Name of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Query ) , + ( New-PodeOAStringProperty -Name 'status' -Description 'Status of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Query ) + ) -RequestBody ( + # New-PodeOARequestBody -Content @{ + # 'application/x-www-form-urlencoded' = (New-PodeOAObjectProperty -Properties @( (New-PodeOAStringProperty -format 'uuid'), (New-PodeOAObjectProperty -Properties @()))) + New-PodeOARequestBody -Properties -Content @{ + 'multipart/form-data' = (New-PodeOAStringProperty -Name 'file' -Format binary -Array) + }) | Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + + + Add-PodeRoute -PassThru -Method post -Path '/pet2/:petId' -Authentication 'Login-OAuth2' -Scope 'write' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Updates a pet in the store' -Description 'Updates a pet in the store with form data' -Tags 'pet' -OperationId 'updatePet2WithForm' -PassThru | + Set-PodeOARequest -PassThru -Parameters @(( ConvertTo-PodeOAParameter -Reference 'PetIdParam' ), + ( New-PodeOAStringProperty -Name 'name' -Description 'Name of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Query ) , + ( New-PodeOAStringProperty -Name 'status' -Description 'Status of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Query ) + ) -RequestBody ( + New-PodeOARequestBody -Content @{ + 'application/x-www-form-urlencoded' = (New-PodeOAObjectProperty -Properties @( + (New-PodeOAStringProperty -name 'id' -format 'uuid'), (New-PodeOAObjectProperty -name 'address' -NoProperties))) + + }) | Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + Add-PodeRoute -PassThru -Method post -Path '/pet3/:petId' -Authentication 'Login-OAuth2' -Scope 'write' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Updates a pet in the store' -Description 'Updates a pet in the store with form data' -Tags 'pet' -OperationId 'updatePet3WithForm' -PassThru | + Set-PodeOARequest -PassThru -Parameters @(( ConvertTo-PodeOAParameter -Reference 'PetIdParam' ), + ( New-PodeOAStringProperty -Name 'name' -Description 'Name of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Query ) , + ( New-PodeOAStringProperty -Name 'status' -Description 'Status of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Query ) + ) -RequestBody (New-PodeOARequestBody -Content @{'multipart/form-data' = + New-PodeOAStringProperty -name 'id' -format 'uuid' | + New-PodeOAObjectProperty -name 'address' -NoProperties | + New-PodeOAStringProperty -name 'children' -array | + New-PodeOASchemaProperty -Name 'addresses' -Reference 'Address' -Array | + New-PodeOAObjectProperty + }) | Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + + Add-PodeRoute -PassThru -Method post -Path '/pet4/:petId' -Authentication 'Login-OAuth2' -Scope 'write' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Updates a pet in the store' -Description 'Updates a pet in the store with form data' -Tags 'pet' -OperationId 'updatePet4WithForm' -PassThru | + Set-PodeOARequest -PassThru -Parameters @(( ConvertTo-PodeOAParameter -Reference 'PetIdParam' ), + ( New-PodeOAStringProperty -Name 'name' -Description 'Name of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Query ) , + ( New-PodeOAStringProperty -Name 'status' -Description 'Status of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Query ) + ) -RequestBody (New-PodeOARequestBody -Content @{'multipart/form-data' = + New-PodeOAStringProperty -name 'id' -format 'uuid' | + New-PodeOAObjectProperty -name 'address' -NoProperties | + New-PodeOAObjectProperty -name 'historyMetadata' -Description 'metadata in XML format' -NoProperties | + New-PodeOAStringProperty -name 'profileImage' -Format Binary | + New-PodeOAObjectProperty + } -Encoding ( + New-PodeOAEncodingObject -Name 'historyMetadata' -ContentType 'application/xml; charset=utf-8' | + New-PodeOAEncodingObject -Name 'profileImage' -ContentType 'image/png, image/jpeg' -Headers ( + New-PodeOAIntProperty -name 'X-Rate-Limit-Limit' -Description 'The number of allowed requests in the current period' -Default 3 -Enum @(1, 2, 3) -Maximum 3 | + New-PodeOAIntProperty -Name 'X-Rate-Limit-Reset' -Description 'The number of seconds left in the current period' -Minimum 2 + ) + ) + ) | Add-PodeOAResponse -StatusCode 200 -PassThru -Description 'A simple string response' -Content ( New-PodeOAContentMediaType -MediaType 'text/plain' -Content ( New-PodeOAStringProperty) ) | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + + + Add-PodeRoute -PassThru -Method post -Path '/pet/:petId/uploadImage2' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Uploads an image' -Description 'Updates a pet in the store with a new image' -Tags 'pet' -OperationId 'uploadFile2' -PassThru | + Set-PodeOARequest -Parameters @( + ( New-PodeOAIntProperty -Name 'petId' -Format Int64 -Description 'ID of pet that needs to be updated' -Required | ConvertTo-PodeOAParameter -In Path ), + ( New-PodeOAStringProperty -Name 'additionalMetadata' -Description 'Additional Metadata' | ConvertTo-PodeOAParameter -In Query ) + ) -RequestBody (New-PodeOARequestBody -Required -Content @{ 'multipart/form-data' = New-PodeOAObjectProperty -Properties @( (New-PodeOAStringProperty -Name 'image' -Format Binary )) } ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'A simple string response' -Content ( + New-PodeOAContentMediaType -MediaType 'text/plain' -Content ( New-PodeOAStringProperty -Example 'whoa!') ) -Headers ( + New-PodeOAIntProperty -Name 'X-Rate-Limit-Limit' -Description 'The number of allowed requests in the current period' | + New-PodeOAIntProperty -Name 'X-Rate-Limit-Remaining' -Description 'The number of remaining requests in the current period' | + New-PodeOAIntProperty -Name 'X-Rate-Limit-Reset' -Description 'The number of seconds left in the current period' -Maximum 3 + ) + + Add-PodeRoute -PassThru -Method Delete -Path '/pet/:petId' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Deletes a pet' -Description 'Deletes a pet.' -Tags 'pet' -OperationId 'deletePet' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( ConvertTo-PodeOAParameter -Reference 'PetIdParam' ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Pet not found' + + Add-PodeRoute -PassThru -Method post -Path '/pet/:petId/uploadmultiImage' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Uploads an image' -Description 'Updates a pet in the store with a new image' -Tags 'pet' -OperationId 'uploadFilemulti' -PassThru | + Set-PodeOARequest -Parameters @( + ( New-PodeOAIntProperty -Name 'petId' -Format Int64 -Description 'ID of pet that needs to be updated' -Required | ConvertTo-PodeOAParameter -In Path ), + ( New-PodeOAStringProperty -Name 'additionalMetadata' -Description 'Additional Metadata' | ConvertTo-PodeOAParameter -In Query ) + ) -RequestBody ( + New-PodeOARequestBody -Required -Content ( New-PodeOAContentMediaType -MediaType 'multipart/form-data' -Upload -PartContentMediaType 'application/octect-stream' -Content ( + New-PodeOAIntProperty -name 'orderId' | New-PodeOAStringProperty -Name 'image' -Format Binary | New-PodeOAObjectProperty )) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content @{'application/json' = 'ApiResponse' } -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + + Add-PodeRoute -PassThru -Method post -Path '/pet/:petId/uploadImageOctet' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Uploads an image' -Description 'Updates a pet in the store with a new image' -Tags 'pet' -OperationId 'uploadFileOctet' -PassThru | + Set-PodeOARequest -Parameters @( + ( New-PodeOAIntProperty -Name 'petId' -Format Int64 -Description 'ID of pet that needs to be updated' -Required | ConvertTo-PodeOAParameter -In Path ), + ( New-PodeOAStringProperty -Name 'additionalMetadata' -Description 'Additional Metadata' | ConvertTo-PodeOAParameter -In Query ) + ) -RequestBody ( + New-PodeOARequestBody -Required -Content ( New-PodeOAContentMediaType -MediaType 'application/octet-stream' -Upload ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content @{'application/json' = 'ApiResponse' } -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + Add-PodeRoute -PassThru -Method Get -Path '/store/inventory' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Returns pet inventories by status' -Description 'Returns a map of status codes to quantities' -Tags 'store' -OperationId 'getInventory' -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content @{ 'application/json' = New-PodeOAObjectProperty -Properties @(New-PodeOAStringProperty -Name 'none' ) } #missing additionalProperties + + + Add-PodeRoute -PassThru -Method post -Path '/store/order' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Deprecated -Summary 'Place an order for a pet' -Description 'Place a new order in the store' -Tags 'store' -OperationId 'placeOrder' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Required -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'Order' )) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (@{ 'application/json' = 'Order' ; 'application/xml' = 'Order' }) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + Add-PodeRoute -PassThru -Method Get -Path '/store/order/:orderId' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | + Add-PodeOAExternalRoute -Servers ( + New-PodeOAServerEndpoint -Url 'http://ext.server.com/api/v12' -Description 'ext test server' | + New-PodeOAServerEndpoint -Url 'http://ext13.server.com/api/v12' -Description 'ext test server 13' | + New-PodeOAServerEndpoint -Url 'http://ext14.server.com/api/v12' -Description 'ext test server 14' + ) -PassThru | + Set-PodeOARouteInfo -Summary 'Find purchase order by ID' -Description 'For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.' -Tags 'store' -OperationId 'getOrderById' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + ( New-PodeOAIntProperty -Name 'orderId' -Format Int64 -Description 'ID of order that needs to be fetched' -Required | ConvertTo-PodeOAParameter -In Path ) + ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'Order' ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Order not found' + + Add-PodeRoute -PassThru -Method Delete -Path '/store/order/:orderId' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Delete purchase order by ID' -Description 'For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors.' -Tags 'store' -OperationId 'deleteOrder' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + ( New-PodeOAIntProperty -Name 'orderId' -Format Int64 -Description ' ID of the order that needs to be deleted' -Required | ConvertTo-PodeOAParameter -In Path ) + ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Order not found' + + + Add-PodeRoute -PassThru -Method post -Path '/user' -ScriptBlock { + $JsonUser = ConvertTo-Json $WebEvent.data + $Validate = Test-PodeOAJsonSchemaCompliance -Json $JsonUser -SchemaReference 'User' + if ($Validate.result) { + $User = $WebEvent.data + $User.id = Get-Random -Minimum 1 -Maximum 9999999 + Write-PodeJsonResponse -Value ($User | ConvertTo-Json -Depth 20 ) -StatusCode 200 + } else { + Write-PodeJsonResponse -StatusCode 405 -Value @{ + result = $Validate.result + message = $Validate.message -join ', ' + } + } + } | Set-PodeOARouteInfo -Summary 'Create user.' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'createUser' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Required -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'User' )) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Reference 'UserOpSuccess' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' -Content @{ + 'application/json' = (New-PodeOAObjectProperty -Properties @( (New-PodeOAStringProperty -Name 'result'), (New-PodeOAStringProperty -Name 'message') )) + } + + Add-PodeRoute -PassThru -Method post -Path '/user/createWithList' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Creates list of users with given input array.' -Description 'Creates list of users with given input array.' -Tags 'user' -OperationId 'createUsersWithListInput' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Required -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'User' )) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Reference 'UserOpSuccess' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + Add-PodeRoute -PassThru -Method Get -Path '/user/login' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Logs user into the system.' -Description 'Logs user into the system.' -Tags 'user' -OperationId 'loginUser' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + ( New-PodeOAStringProperty -Name 'username' -Description 'The user name for login' | ConvertTo-PodeOAParameter -In Query ) + ( New-PodeOAStringProperty -Name 'password' -Description 'The password for login in clear text' -Format Password | ConvertTo-PodeOAParameter -In Query ) + ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'string' ) ` + -Header @('X-Rate-Limit', 'X-Expires-After') -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username/password supplied' + + + Add-PodeRoute -PassThru -Method Get -Path '/user/logout' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Logs out current logged in user session.' -Description 'Logs out current logged in user session.' -Tags 'user' -OperationId 'logoutUser' -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' + + Add-PodeRoute -PassThru -Method Get -Path '/user/:username' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Get user by user name' -Description 'Get user by user name.' -Tags 'user' -OperationId 'getUserByName' -PassThru | + Set-PodeOARequest -Parameters @( + ( New-PodeOAStringProperty -Name 'username' -Description 'The name that needs to be fetched. Use user1 for testing.' -Required | ConvertTo-PodeOAParameter -In Path ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Reference 'UserOpSuccess' -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' + + $Responses = New-PodeOAResponse -StatusCode 200 -Reference 'UserOpSuccess' | + New-PodeOAResponse -StatusCode 400 -Description 'Invalid username supplied' | + New-PodeOAResponse -StatusCode 404 -Description 'User not found' | + New-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + + Add-PodeRoute -PassThru -Method Put -Path '/user_1/:username' -OAResponses $Responses -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Update user' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'updateUser_1' -PassThru | + Set-PodeOARequest -Parameters @( + ( New-PodeOAStringProperty -Name 'username' -Description ' name that need to be updated.' -Required | ConvertTo-PodeOAParameter -In Path ) + ) -RequestBody (New-PodeOARequestBody -Required -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'StructPart' )) + + + Add-PodeRoute -PassThru -Method Put -Path '/user/:username' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Update user' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'updateUser' -PassThru | + Set-PodeOARequest -Parameters @( + ( New-PodeOAStringProperty -Name 'username' -Description ' name that need to be updated.' -Required | ConvertTo-PodeOAParameter -In Path ) + ) -RequestBody (New-PodeOARequestBody -Required -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'User' )) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Reference 'UserOpSuccess' -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + + + Add-PodeRoute -PassThru -Method Put -Path '/userLink/:username' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Update user' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'updateUserLink' -PassThru | + Set-PodeOARequest -Parameters @( + ( New-PodeOAStringProperty -Name 'username' -Description ' name that need to be updated.' -Required | ConvertTo-PodeOAParameter -In Path ) + ) -RequestBody (New-PodeOARequestBody -Required -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'User' )) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Content @{'application/json' = 'User' } -PassThru ` + -Links (New-PodeOAResponseLink -Name address -OperationId 'getUserByName' -Parameters @{'username' = '$request.path.username' } ) | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + #Add link reference + Add-PodeOAComponentResponseLink -Name 'address' -OperationId 'getUserByName' -Parameters @{'username' = '$request.path.username' } + + #use link reference + Add-PodeRoute -PassThru -Method Put -Path '/userLinkByRef/:username' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Update user' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'updateUserLinkByRef' -PassThru | + Set-PodeOARequest -Parameters @( + ( New-PodeOAStringProperty -Name 'username' -Description ' name that need to be updated.' -Required | ConvertTo-PodeOAParameter -In Path ) + ) -RequestBody (New-PodeOARequestBody -Required -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'User' )) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Content @{'application/json' = 'User' } -PassThru ` + -Links (New-PodeOAResponseLink -Name 'address2' -Reference 'address' ) | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + + + Add-PodeRoute -PassThru -Method Delete -Path '/usera/:username' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Delete user' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'deleteUser' -PassThru | + Set-PodeOARequest -Parameters @( + ( New-PodeOAStringProperty -Name 'username' -Description 'The name that needs to be deleted.' -Required | ConvertTo-PodeOAParameter -In Path ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' + + + Remove-PodeRoute -Method Delete -Path '/api/v3/usera/:username' + + + Add-PodeRoute -PassThru -Method Delete -Path '/user/:username' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Delete user' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'deleteUser' -PassThru | + Set-PodeOARequest -Parameters @( + ( New-PodeOAStringProperty -Name 'username' -Description 'The name that needs to be deleted.' -Required | ConvertTo-PodeOAParameter -In Path ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' + + + + Add-PodeOAExternalRoute -Method Get -Path '/stores/order/:orderId' -Servers ( + New-PodeOAServerEndpoint -Url 'http://ext.server.com/api/v12' -Description 'ext test server' | + New-PodeOAServerEndpoint -Url 'http://ext13.server.com/api/v12' -Description 'ext test server 13' | + New-PodeOAServerEndpoint -Url 'http://ext14.server.com/api/v12' -Description 'ext test server 14' + ) -PassThru | Set-PodeOARouteInfo -Summary 'Find purchase order by ID' -Description 'For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.' -Tags 'store' -OperationId 'getOrderExternalById' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + ( New-PodeOAIntProperty -Name 'orderId' -Format Int64 -Description 'ID of order that needs to be fetched' -Required | ConvertTo-PodeOAParameter -In Path ) + ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'Order' ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Order not found' + } + } + Select-PodeOADefinition -Tag 'v3.1' -Scriptblock { + Add-PodeRouteGroup -Path '/api/v5' -Routes { + + Add-PodeRoute -Method Get -Path '/petbyRef/:petId' -Authentication 'api_key' -Scope 'read' -OAReference 'GetPetByIdWithRef' -ScriptBlock { + Write-PodeJsonResponse -Value 'done' -StatusCode 2005 + } + + } + } + + + $yaml = PodeOADefinition -Format Yaml -DefinitionTag 'v3.1' + $json = PodeOADefinition -Format Json -DefinitionTag 'v3' + + Write-PodeHost "`rYAML Tag: v3.1 Output:`r $yaml" + + Write-PodeHost "`rJSON Tag: v3 Output:`r $json" +} \ No newline at end of file diff --git a/examples/PetStore/Order.psm1 b/examples/PetStore/Order.psm1 new file mode 100644 index 000000000..c511fdcad --- /dev/null +++ b/examples/PetStore/Order.psm1 @@ -0,0 +1,130 @@ +$orders = @{} +function Initialize-Order { + param ( + [switch] + $Reset + ) + New-PodeLockable -Name 'PetOrderLock' + if ($Reset.IsPresent) { + $now = (Get-Date) + Lock-PodeObject -Name 'PetOrderLock' -ScriptBlock { + Set-PodeState -Scope 'Orders' -Name 'orders' -Value @{} | Out-Null + Add-Order -Id 1 -PetId 1 -Quantity 100 -ShipDate $now -Status 'placed' -Complete + Add-Order -Id 2 -PetId 1 -Quantity 50 -ShipDate $now -Status 'approved' -Complete + Add-Order -Id 3 -PetId 1 -Quantity 50 -ShipDate $now -Status 'delivered' -Complete + Add-Order -Id 4 -PetId 1 -Quantity 20 -ShipDate $now -Status 'placed' + } + } +} + +function Add-Order { + [CmdletBinding(DefaultParameterSetName = 'Items')] + param ( + [Parameter(Mandatory, ParameterSetName = 'Items')] + [long] + $Id, + + [Parameter(Mandatory, ParameterSetName = 'Items')] + [long] + $PetId, + + [Parameter(Mandatory, ParameterSetName = 'Items')] + [int] + $Quantity, + + [Parameter(Mandatory, ParameterSetName = 'Items')] + [datetime] + $ShipDate, + + [Parameter(Mandatory, ParameterSetName = 'Items')] + [string] + $Status, + + [Parameter( ParameterSetName = 'Items')] + [switch] + $Complete, + + [Parameter(Mandatory, ParameterSetName = 'Object')] + [hashtable] + $Order + ) + Lock-PodeObject -Name 'PetOrderLock' -ScriptBlock { + $orders = Get-PodeState -Name 'orders' + switch ($PSCmdlet.ParameterSetName) { + 'Items' { + $orders["$Id"] = @{ + id = $Id + petId = $PetId + quantity = $Quantity + shipdate = $ShipDate + status = $Status + complete = $Complete.IsPresent + } + } + 'Object' { + $orders["$($Order.id)"] = $Order + } + } + } +} + + +function Get-Order { + param ( + [Parameter(Mandatory)] + [long] + $Id + ) + return Lock-PodeObject -Name 'PetOrderLock' -Return -ScriptBlock { + $orders = Get-PodeState -Name 'orders' + return $orders["$Id"] + } +} + +function Test-Order { + param ( + [Parameter(Mandatory)] + [long] + $Id + ) + return Lock-PodeObject -Name 'PetOrderLock' -Return -ScriptBlock { + $orders = Get-PodeState -Name 'orders' + return $orders.ContainsKey("$Id") + } +} + + +function Get-CountByStatus { + return Lock-PodeObject -Name 'PetOrderLock' -Return -ScriptBlock { + $result = @{} + foreach ($order in (Get-PodeState -Name 'orders').Values) { + $status = $order.status + if ($result.containsKey($status)) { + $result[$status] += $order.quantity + } else { + $result[$status] = $order.quantity + } + } + return $result + } +} + +function Remove-Order { + param ( + [Parameter(Mandatory)] + [long] + $Id + ) + Lock-PodeObject -Name 'PetOrderLock' -ScriptBlock { + $order = (Get-PodeState -Name 'orders') + $order.Remove( "$Id") + } +} + + +Export-ModuleMember -Function Initialize-Order +Export-ModuleMember -Function Get-Order +Export-ModuleMember -Function Get-CountByStatus +Export-ModuleMember -Function Add-Order +Export-ModuleMember -Function Test-Order +Export-ModuleMember -Function Remove-Order \ No newline at end of file diff --git a/examples/PetStore/PetData.psm1 b/examples/PetStore/PetData.psm1 new file mode 100644 index 000000000..d4f2c0408 --- /dev/null +++ b/examples/PetStore/PetData.psm1 @@ -0,0 +1,311 @@ + + + +function Initialize-Categories { + param ( + [switch] + $Reset + ) + New-PodeLockable -Name 'PetCategoryLock' + if ($Reset.IsPresent) { + Lock-PodeObject -Name 'PetCategoryLock' -ScriptBlock { + Set-PodeState -Scope 'Categories' -Name 'categories' -Value @{} | Out-Null + Add-Category -Id 1 -Name 'Dogs' + Add-Category -Id 2 -Name 'Cats' + Add-Category -Id 3 -Name 'Rabbits' + Add-Category -Id 4 -Name 'Lions' + } + } +} +function Initialize-Pet { + param ( + [switch] + $Reset + ) + New-PodeLockable -Name 'PetLock' + if ($Reset.IsPresent) { + Lock-PodeObject -Name 'PetLock' -ScriptBlock { + Set-PodeState -Scope 'Pets' -Name 'pets' -Value @{} | Out-Null + Add-Pet -Id 1 -Cat 'Cats' -Name 'Cat 1' -Urls 'url1', 'url2' -Tags 'tag1', 'tag2' -Status available + Add-Pet -Id 2 -Cat 'Cats' -Name 'Cat 2' -Urls 'url1', 'url2' -Tags 'tag2', 'tag3' -Status available + Add-Pet -Id 3 -Cat 'Cats' -Name 'Cat 2' -Urls 'url1', 'url2' -Tags 'tag3', 'tag4' -Status pending + + Add-Pet -Id 4 -Cat 'Dogs' -Name 'Dog 1' -Urls 'url1', 'url2' -Tags 'tag1', 'tag2' -Status available + Add-Pet -Id 5 -Cat 'Dogs' -Name 'Dog 2' -Urls 'url1', 'url2' -Tags 'tag2', 'tag3' -Status sold + Add-Pet -Id 6 -Cat 'Dogs' -Name 'Dog 2' -Urls 'url1', 'url2' -Tags 'tag3', 'tag4' -Status pending + + Add-Pet -Id 7 -Cat 'Lions' -Name 'Lion 1' -Urls 'url1', 'url2' -Tags 'tag1', 'tag2' -Status available + Add-Pet -Id 8 -Cat 'Lions' -Name 'Lion 2' -Urls 'url1', 'url2' -Tags 'tag2', 'tag3' -Status available + Add-Pet -Id 9 -Cat 'Lions' -Name 'Lion 2' -Urls 'url1', 'url2' -Tags 'tag3', 'tag4' -Status available + + Add-Pet -Id 10 -Cat 'Rabbits' -Name 'Rabbit 1' -Urls 'url1', 'url2' -Tags 'tag2', 'tag3' -Status available + Add-Pet -Id 11 -Cat 'Rabbits' -Name 'Rabbit 2' -Urls 'url1', 'url2' -Tags 'tag3', 'tag4' -Status pending + } + } +} + + +function Add-Pet { + + [CmdletBinding(DefaultParameterSetName = 'Items')] + param ( + [Parameter(Mandatory, ParameterSetName = 'Items')] + [long] + $Id, + [Parameter( ParameterSetName = 'Items')] + [String] + $Category, + [Parameter(Mandatory, ParameterSetName = 'Items')] + [string] + $Name, + [Parameter(Mandatory, ParameterSetName = 'Items')] + [string[]] + $Urls, + [Parameter( ParameterSetName = 'Items')] + [string[]] + $Tags, + [Parameter( ParameterSetName = 'Items')] + [ValidateSet('pending', 'available', 'sold')] + [string] + $Status, + + [Parameter(Mandatory, ParameterSetName = 'Object')] + [hashtable] + $Pet + ) + Lock-PodeObject -Name 'PetLock' -ScriptBlock { + $pets = Get-PodeState -Name 'pets' + switch ($PSCmdlet.ParameterSetName) { + 'Items' { + $pets["$Id"] = @{ + id = $Id + categoryName = Get-Category -Name $Category + name = $Name + photoUrls = $Urls + tags = $Tags + status = $Status + } + } + 'Object' { + $pets["$($Pet.id)"] = $Pet + } + } } +} + + + + + +function Update-Pet { + + [CmdletBinding(DefaultParameterSetName = 'Items')] + param ( + [Parameter(Mandatory, ParameterSetName = 'Items')] + [long] + $Id, + [Parameter( ParameterSetName = 'Items')] + [String] + $Category, + [Parameter(Mandatory, ParameterSetName = 'Items')] + [string] + $Name, + [Parameter(Mandatory, ParameterSetName = 'Items')] + [string[]] + $Urls, + [Parameter( ParameterSetName = 'Items')] + [string[]] + $Tags, + [Parameter( ParameterSetName = 'Items')] + [ValidateSet('pending', 'available', 'sold')] + [string] + $Status, + + [Parameter(Mandatory, ParameterSetName = 'Object')] + [hashtable] + $Pet + ) + return Lock-PodeObject -Name 'PetLock' -Return -ScriptBlock { + $pets = Get-PodeState -Name 'pets' + switch ($PSCmdlet.ParameterSetName) { + 'Items' { + if ($pets.ContainsKey("$Id")) { + if ($Category) { + $pets["$Id"].categoryName = Get-Category -Name $Category + } + if ($Name) { + $pets["$Id"].name = $Name + } + if ($Urls) { + $pets["$Id"].photoUrls = $Urls + } + if ($Tags) { + $pets["$Id"].tags = $Tags + } + if ($Status) { + $pets["$Id"].status = $Status + } + return $true + } + } + 'Object' { + if ($pets.ContainsKey("$($Pet.id)")) { + $pets["$($Pet.id)"] = $Pet + return $true + } + } + } + return $false + } +} + + +function Get-Pet { + param ( + [Parameter(Mandatory)] + [long] + $Id + ) + return Lock-PodeObject -Name 'PetLock' -Return -ScriptBlock { + $pets = Get-PodeState -Name 'pets' + return $pets["$Id"] + } +} + + +function Test-Pet { + param ( + [Parameter(Mandatory)] + [long] + $Id + ) + return Lock-PodeObject -Name 'PetLock' -Return -ScriptBlock { + $pets = Get-PodeState -Name 'pets' + return $pets.ContainsKey("$Id") + } +} + + + +function Find-PetByStatus { + param ( + [Parameter(Mandatory)] + [string[]] + $Status + ) + return Lock-PodeObject -Name 'PetLock' -Return -ScriptBlock { + $result = @() + foreach ($pet in (Get-PodeState -Name 'pets').Values) { + foreach ($s in $Status) { + if ($s -ieq $pet.status) { + $result += $pet + break + } + } + } + return $result + } + +} + + +function Find-PetByTags { + param ( + [Parameter(Mandatory)] + [string[]] + $Tags + ) + + return Lock-PodeObject -Name 'PetLock' -Return -ScriptBlock { + $result = @() + foreach ($pet in (Get-PodeState -Name 'pets').Values) { + if ($pet.tags) { + foreach ($tag in $pet.tags) { + foreach ($tagListString in $Tags) { + if ($tagListString -ieq $tag) { + $result += $pet + break + } + } + } + } + } + return $result + } +} + + +function Remove-Pet { + param ( + [Parameter(Mandatory)] + [long] + $Id + ) + Lock-PodeObject -Name 'PetLock' -ScriptBlock { + $pets = (Get-PodeState -Name 'pets') + $pets.Remove( "$Id") + } +} + + +function Add-Category { + param ( + [Parameter(Mandatory)] + [long] + $Id, + [Parameter(Mandatory)] + [string] + $Name + ) + Lock-PodeObject -Name 'PetCategoryLock' -ScriptBlock { + $categories = (Get-PodeState -Name 'categories') + $categories[$Name] = $Id + } +} + + +function Get-Category { + [CmdletBinding(DefaultParameterSetName = 'Name')] + param ( + [Parameter(Mandatory, ParameterSetName = 'Name')] + [string] + $Name, + [Parameter(Mandatory, ParameterSetName = 'Id')] + [long] + $Id + ) + return Lock-PodeObject -Name 'PetCategoryLock' -Return -ScriptBlock { + $categories = (Get-PodeState -Name 'categories') + switch ($PSCmdlet.ParameterSetName) { + 'Name' { + if ($categories.ContainsKey($name)) { + return @{ + name = $name + id = $categories[$name] + } + } + } + 'Id' { + foreach ($c in $categories) { + if ($c.id -eq $Id ) { + return @{ + name = $c.name + id = $Id + } + } + } + } + } + return $null + } +} +Export-ModuleMember -Function Initialize-Categories +Export-ModuleMember -Function Initialize-Pet +Export-ModuleMember -Function Add-Pet +Export-ModuleMember -Function Update-Pet +Export-ModuleMember -Function Get-Pet +Export-ModuleMember -Function Find-PetByTags +Export-ModuleMember -Function Find-PetByStatus +Export-ModuleMember -Function Remove-Pet +Export-ModuleMember -Function Add-Category +Export-ModuleMember -Function Get-Category +Export-ModuleMember -Function Test-Pet \ No newline at end of file diff --git a/examples/PetStore/Petstore-openApi.ps1 b/examples/PetStore/Petstore-openApi.ps1 new file mode 100644 index 000000000..dafd4dfd3 --- /dev/null +++ b/examples/PetStore/Petstore-openApi.ps1 @@ -0,0 +1,854 @@ +param ( + [switch] + $Reset +) +$petStorePath = Split-Path -Parent -Path $MyInvocation.MyCommand.Path +$podePath = Split-Path -Parent -Path (Split-Path -Parent -Path $petStorePath) +if (Test-Path -Path "$($podePath)/src/Pode.psm1" -PathType Leaf) { + Import-Module "$($podePath)/src/Pode.psm1" -Force -ErrorAction Stop +} +else { + Import-Module -Name 'Pode' +} +function Write-ObjectContent { + param ( + [Parameter(Mandatory = $true, ValueFromPipeline = $true)] + $Object + ) + + Write-PodeHost -ForegroundColor Blue "Type:$($Object.gettype())" + $objectString = $Object | Out-String + Write-PodeHost -ForegroundColor Blue -Object $objectString + +} + +Import-Module -Name "$petStorePath/PetData.psm1" +Import-Module -Name "$petStorePath/Order.psm1" +Import-Module -Name "$petStorePath/UserData.psm1" + +Start-PodeServer -Threads 1 -ScriptBlock { + + $script:PetDataPath = Join-Path -Path $PetStorePath -ChildPath 'data' + If (!(Test-Path -PathType container -Path $script:PetDataPath)) { + New-Item -ItemType Directory -Path $script:PetDataPath -Force | Out-Null + } + + $script:PetImagesPath = Join-Path -Path $PetStorePath -ChildPath 'images' + If (!(Test-Path -PathType container -Path $script:PetImagesPath)) { + New-Item -ItemType Directory -Path $script:PetImagesPath -Force | Out-Null + } + + $script:CertsPath = Join-Path -Path $PetStorePath -ChildPath 'certs' + If (!(Test-Path -PathType container -Path $script:CertsPath)) { + New-Item -ItemType Directory -Path $script:CertsPath -Force | Out-Null + } + + + #Load data + $script:PetDataJson = Join-Path -Path $PetDataPath -ChildPath 'PetData.json' + if ($Reset.IsPresent -or !(Test-Path -Path $script:PetDataJson -PathType Leaf )) { + Initialize-Categories -Reset + Initialize-Pet -Reset + Initialize-Order -Reset + Initialize-Users -Reset + Save-PodeState -Path $script:PetDataJson + } + else { + Initialize-Categories + Initialize-Pet + Initialize-Order + Initialize-Users + # attempt to re-initialise the state (will do nothing if the file doesn't exist) + Restore-PodeState -Path $script:PetDataJson + } + + + if ((Get-PodeConfig).Protocol -eq 'Https') { + $Certificate = Join-Path -Path $CertsPath -ChildPath (Get-PodeConfig).Certificate + $CertificateKey = Join-Path -Path $CertsPath -ChildPath (Get-PodeConfig).CertificateKey + Add-PodeEndpoint -Address (Get-PodeConfig).Address -Port (Get-PodeConfig).RestFulPort -Protocol Https -Certificate $Certificate -CertificateKey $CertificateKey -CertificatePassword (Get-PodeConfig).CertificatePassword -Default + } + else { + Add-PodeEndpoint -Address (Get-PodeConfig).Address -Port (Get-PodeConfig).RestFulPort -Protocol Http -Default + } + + New-PodeLoggingMethod -Terminal | Enable-PodeErrorLogging + + #Configure CORS + Set-PodeSecurityAccessControl -Origin '*' -Duration 7200 -WithOptions -AuthorizationHeader -autoMethods -AutoHeader -Credentials -CrossDomainXhrRequests #-Header 'content-type' # -Header 'Accept','Content-Type' ,'Connection' #-Headers '*' 'x-requested-with' ,'crossdomain'# + + + #image folder + Add-PodeStaticRoute -Path '/images' -Source $script:PetImagesPath + + + + Enable-PodeOpenApi -Path '/docs/openapi' -OpenApiVersion '3.0.3' -EnableSchemaValidation -DisableMinimalDefinitions -NoDefaultResponses + + $swaggerDocs = New-PodeOAExternalDoc -Description 'Find out more about Swagger' -Url 'http://swagger.io' + $swaggerDocs | Add-PodeOAExternalDoc + + $InfoDescription = @' +This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at [http://swagger.io](http://swagger.io). +In the third iteration of the pet store, we've switched to the design first approach! +You can now help us improve the API whether it's by making changes to the definition itself or to the code. +That way, with time, we can improve the API in general, and expose some of the new features in OAS3. + +Some useful links: +- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore) +- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml) +'@ + + + Add-PodeOAInfo -Title 'Swagger Petstore - OpenAPI 3.0' -Version 1.0.17 -Description $InfoDescription -TermsOfService 'http://swagger.io/terms/' -LicenseName 'Apache 2.0' ` + -LicenseUrl 'http://www.apache.org/licenses/LICENSE-2.0.html' -ContactName 'API Support' -ContactEmail 'apiteam@swagger.io' + Add-PodeOAServerEndpoint -url '/api/v3' -Description 'default endpoint' + + + Enable-PodeOAViewer -Type Swagger -Path '/docs/swagger' + Enable-PodeOAViewer -Type ReDoc -Path '/docs/redoc' -DarkMode + Enable-PodeOAViewer -Type RapiDoc -Path '/docs/rapidoc' -DarkMode + Enable-PodeOAViewer -Type StopLight -Path '/docs/stoplight' -DarkMode + Enable-PodeOAViewer -Type Explorer -Path '/docs/explorer' -DarkMode + Enable-PodeOAViewer -Type RapiPdf -Path '/docs/rapipdf' -DarkMode + + Enable-PodeOAViewer -Editor -Path '/docs/swagger-editor' + Enable-PodeOAViewer -Bookmarks -Path '/docs' + + # setup session details + Enable-PodeSessionMiddleware -Duration 120 -Extend + + New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'read:pets' -Description 'read your pets' + New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'write:pets' -Description 'modify pets in your account' + $clientId = '123123123' + $clientSecret = '' + + New-PodeAuthScheme -OAuth2 -ClientId $ClientId -ClientSecret $ClientSecret ` + -AuthoriseUrl 'https://petstore3.swagger.io/oauth/authorize' ` + -TokenUrl 'https://petstore3.swagger.io/oauth/token' ` + -Scope 'read:pets', 'write:pets' | + Add-PodeAuth -Name 'petstore_auth' -FailureUrl 'https://petstore3.swagger.io/oauth/failure' -SuccessUrl '/' -ScriptBlock { + param($user, $accessToken, $refreshToken) + return @{ User = $user } + } + + New-PodeAuthScheme -ApiKey -LocationName 'api_key' | Add-PodeAuth -Name 'api_key' -Sessionless -ScriptBlock { + param($key) + if ($key) { + # here you'd check a real storage, this is just for example + if ($key -eq 'test-key') { + return @{ + User = @{ + 'ID' = 'M0R7Y302' + 'Name' = 'Morty' + 'Type' = 'Human' + } + } + } + + # authentication failed + return @{ + Code = 401 + Challenge = 'qop="auth", nonce=""' + } + } + else { + return @{ + Message = 'No Authorization header found' + Code = 401 + } + + } + } + + New-PodeAuthScheme -Basic -Realm 'PetStore' | Add-PodeAuth -Name 'Basic' -Sessionless -ScriptBlock { + param($username, $password) + + # here you'd check a real user storage, this is just for example + if ($username -eq 'morty' -and $password -eq 'pickle') { + return @{ + User = @{ + ID = 'M0R7Y302' + Name = 'Morty' + Type = 'Human' + Username = 'm.orty' + Scopes = @( 'read:pets' , 'write:pets' ) + } + } + } + return @{ Message = 'Invalid details supplied' } + } + + Merge-PodeAuth -Name 'merged_auth' -Authentication 'Basic', 'api_key' -Valid One + Merge-PodeAuth -Name 'merged_auth_All' -Authentication 'Basic', 'api_key' -Valid All -ScriptBlock {} + Merge-PodeAuth -Name 'merged_auth_nokey' -Authentication 'Basic' -Valid One + + Add-PodeOATag -Name 'user' -Description 'Operations about user' + Add-PodeOATag -Name 'store' -Description 'Access to Petstore orders' -ExternalDoc $swaggerDocs + Add-PodeOATag -Name 'pet' -Description 'Everything about your Pets' -ExternalDoc $swaggerDocs + + + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 10 -Required | + New-PodeOAIntProperty -Name 'petId' -Format Int64 -Example 198772 -Required | + New-PodeOAIntProperty -Name 'quantity' -Format Int32 -Example 7 -Required | + New-PodeOAStringProperty -Name 'shipDate' -Format Date-Time | + New-PodeOAStringProperty -Name 'status' -Description 'Order Status' -Required -Example 'approved' -Enum @('placed', 'approved', 'delivered') | + New-PodeOABoolProperty -Name 'complete' | + New-PodeOAObjectProperty -XmlName 'order' | + Add-PodeOAComponentSchema -Name 'Order' + + New-PodeOAStringProperty -Name 'street' -Example '437 Lytton' -Required | + New-PodeOAStringProperty -Name 'city' -Example 'Palo Alto' -Required | + New-PodeOAStringProperty -Name 'state' -Example 'CA' -Required | + New-PodeOAStringProperty -Name 'zip' -Example '94031' -Required | + New-PodeOAObjectProperty -XmlName 'address' | + Add-PodeOAComponentSchema -Name 'Address' + + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 100000 | + New-PodeOAStringProperty -Name 'username' -example 'fehguy' | + New-PodeOASchemaProperty -Name 'Address' -Reference 'Address' -Array -XmlName 'addresses' -XmlWrapped | + New-PodeOAObjectProperty -XmlName 'customer' | + Add-PodeOAComponentSchema -Name 'Customer' + + + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 1 | + New-PodeOAStringProperty -Name 'name' -Example 'Dogs' | + New-PodeOAObjectProperty -XmlName 'category' | + Add-PodeOAComponentSchema -Name 'Category' + + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 10 | + New-PodeOAStringProperty -Name 'username' -Example 'theUser' -Required | + New-PodeOAStringProperty -Name 'firstName' -Example 'John' | + New-PodeOAStringProperty -Name 'lastName' -Example 'James' | + New-PodeOAStringProperty -Name 'email' -Format email -Example 'john@email.com' | + New-PodeOAStringProperty -Name 'lastName' -Example 'James' | + New-PodeOAStringProperty -Name 'password' -Format Password -Example '12345' -Required | + New-PodeOAStringProperty -Name 'phone' -Example '12345' | + New-PodeOAIntProperty -Name 'userStatus'-Format Int32 -Description 'User Status' -Example 1 | + New-PodeOAObjectProperty -XmlName 'user' | + Add-PodeOAComponentSchema -Name 'User' + + + + New-PodeOAIntProperty -Name 'id'-Format Int64 | + New-PodeOAStringProperty -Name 'name' | + New-PodeOAObjectProperty -XmlName 'tag' | + Add-PodeOAComponentSchema -Name 'Tag' + + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 10 -Required | + New-PodeOAStringProperty -Name 'name' -Example 'doggie' -Required | + New-PodeOASchemaProperty -Name 'category' -Reference 'Category' | + New-PodeOAStringProperty -Name 'photoUrls' -Array -XmlWrapped -XmlItemName 'photoUrl' -Required | + New-PodeOASchemaProperty -Name 'tags' -Reference 'Tag' -Array -XmlWrapped | + New-PodeOAStringProperty -Name 'status' -Description 'pet status in the store' -Enum @('available', 'pending', 'sold') | + New-PodeOAObjectProperty -XmlName 'pet' | + Add-PodeOAComponentSchema -Name 'Pet' + + + + New-PodeOAIntProperty -Name 'code'-Format Int32 | + New-PodeOAStringProperty -Name 'type' | + New-PodeOAStringProperty -Name 'message' | + New-PodeOAObjectProperty -XmlName '##default' | + Add-PodeOAComponentSchema -Name 'ApiResponse' + + + Add-PodeOAComponentRequestBody -Name 'Pet' -Description 'Pet object that needs to be added to the store' -Content ( + New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet') + + Add-PodeOAComponentRequestBody -Name 'UserArray' -Description 'List of user object' -Content ( + New-PodeOAContentMediaType -MediaType 'application/json' -Content 'User' -Array) + + + + + Add-PodeRouteGroup -Path '/api/v3' -Routes { + <# + PUT '/pet' + #> + Add-PodeRoute -PassThru -Method Put -Path '/pet' -Authentication 'merged_auth_nokey' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + switch ($contentType) { + 'application/xml' { + $pet = ConvertFrom-PodeXml -node $WebEvent.data | ConvertTo-Json + } + 'application/json' { $pet = ConvertTo-Json $WebEvent.data } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + if ($pet -and $WebEvent.data.id) { + if ($contentType -eq 'application/json') { + $Validate = Test-PodeOAJsonSchemaCompliance -Json $pet -SchemaReference 'Pet' + } + else { + $Validate = @{'result' = $true } + } + if ($Validate.result) { + if (Update-Pet -Pet (convertfrom-json -InputObject $pet -AsHashtable)) { + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -StatusCode 404 -Value 'Pet not found' + } + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + } + } + else { + Write-PodeHtmlResponse -StatusCode 400 -Value 'Invalid ID supplied' + } + } | Set-PodeOARouteInfo -Summary 'Update an existing pet' -Description 'Update an existing pet by Id' -Tags 'pet' -OperationId 'updatePet' -PassThru | + Set-PodeOARequest -RequestBody ( + New-PodeOARequestBody -Description 'Update an existent pet in the store' -Required -Content ( + New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Pet not found' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Validation exception' + + + <# + POST '/pet' + #> + Add-PodeRoute -PassThru -Method Post -Path '/pet' -Authentication 'merged_auth_nokey' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + switch ($contentType) { + 'application/xml' { + $pet = ConvertFrom-PodeXml -node $WebEvent.data | ConvertTo-Json + } + 'application/json' { $pet = ConvertTo-Json $WebEvent.data } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + if ($contentType -eq 'application/json') { + $Validate = Test-PodeOAJsonSchemaCompliance -Json $pet -SchemaReference 'Pet' + } + else { + $Validate = @{'result' = $true } + } + if ($Validate.result) { + Add-Pet -Pet (convertfrom-json -InputObject $pet -AsHashtable) + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + } + } | Set-PodeOARouteInfo -Summary 'Add a new pet to the store' -Description 'Add a new pet to the store' -Tags 'pet' -OperationId 'addPet' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Description 'Create a new pet in the store' -Required -Content ( + New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid input' + + + <# + GET '/pet/findByStatus' + #> + Add-PodeRoute -PassThru -Method get -Path '/pet/findByStatus' -Authentication 'merged_auth_nokey' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $status = $WebEvent.Query['status'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if ($status) { + $pets = Find-PetByStatus -Status $status + if ($null -eq $pets) { + $pets = @() + } + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $pets -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $pets -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -Value 'Invalid status value' -StatusCode 400 + } + + } | Set-PodeOARouteInfo -Summary 'Finds Pets by status' -Description 'Multiple status values can be provided with comma separated strings' -Tags 'pet' -OperationId 'findPetsByStatus' -PassThru | + Set-PodeOARequest -PassThru -Parameters ( + New-PodeOAStringProperty -Name 'status' -Description 'Status values that need to be considered for filter' -Default 'available' -Enum @('available', 'pending', 'sold') | + ConvertTo-PodeOAParameter -In Query -Explode ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' -Array) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid status value' -PassThru | + Add-PodeOAResponse -StatusCode 415 + + <# + GET '/pet/findByTags' + #> + Add-PodeRoute -PassThru -Method get -Path '/pet/findByTags' -Authentication 'merged_auth_nokey' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $tags = $WebEvent.Query['tags'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if ($tags) { + $pets = Find-PetByTags -Tags $tags + if ($null -eq $pets) { + $pets = @() + } + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $pets -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $pets -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -Value 'Invalid tag value' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Finds Pets by tags' -Description 'Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.' -Tags 'pet' -OperationId 'findPetsByTags' -PassThru | + Set-PodeOARequest -PassThru -Parameters ( + New-PodeOAStringProperty -Name 'tags' -Description 'Tags to filter by' -Array | + ConvertTo-PodeOAParameter -In Query -Explode ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' -Array) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid tag value' -PassThru | + Add-PodeOAResponse -StatusCode 415 + + + + <# + GET '/pet/{petId}' + #> + Add-PodeRoute -PassThru -Method Get -Path '/pet/:petId' -Authentication 'merged_auth' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $petId = $WebEvent.Parameters['petId'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if ($petId) { + $pet = Get-Pet -Id $petId + if ($pet) { + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $pet -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $pet -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -Value 'Pet not found' -StatusCode 404 + } + } + else { + Write-PodeJsonResponse -Value 'Invalid ID supplied' -StatusCode 400 + } + + } | Set-PodeOARouteInfo -Summary 'Find pet by ID' -Description 'Returns a single pet.' -Tags 'pet' -OperationId 'getPetById' -PassThru | + Set-PodeOARequest -PassThru -Parameters ( + New-PodeOAIntProperty -Name 'petId' -Description 'ID of pet to return' -Format Int64 | + ConvertTo-PodeOAParameter -In Path -Required ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet') -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Pet not found' -PassThru | + Add-PodeOAResponse -StatusCode 415 + + + <# + POST '/pet/{petId}' + #> + + Add-PodeRoute -PassThru -Method post -Path '/pet/:petId' -Authentication 'petstore_auth' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $petId = $WebEvent.Parameters['petId'] + $name = $WebEvent.Query['name'] + $status = $WebEvent.Query['status'] + + if ($petId -and (Test-Pet -Id $petId)) { + if (Update-Pet -Id $petId -Name $name -Status $status) { + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value 'Invalid Input' + } + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value 'Invalid Input' + } + } | Set-PodeOARouteInfo -Summary 'Updates pet with ID' -Description 'Updates a pet in the store with form data' -Tags 'pet' -OperationId 'updatePetWithForm' -PassThru | + Set-PodeOARequest -PassThru -Parameters ( New-PodeOAIntProperty -Name 'petId' -Description 'ID of pet that needs to be updated' -Format Int64 | + ConvertTo-PodeOAParameter -In Path -Required ), + ( New-PodeOAStringProperty -Name 'name' -Description 'Name of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Query ) , + ( New-PodeOAStringProperty -Name 'status' -Description 'Status of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Query ) | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + <# + DELETE '/pet/{petId}' + #> + Add-PodeRoute -PassThru -Method Delete -Path '/pet/:petId' -Authentication 'merged_auth_All' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $petId = $WebEvent.Parameters['petId'] + if ($petId -and (Test-Pet -Id $petId)) { + Remove-Pet -Id $petId + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -Value 'Invalid pet value' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Deletes pet by ID' -Description 'Deletes a pet.' -Tags 'pet' -OperationId 'deletePet' -PassThru | + Set-PodeOARequest -PassThru -Parameters ( + New-PodeOAIntProperty -Name 'petId' -Description 'ID of pet that needs to be updated' -Format Int64 | + ConvertTo-PodeOAParameter -In Path -Required ) | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid pet value' + + + + #TO DO + <# + POST '/pet/{petId}/uploadImage' + #> + Add-PodeRoute -PassThru -Method post -Path '/pet/:petId/uploadImage' -Authentication 'petstore_auth' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $petId = $WebEvent.Parameters['petId'] + $additionalMetadata = $WebEvent.Query['additionalMetadata'] + if ($petId -and (Test-Pet -Id $petId)) { + $pet = Get-Pet -Id $petId + $image = "$petId-$(New-Guid).$additionalMetadata" + $outputFilePath = Join-Path -Path $using:PetImagesPath -AdditionalChildPath $image + [System.IO.File]::WriteAllBytes($outputFilePath, $WebEvent.data) + $url = "$((Get-PodeConfig).Protocol)://$((Get-PodeConfig).Address):$((Get-PodeConfig).RestFulPort)/images/$image" + $pet.photoUrls.add($url) + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -Value 'Invalid pet value' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Uploads an image' -Tags 'pet' -OperationId 'uploadFile' -PassThru | + Set-PodeOARequest -Parameters @( + ( New-PodeOAIntProperty -Name 'petId' -Format Int64 -Description 'ID of pet to update' -Required | ConvertTo-PodeOAParameter -In Path ), + ( New-PodeOAStringProperty -Name 'additionalMetadata' -Description 'Additional Metadata' | ConvertTo-PodeOAParameter -In Query ) + ) -RequestBody ( + New-PodeOARequestBody -Content ( New-PodeOAContentMediaType -MediaType 'application/octet-stream' -Upload ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content @{'application/json' = 'ApiResponse' } + + + + <# + GET '/store/inventory' + #> + Add-PodeRoute -PassThru -Method Get -Path '/store/inventory' -Authentication 'api_key' -ScriptBlock { + $result = Get-CountByStatus + Write-PodeJsonResponse -Value $result -StatusCode 200 + + } | Set-PodeOARouteInfo -Summary 'Returns pet inventories by status' -Description 'Returns a map of status codes to quantities' -Tags 'store' -OperationId 'getInventory' -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content @{ 'application/json' = New-PodeOAObjectProperty -AdditionalProperties (New-PodeOAIntProperty -Format Int32 ) } + + + <# + POST '/store/order' + #> + Add-PodeRoute -PassThru -Method post -Path '/store/order' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + switch ($contentType) { + 'application/xml' { + $order = ConvertFrom-PodeXml -node $WebEvent.data | ConvertTo-Json + } + 'application/json' { $order = ConvertTo-Json $WebEvent.data } + 'application/x-www-form-urlencoded' { $order = ConvertTo-Json $WebEvent.data } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + if ($contentType -eq 'application/json') { + $Validate = Test-PodeOAJsonSchemaCompliance -Json $order -SchemaReference 'Order' + } + else { + #no test schema support for XML + $Validate = @{'result' = $true } + } + if ($Validate.result) { + Add-Order -Order (convertfrom-json -InputObject $order -AsHashtable) + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + } + } | Set-PodeOARouteInfo -Summary 'Place an order for a pet' -Description 'Place a new order in the store' -Tags 'store' -OperationId 'placeOrder' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'Order' )) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (@{ 'application/json' = 'Order' }) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + <# + GET '/store/order/{orderId}' + #> + Add-PodeRoute -PassThru -Method Get -Path '/store/order/:orderId' -ScriptBlock { + $orderId = $WebEvent.Parameters['orderId'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if ($orderId) { + $order = Get-Order -Id $orderId + if ($order) { + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $order -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $order -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -Value 'Order not found' -StatusCode 404 + } + } + else { + Write-PodeHtmlResponse -Value 'No orderId provided. Try again?' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Find purchase order by ID' -Description 'For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.' -Tags 'store' -OperationId 'getOrderById' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + ( New-PodeOAIntProperty -Name 'orderId' -Format Int64 -Description 'ID of order that needs to be fetched' -Required | ConvertTo-PodeOAParameter -In Path ) + ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Order' ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Order not found' + + <# + DELETE '/store/order/{orderId}' + #> + Add-PodeRoute -PassThru -Method Delete -Path '/store/order/:orderId' -ScriptBlock { + $orderId = $WebEvent.Parameters['orderId'] + if ($orderId ) { + if ( Test-Order -Id $orderId) { + Remove-Order -Id $orderId + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -Value 'Order not found' -StatusCode 404 + } + } + else { + Write-PodeJsonReWrite-PodeHtmlResponsesponse -Value 'Invalid ID supplied' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Delete purchase order by ID' -Description 'For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors.' -Tags 'store' -OperationId 'deleteOrder' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + ( New-PodeOAIntProperty -Name 'orderId' -Format Int64 -Description ' ID of the order that needs to be deleted' -Required | ConvertTo-PodeOAParameter -In Path ) + ) | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Order not found' + + + + <# + POST '/user' + #> + + Add-PodeRoute -PassThru -Method Post -Path '/user' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + $responseMediaType = Get-PodeHeader -Name 'Accept' + switch ($contentType) { + 'application/xml' { + $user = ConvertFrom-PodeXml -node $WebEvent.data | ConvertTo-Json + } + 'application/json' { $user = ConvertTo-Json $WebEvent.data } + 'application/x-www-form-urlencoded' { $user = ConvertTo-Json $WebEvent.data } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + if ($contentType -eq 'application/json') { + $Validate = Test-PodeOAJsonSchemaCompliance -Json $user -SchemaReference 'User' + } + else { + #no test schema support for XML + $Validate = @{'result' = $true } + } + if ($Validate.result) { + $newUser = Add-user -User (convertfrom-json -InputObject $user -AsHashtable) + Save-PodeState -Path $using:PetDataJson + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $newUser -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $newUser -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + } + } | Set-PodeOARouteInfo -Summary 'Create user.' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'createUser' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'User' )) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' -PassThru | + Add-PodeOAResponse -Default -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'User' ) + + + <# + POST '/user/createWithList' + #> + Add-PodeRoute -PassThru -Method post -Path '/user/createWithList' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + $responseMediaType = Get-PodeHeader -Name 'Accept' + $newUsers = @() + foreach ($user in $WebEvent.data) { + switch ($contentType) { + 'application/json' { $userJson = ConvertTo-Json $user } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + if ($contentType -eq 'application/json') { + $Validate = Test-PodeOAJsonSchemaCompliance -Json $userJson -SchemaReference 'User' + } + else { + #no test schema support for XML + $Validate = @{'result' = $true } + } + if ($Validate.result) { + $newUsers += $user + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + return + } + } + $createdUsers = @() + foreach ($u in $newUsers) { + $createdUsers += Add-User -User $u + } + Save-PodeState -Path $using:PetDataJson + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $createdUsers -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $createdUsers -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } | Set-PodeOARouteInfo -Summary 'Creates list of users with given input array.' -Description 'Creates list of users with given input array.' -Tags 'user' -OperationId 'createUsersWithListInput' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Content (New-PodeOAContentMediaType -MediaType 'application/json' -Content 'User' -Array)) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'User' -Array ) -PassThru | + Add-PodeOAResponse -Default -Description 'successful operation' + + + <# + GET '/user/login' + #> + Add-PodeRoute -PassThru -Method Get -Path '/user/login' -ScriptBlock { + $username = $WebEvent.Query['username'] + $password = $WebEvent.Query['password'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if ($username) { + $user = Get-User -Username $username + if ($user -and $user['password'] -eq $password) { + Set-PodeHeader -Name 'X-Expires-After' -Value ((Get-Date).AddHours(1).ToString('yyyy-MM-ddTHH:mm:ssK')) + Set-PodeHeader -Name 'X-Rate-Limit' -Value '5000' + $result = @{'api_key' = 'test-key' } + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $result -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $result -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -Value 'Invalid username/password supplied' -StatusCode 400 + } + } + else { + Write-PodeHtmlResponse -Value 'Invalid username/password supplied' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Logs user into the system.' -Tags 'user' -OperationId 'loginUser' -PassThru | + Set-PodeOARequest -Parameters ( New-PodeOAStringProperty -Name 'username' -Description 'The user name for login' | ConvertTo-PodeOAParameter -In Query ), + ( New-PodeOAStringProperty -Name 'password' -Description 'The password for login in clear text' -Format Password | ConvertTo-PodeOAParameter -In Query ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'string' ) ` + -Headers (New-PodeOAIntProperty -Name 'X-Rate-Limit' -Description 'calls per hour allowed by the user' -Format Int32), + (New-PodeOAStringProperty -Name 'X-Expires-After' -Description 'date in UTC when token expires' -Format Date-Time) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username/password supplied' + + <# + GET '/user/logout' + #> + Add-PodeRoute -PassThru -Method Get -Path '/user/logout' -ScriptBlock { + Write-PodeJsonResponse -Value 'Successful operation' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Logs out current logged in user session.' -Tags 'user' -OperationId 'logoutUser' -PassThru | + Add-PodeOAResponse -Default -Description 'Successful operation' + + + <# + GET '/user/{username}' + #> + Add-PodeRoute -PassThru -Method Get -Path '/user/:username' -ScriptBlock { + $username = $WebEvent.Parameters['username'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if ($username) { + $user = Get-User -Username $username + if ($user) { + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $user -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $user -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -Value 'User not found' -StatusCode 404 + } + } + else { + Write-PodeHtmlResponse -Value 'Invalid username supplied' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Get user by user name' -Tags 'user' -OperationId 'getUserByName' -PassThru | + Set-PodeOARequest -Parameters ( New-PodeOAStringProperty -Name 'username' -Description 'The name that needs to be fetched. Use user1 for testing.' -Required | ConvertTo-PodeOAParameter -In Path ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'User' ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' + + <# + PUT '/user/{username}' + #> + Add-PodeRoute -PassThru -Method Put -Path '/user/:username' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + $username = $WebEvent.Parameters['username'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if (Test-User -Username $username) { + switch ($contentType) { + 'application/xml' { + $user = ConvertFrom-PodeXml -node $WebEvent.data | ConvertTo-Json + } + 'application/json' { $user = ConvertTo-Json $WebEvent.data } + 'application/x-www-form-urlencoded' { $user = ConvertTo-Json $WebEvent.data } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + if ($contentType -eq 'application/json') { + $Validate = Test-PodeOAJsonSchemaCompliance -Json $user -SchemaReference 'User' + } + else { + #no test schema support for XML + $Validate = @{'result' = $true } + } + if ($Validate.result) { + $newUser = Add-user -User (convertfrom-json -InputObject $user -AsHashtable) + Save-PodeState -Path $using:PetDataJson + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $newUser -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $newUser -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + } + } + else { + Write-PodeHtmlResponse -StatusCode 404 -Value 'User not found' + } + } | Set-PodeOARouteInfo -Summary 'Update user' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'updateUser' -PassThru | + Set-PodeOARequest -Parameters ( New-PodeOAStringProperty -Name 'username' -Description ' name that need to be updated.' -Required | ConvertTo-PodeOAParameter -In Path ) ` + -RequestBody ( New-PodeOARequestBody -Required -Description 'Update an existent user in the store' -Content ( + New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'User' + )) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' -PassThru | + Add-PodeOAResponse -Default -Description 'successful operation' + + <# + DELETE '/user/{username}' + #> + Add-PodeRoute -PassThru -Method Delete -Path '/user/:username' -ScriptBlock { + $username = $WebEvent.Parameters['username'] + if ($username ) { + if ( Test-User -Username $username) { + Remove-User -Username $orderId + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -Value 'User not found' -StatusCode 404 + } + } + else { + Write-PodeJsonReWrite-PodeHtmlResponsesponse -Value 'Invalid username supplied' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Delete user' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'deleteUser' -PassThru | + Set-PodeOARequest -Parameters ( New-PodeOAStringProperty -Name 'username' -Description 'The name that needs to be deleted.' -Required | ConvertTo-PodeOAParameter -In Path ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' + } +} \ No newline at end of file diff --git a/examples/PetStore/Petstore-openApiMultiTag.ps1 b/examples/PetStore/Petstore-openApiMultiTag.ps1 new file mode 100644 index 000000000..c3461032c --- /dev/null +++ b/examples/PetStore/Petstore-openApiMultiTag.ps1 @@ -0,0 +1,871 @@ +param ( + [switch] + $Reset +) +$petStorePath = Split-Path -Parent -Path $MyInvocation.MyCommand.Path +$podePath = Split-Path -Parent -Path (Split-Path -Parent -Path $petStorePath) +if (Test-Path -Path "$($podePath)/src/Pode.psm1" -PathType Leaf) { + Import-Module "$($podePath)/src/Pode.psm1" -Force -ErrorAction Stop +} +else { + Import-Module -Name 'Pode' +} + +Import-Module -Name "$petStorePath/PetData.psm1" +Import-Module -Name "$petStorePath/Order.psm1" +Import-Module -Name "$petStorePath/UserData.psm1" + +Start-PodeServer -Threads 1 -ScriptBlock { + + $script:PetDataPath = Join-Path -Path $PetStorePath -ChildPath 'data' + If (!(Test-Path -PathType container -Path $script:PetDataPath)) { + New-Item -ItemType Directory -Path $script:PetDataPath -Force | Out-Null + } + + $script:PetImagesPath = Join-Path -Path $PetStorePath -ChildPath 'images' + If (!(Test-Path -PathType container -Path $script:PetImagesPath)) { + New-Item -ItemType Directory -Path $script:PetImagesPath -Force | Out-Null + } + + $script:CertsPath = Join-Path -Path $PetStorePath -ChildPath 'certs' + If (!(Test-Path -PathType container -Path $script:CertsPath)) { + New-Item -ItemType Directory -Path $script:CertsPath -Force | Out-Null + } + + + #Load data + $script:PetDataJson = Join-Path -Path $PetDataPath -ChildPath 'PetData.json' + if ($Reset.IsPresent -or !(Test-Path -Path $script:PetDataJson -PathType Leaf )) { + Initialize-Categories -Reset + Initialize-Pet -Reset + Initialize-Order -Reset + Initialize-Users -Reset + Save-PodeState -Path $script:PetDataJson + } + else { + Initialize-Categories + Initialize-Pet + Initialize-Order + Initialize-Users + # attempt to re-initialise the state (will do nothing if the file doesn't exist) + Restore-PodeState -Path $script:PetDataJson + } + + + if ((Get-PodeConfig).Protocol -eq 'Https') { + $Certificate = Join-Path -Path $CertsPath -ChildPath (Get-PodeConfig).Certificate + $CertificateKey = Join-Path -Path $CertsPath -ChildPath (Get-PodeConfig).CertificateKey + Add-PodeEndpoint -Address (Get-PodeConfig).Address -Port (Get-PodeConfig).RestFulPort -Protocol Https -Certificate $Certificate -CertificateKey $CertificateKey -CertificatePassword (Get-PodeConfig).CertificatePassword -Default + } + else { + Add-PodeEndpoint -Address (Get-PodeConfig).Address -Port (Get-PodeConfig).RestFulPort -Protocol Http -Default -Name 'endpoint_v3' + Add-PodeEndpoint -Address (Get-PodeConfig).Address -Port ((Get-PodeConfig).RestFulPort + 1) -Protocol Http -Default -Name 'endpoint_v3.1' + } + New-PodeLoggingMethod -Terminal | Enable-PodeErrorLogging + + #Configure CORS + Set-PodeSecurityAccessControl -Origin '*' -Duration 7200 -WithOptions -AuthorizationHeader -autoMethods -AutoHeader -Credentials -CrossDomainXhrRequests #-Header 'content-type' # -Header 'Accept','Content-Type' ,'Connection' #-Headers '*' 'x-requested-with' ,'crossdomain'# + + + #image folder + Add-PodeStaticRoute -Path '/images' -Source $script:PetImagesPath + + + + Enable-PodeOpenApi -Path '/docs/openapi/v3.0' -OpenApiVersion '3.0.2' -EnableSchemaValidation -DisableMinimalDefinitions -NoDefaultResponses -EndpointName 'endpoint_v3' + Enable-PodeOpenApi -Path '/docs/openapi/v3.1' -OpenApiVersion '3.1.0' -EnableSchemaValidation -DisableMinimalDefinitions -NoDefaultResponses -DefinitionTag 'v3.1' -EndpointName 'endpoint_v3.1' + $swaggerDocs = New-PodeOAExternalDoc -Description 'Find out more about Swagger' -Url 'http://swagger.io' + $swaggerDocs | Add-PodeOAExternalDoc -DefinitionTag 'v3.0.3', 'v3.1' + + + + $InfoDescription = @' +This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at [http://swagger.io](http://swagger.io). +In the third iteration of the pet store, we've switched to the design first approach! +You can now help us improve the API whether it's by making changes to the definition itself or to the code. +That way, with time, we can improve the API in general, and expose some of the new features in OAS3. + +Some useful links: +- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore) +- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml) +'@ + + + Add-PodeOAInfo -Title 'Swagger Petstore - OpenAPI 3.0' -Version 1.0.17 -Description $InfoDescription -TermsOfService 'http://swagger.io/terms/' -LicenseName 'Apache 2.0' ` + -LicenseUrl 'http://www.apache.org/licenses/LICENSE-2.0.html' -ContactName 'API Support' -ContactEmail 'apiteam@swagger.io' -DefinitionTag 'v3.0.3' + + Add-PodeOAInfo -Title 'Swagger Petstore - OpenAPI 3.1' -Version 1.0.17 -Description $InfoDescription -TermsOfService 'http://swagger.io/terms/' -LicenseName 'Apache 2.0' ` + -LicenseUrl 'http://www.apache.org/licenses/LICENSE-2.0.html' -ContactName 'API Support' -ContactEmail 'apiteam@swagger.io' -DefinitionTag 'v3.1' + + Add-PodeOAServerEndpoint -url '/api/v3' -Description 'default endpoint' -DefinitionTag 'v3.0.3', 'v3.1' + + #OpenAPI 3.0 + Enable-PodeOAViewer -Type Swagger -Path '/docs/swagger' -DefinitionTag 'v3.0.3' -EndpointName 'endpoint_v3' + Enable-PodeOAViewer -Type ReDoc -Path '/docs/redoc' -DarkMode -DefinitionTag 'v3.0.3' -EndpointName 'endpoint_v3' + Enable-PodeOAViewer -Type RapiDoc -Path '/docs/rapidoc' -DarkMode -DefinitionTag 'v3.0.3' -EndpointName 'endpoint_v3' + Enable-PodeOAViewer -Type StopLight -Path '/docs/stoplight' -DarkMode -DefinitionTag 'v3.0.3' -EndpointName 'endpoint_v3' + Enable-PodeOAViewer -Type Explorer -Path '/docs/explorer' -DarkMode -DefinitionTag 'v3.0.3' -EndpointName 'endpoint_v3' + Enable-PodeOAViewer -Type RapiPdf -Path '/docs/rapipdf' -DarkMode -DefinitionTag 'v3.0.3' -EndpointName 'endpoint_v3' + Enable-PodeOAViewer -Bookmarks -Path '/docs' -DefinitionTag 'v3.0.3' -EndpointName 'endpoint_v3' + Enable-PodeOAViewer -Editor -Path '/docs/swagger-editor' -DefinitionTag 'v3.0.3' -EndpointName 'endpoint_v3' + + #OpenAPI 3.1 + Enable-PodeOAViewer -Type Swagger -Path '/docs/swagger' -DefinitionTag 'v3.1' -EndpointName 'endpoint_v3.1' + Enable-PodeOAViewer -Type ReDoc -Path '/docs/vredoc' -DarkMode -DefinitionTag 'v3.1' -EndpointName 'endpoint_v3.1' + Enable-PodeOAViewer -Type RapiDoc -Path '/docs/rapidoc' -DarkMode -DefinitionTag 'v3.1' -EndpointName 'endpoint_v3.1' + Enable-PodeOAViewer -Type StopLight -Path '/docs/stoplight' -DarkMode -DefinitionTag 'v3.1' -EndpointName 'endpoint_v3.1' + Enable-PodeOAViewer -Type Explorer -Path '/docs/explorer' -DarkMode -DefinitionTag 'v3.1' -EndpointName 'endpoint_v3.1' + Enable-PodeOAViewer -Bookmarks -Path '/docs' -DefinitionTag 'v3.1' -EndpointName 'endpoint_v3.1' + + # setup session details + Enable-PodeSessionMiddleware -Duration 120 -Extend + + New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'read:pets' -Description 'read your pets' + New-PodeAccessScheme -Type Scope | Add-PodeAccess -Name 'write:pets' -Description 'modify pets in your account' + $clientId = '123123123' + $clientSecret = '' + + New-PodeAuthScheme -OAuth2 -ClientId $ClientId -ClientSecret $ClientSecret ` + -AuthoriseUrl 'https://petstore3.swagger.io/oauth/authorize' ` + -TokenUrl 'https://petstore3.swagger.io/oauth/token' ` + -Scope 'read:pets', 'write:pets' | + Add-PodeAuth -Name 'petstore_auth' -FailureUrl 'https://petstore3.swagger.io/oauth/failure' -SuccessUrl '/' -ScriptBlock { + param($user, $accessToken, $refreshToken) + return @{ User = $user } + } + + New-PodeAuthScheme -ApiKey -LocationName 'api_key' | Add-PodeAuth -Name 'api_key' -Sessionless -ScriptBlock { + param($key) + if ($key) { + # here you'd check a real storage, this is just for example + if ($key -eq 'test-key') { + return @{ + User = @{ + 'ID' = 'M0R7Y302' + 'Name' = 'Morty' + 'Type' = 'Human' + } + } + } + + # authentication failed + return @{ + Code = 401 + Challenge = 'qop="auth", nonce=""' + } + } + else { + return @{ + Message = 'No Authorization header found' + Code = 401 + } + + } + } + + New-PodeAuthScheme -Basic -Realm 'PetStore' | Add-PodeAuth -Name 'Basic' -Sessionless -ScriptBlock { + param($username, $password) + write-host $username + write-host $password + + # here you'd check a real user storage, this is just for example + if ($username -eq 'morty' -and $password -eq 'pickle') { + return @{ + User = @{ + ID = 'M0R7Y302' + Name = 'Morty' + Type = 'Human' + Username = 'm.orty' + Scopes = @( 'read:pets' , 'write:pets' ) + } + } + } + return @{ Message = 'Invalid details supplied' } + } + + Merge-PodeAuth -Name 'merged_auth' -Authentication 'Basic', 'api_key' -Valid One + Merge-PodeAuth -Name 'merged_auth_All' -Authentication 'Basic', 'api_key' -Valid All -ScriptBlock {} + Merge-PodeAuth -Name 'merged_auth_nokey' -Authentication 'Basic' -Valid One + + Add-PodeOATag -Name 'user' -Description 'Operations about user' -DefinitionTag 'v3.0.3' + Add-PodeOATag -Name 'store' -Description 'Access to Petstore orders' -ExternalDoc $swaggerDocs -DefinitionTag 'v3.0.3' + Add-PodeOATag -Name 'pet' -Description 'Everything about your Pets' -ExternalDoc $swaggerDocs -DefinitionTag 'v3.0.3' + + + Select-PodeOADefinition -Tag 'v3.0.3', 'v3.1' -Scriptblock { + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 10 -Required | + New-PodeOAIntProperty -Name 'petId' -Format Int64 -Example 198772 -Required | + New-PodeOAIntProperty -Name 'quantity' -Format Int32 -Example 7 -Required | + New-PodeOAStringProperty -Name 'shipDate' -Format Date-Time | + New-PodeOAStringProperty -Name 'status' -Description 'Order Status' -Required -Example 'approved' -Enum @('placed', 'approved', 'delivered') | + New-PodeOABoolProperty -Name 'complete' | + New-PodeOAObjectProperty -XmlName 'order' | + Add-PodeOAComponentSchema -Name 'Order' + + New-PodeOAStringProperty -Name 'street' -Example '437 Lytton' -Required | + New-PodeOAStringProperty -Name 'city' -Example 'Palo Alto' -Required | + New-PodeOAStringProperty -Name 'state' -Example 'CA' -Required | + New-PodeOAStringProperty -Name 'zip' -Example '94031' -Required | + New-PodeOAObjectProperty -XmlName 'address' | + Add-PodeOAComponentSchema -Name 'Address' + + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 100000 | + New-PodeOAStringProperty -Name 'username' -example 'fehguy' | + New-PodeOASchemaProperty -Name 'Address' -Reference 'Address' -Array -XmlName 'addresses' -XmlWrapped | + New-PodeOAObjectProperty -XmlName 'customer' | + Add-PodeOAComponentSchema -Name 'Customer' + + + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 1 | + New-PodeOAStringProperty -Name 'name' -Example 'Dogs' | + New-PodeOAObjectProperty -XmlName 'category' | + Add-PodeOAComponentSchema -Name 'Category' + + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 10 | + New-PodeOAStringProperty -Name 'username' -Example 'theUser' -Required | + New-PodeOAStringProperty -Name 'firstName' -Example 'John' | + New-PodeOAStringProperty -Name 'lastName' -Example 'James' | + New-PodeOAStringProperty -Name 'email' -Format email -Example 'john@email.com' | + New-PodeOAStringProperty -Name 'lastName' -Example 'James' | + New-PodeOAStringProperty -Name 'password' -Format Password -Example '12345' -Required | + New-PodeOAStringProperty -Name 'phone' -Example '12345' | + New-PodeOAIntProperty -Name 'userStatus'-Format Int32 -Description 'User Status' -Example 1 | + New-PodeOAObjectProperty -XmlName 'user' | + Add-PodeOAComponentSchema -Name 'User' + + + + New-PodeOAIntProperty -Name 'id'-Format Int64 | + New-PodeOAStringProperty -Name 'name' | + New-PodeOAObjectProperty -XmlName 'tag' | + Add-PodeOAComponentSchema -Name 'Tag' + + New-PodeOAIntProperty -Name 'id'-Format Int64 -Example 10 -Required | + New-PodeOAStringProperty -Name 'name' -Example 'doggie' -Required | + New-PodeOASchemaProperty -Name 'category' -Reference 'Category' | + New-PodeOAStringProperty -Name 'photoUrls' -Array -XmlWrapped -XmlItemName 'photoUrl' -Required | + New-PodeOASchemaProperty -Name 'tags' -Reference 'Tag' -Array -XmlWrapped | + New-PodeOAStringProperty -Name 'status' -Description 'pet status in the store' -Enum @('available', 'pending', 'sold') | + New-PodeOAObjectProperty -XmlName 'pet' | + Add-PodeOAComponentSchema -Name 'Pet' + + + + New-PodeOAIntProperty -Name 'code'-Format Int32 | + New-PodeOAStringProperty -Name 'type' | + New-PodeOAStringProperty -Name 'message' | + New-PodeOAObjectProperty -XmlName '##default' | + Add-PodeOAComponentSchema -Name 'ApiResponse' + + + New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' | Add-PodeOAComponentRequestBody -Name 'Pet' -Description 'Pet object that needs to be added to the store' + + Add-PodeOAComponentRequestBody -Name 'UserArray' -Description 'List of user object' -Content ( + New-PodeOAContentMediaType -MediaType 'application/json' -Content 'User' -Array) + + + + + Add-PodeRouteGroup -Path '/api/v3' -Routes { + <# + PUT '/pet' + #> + Add-PodeRoute -PassThru -Method Put -Path '/pet' -Authentication 'merged_auth_nokey' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + switch ($contentType) { + 'application/xml' { + $pet = ConvertFrom-PodeXml -node $WebEvent.data | ConvertTo-Json + } + 'application/json' { $pet = ConvertTo-Json $WebEvent.data } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + if ($pet -and $WebEvent.data.id) { + if ($contentType -eq 'application/json') { + $Validate = Test-PodeOAJsonSchemaCompliance -Json $pet -SchemaReference 'Pet' + } + else { + $Validate = @{'result' = $true } + } + if ($Validate.result) { + if (Update-Pet -Pet (convertfrom-json -InputObject $pet -AsHashtable)) { + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -StatusCode 404 -Value 'Pet not found' + } + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + } + } + else { + Write-PodeHtmlResponse -StatusCode 400 -Value 'Invalid ID supplied' + } + } | Set-PodeOARouteInfo -Summary 'Update an existing pet' -Description 'Update an existing pet by Id' -Tags 'pet' -OperationId 'updatePet' -PassThru | + Set-PodeOARequest -RequestBody ( + New-PodeOARequestBody -Description 'Update an existent pet in the store' -Required -Content ( + New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Pet not found' -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Validation exception' + + + <# + POST '/pet' + #> + Add-PodeRoute -PassThru -Method Post -Path '/pet' -Authentication 'merged_auth_nokey' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + switch ($contentType) { + 'application/xml' { + $pet = ConvertFrom-PodeXml -node $WebEvent.data | ConvertTo-Json + } + 'application/json' { $pet = ConvertTo-Json $WebEvent.data } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + if ($contentType -eq 'application/json') { + $Validate = Test-PodeOAJsonSchemaCompliance -Json $pet -SchemaReference 'Pet' + } + else { + $Validate = @{'result' = $true } + } + if ($Validate.result) { + Add-Pet -Pet (convertfrom-json -InputObject $pet -AsHashtable) + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + } + } | Set-PodeOARouteInfo -Summary 'Add a new pet to the store' -Description 'Add a new pet to the store' -Tags 'pet' -OperationId 'addPet' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Description 'Create a new pet in the store' -Required -Content ( + New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' ) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid input' + + + <# + GET '/pet/findByStatus' + #> + Add-PodeRoute -PassThru -Method get -Path '/pet/findByStatus' -Authentication 'merged_auth_nokey' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $status = $WebEvent.Query['status'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if ($status) { + $pets = Find-PetByStatus -Status $status + if ($null -eq $pets) { + $pets = @() + } + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $pets -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $pets -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -Value 'Invalid status value' -StatusCode 400 + } + + } | Set-PodeOARouteInfo -Summary 'Finds Pets by status' -Description 'Multiple status values can be provided with comma separated strings' -Tags 'pet' -OperationId 'findPetsByStatus' -PassThru | + Set-PodeOARequest -PassThru -Parameters ( + New-PodeOAStringProperty -Name 'status' -Description 'Status values that need to be considered for filter' -Default 'available' -Enum @('available', 'pending', 'sold') | + ConvertTo-PodeOAParameter -In Query -Explode ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' -Array) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid status value' -PassThru | + Add-PodeOAResponse -StatusCode 415 + + <# + GET '/pet/findByTags' + #> + Add-PodeRoute -PassThru -Method get -Path '/pet/findByTags' -Authentication 'merged_auth_nokey' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $tags = $WebEvent.Query['tags'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if ($tags) { + $pets = Find-PetByTags -Tags $tags + if ($null -eq $pets) { + $pets = @() + } + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $pets -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $pets -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -Value 'Invalid tag value' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Finds Pets by tags' -Description 'Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.' -Tags 'pet' -OperationId 'findPetsByTags' -PassThru | + Set-PodeOARequest -PassThru -Parameters ( + New-PodeOAStringProperty -Name 'tags' -Description 'Tags to filter by' -Array | + ConvertTo-PodeOAParameter -In Query -Explode ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet' -Array) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid tag value' -PassThru | + Add-PodeOAResponse -StatusCode 415 + + + + <# + GET '/pet/{petId}' + #> + Add-PodeRoute -PassThru -Method Get -Path '/pet/:petId' -Authentication 'merged_auth' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $petId = $WebEvent.Parameters['petId'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if ($petId) { + $pet = Get-Pet -Id $petId + if ($pet) { + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $pet -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $pet -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -Value 'Pet not found' -StatusCode 404 + } + } + else { + Write-PodeJsonResponse -Value 'Invalid ID supplied' -StatusCode 400 + } + + } | Set-PodeOARouteInfo -Summary 'Find pet by ID' -Description 'Returns a single pet.' -Tags 'pet' -OperationId 'getPetById' -PassThru | + Set-PodeOARequest -PassThru -Parameters ( + New-PodeOAIntProperty -Name 'petId' -Description 'ID of pet to return' -Format Int64 | + ConvertTo-PodeOAParameter -In Path -Required ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Pet') -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Pet not found' -PassThru | + Add-PodeOAResponse -StatusCode 415 + + + <# + POST '/pet/{petId}' + #> + + Add-PodeRoute -PassThru -Method post -Path '/pet/:petId' -Authentication 'petstore_auth' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $petId = $WebEvent.Parameters['petId'] + $name = $WebEvent.Query['name'] + $status = $WebEvent.Query['status'] + + if ($petId -and (Test-Pet -Id $petId)) { + if (Update-Pet -Id $petId -Name $name -Status $status) { + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value 'Invalid Input' + } + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value 'Invalid Input' + } + } | Set-PodeOARouteInfo -Summary 'Updates pet with ID' -Description 'Updates a pet in the store with form data' -Tags 'pet' -OperationId 'updatePetWithForm' -PassThru | + Set-PodeOARequest -PassThru -Parameters ( New-PodeOAIntProperty -Name 'petId' -Description 'ID of pet that needs to be updated' -Format Int64 | + ConvertTo-PodeOAParameter -In Path -Required ), + ( New-PodeOAStringProperty -Name 'name' -Description 'Name of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Query ) , + ( New-PodeOAStringProperty -Name 'status' -Description 'Status of pet that needs to be updated' | ConvertTo-PodeOAParameter -In Query ) | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + <# + DELETE '/pet/{petId}' + #> + Add-PodeRoute -PassThru -Method Delete -Path '/pet/:petId' -Authentication 'merged_auth_All' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $petId = $WebEvent.Parameters['petId'] + if ($petId -and (Test-Pet -Id $petId)) { + Remove-Pet -Id $petId + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -Value 'Invalid pet value' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Deletes pet by ID' -Description 'Deletes a pet.' -Tags 'pet' -OperationId 'deletePet' -PassThru | + Set-PodeOARequest -PassThru -Parameters ( + New-PodeOAIntProperty -Name 'petId' -Description 'ID of pet that needs to be updated' -Format Int64 | + ConvertTo-PodeOAParameter -In Path -Required ) | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid pet value' + + + + #TO DO + <# + POST '/pet/{petId}/uploadImage' + #> + Add-PodeRoute -PassThru -Method post -Path '/pet/:petId/uploadImage' -Authentication 'petstore_auth' -Scope 'write:pets', 'read:pets' -ScriptBlock { + $petId = $WebEvent.Parameters['petId'] + $additionalMetadata = $WebEvent.Query['additionalMetadata'] + if ($petId -and (Test-Pet -Id $petId)) { + $pet = Get-Pet -Id $petId + $image = "$petId-$(New-Guid).$additionalMetadata" + $outputFilePath = Join-Path -Path $using:PetImagesPath -AdditionalChildPath $image + [System.IO.File]::WriteAllBytes($outputFilePath, $WebEvent.data) + $url = "$((Get-PodeConfig).Protocol)://$((Get-PodeConfig).Address):$((Get-PodeConfig).RestFulPort)/images/$image" + $pet.photoUrls.add($url) + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -Value 'Invalid pet value' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Uploads an image' -Tags 'pet' -OperationId 'uploadFile' -PassThru | + Set-PodeOARequest -Parameters @( + ( New-PodeOAIntProperty -Name 'petId' -Format Int64 -Description 'ID of pet to update' -Required | ConvertTo-PodeOAParameter -In Path ), + ( New-PodeOAStringProperty -Name 'additionalMetadata' -Description 'Additional Metadata' | ConvertTo-PodeOAParameter -In Query ) + ) -RequestBody ( + New-PodeOARequestBody -Content ( New-PodeOAContentMediaType -MediaType 'application/octet-stream' -Upload ) + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content @{'application/json' = 'ApiResponse' } + + + + <# + GET '/store/inventory' + #> + Add-PodeRoute -PassThru -Method Get -Path '/store/inventory' -Authentication 'api_key' -ScriptBlock { + $result = Get-CountByStatus + Write-PodeJsonResponse -Value $result -StatusCode 200 + + } | Set-PodeOARouteInfo -Summary 'Returns pet inventories by status' -Description 'Returns a map of status codes to quantities' -Tags 'store' -OperationId 'getInventory' -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content @{ 'application/json' = New-PodeOAObjectProperty -AdditionalProperties (New-PodeOAIntProperty -Format Int32 ) } + + + <# + POST '/store/order' + #> + Add-PodeRoute -PassThru -Method post -Path '/store/order' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + switch ($contentType) { + 'application/xml' { + $order = ConvertFrom-PodeXml -node $WebEvent.data | ConvertTo-Json + } + 'application/json' { $order = ConvertTo-Json $WebEvent.data } + 'application/x-www-form-urlencoded' { $order = ConvertTo-Json $WebEvent.data } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + if ($contentType -eq 'application/json') { + $Validate = Test-PodeOAJsonSchemaCompliance -Json $order -SchemaReference 'Order' + } + else { + #no test schema support for XML + $Validate = @{'result' = $true } + } + if ($Validate.result) { + Add-Order -Order (convertfrom-json -InputObject $order -AsHashtable) + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + } + } | Set-PodeOARouteInfo -Summary 'Place an order for a pet' -Description 'Place a new order in the store' -Tags 'store' -OperationId 'placeOrder' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'Order' )) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (@{ 'application/json' = 'Order' }) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' + + <# + GET '/store/order/{orderId}' + #> + Add-PodeRoute -PassThru -Method Get -Path '/store/order/:orderId' -ScriptBlock { + $orderId = $WebEvent.Parameters['orderId'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if ($orderId) { + $order = Get-Order -Id $orderId + if ($order) { + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $order -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $order -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -Value 'Order not found' -StatusCode 404 + } + } + else { + Write-PodeHtmlResponse -Value 'No orderId provided. Try again?' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Find purchase order by ID' -Description 'For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.' -Tags 'store' -OperationId 'getOrderById' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + ( New-PodeOAIntProperty -Name 'orderId' -Format Int64 -Description 'ID of order that needs to be fetched' -Required | ConvertTo-PodeOAParameter -In Path ) + ) | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'Order' ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Order not found' + + <# + DELETE '/store/order/{orderId}' + #> + Add-PodeRoute -PassThru -Method Delete -Path '/store/order/:orderId' -ScriptBlock { + $orderId = $WebEvent.Parameters['orderId'] + if ($orderId ) { + if ( Test-Order -Id $orderId) { + Remove-Order -Id $orderId + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -Value 'Order not found' -StatusCode 404 + } + } + else { + Write-PodeJsonReWrite-PodeHtmlResponsesponse -Value 'Invalid ID supplied' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Delete purchase order by ID' -Description 'For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors.' -Tags 'store' -OperationId 'deleteOrder' -PassThru | + Set-PodeOARequest -PassThru -Parameters @( + ( New-PodeOAIntProperty -Name 'orderId' -Format Int64 -Description ' ID of the order that needs to be deleted' -Required | ConvertTo-PodeOAParameter -In Path ) + ) | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid ID supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'Order not found' + + + + <# + POST '/user' + #> + + Add-PodeRoute -PassThru -Method Post -Path '/user' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + $responseMediaType = Get-PodeHeader -Name 'Accept' + switch ($contentType) { + 'application/xml' { + $user = ConvertFrom-PodeXml -node $WebEvent.data | ConvertTo-Json + } + 'application/json' { $user = ConvertTo-Json $WebEvent.data } + 'application/x-www-form-urlencoded' { $user = ConvertTo-Json $WebEvent.data } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + if ($contentType -eq 'application/json') { + $Validate = Test-PodeOAJsonSchemaCompliance -Json $user -SchemaReference 'User' + } + else { + #no test schema support for XML + $Validate = @{'result' = $true } + } + if ($Validate.result) { + $newUser = Add-user -User (convertfrom-json -InputObject $user -AsHashtable) + Save-PodeState -Path $using:PetDataJson + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $newUser -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $newUser -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + } + } | Set-PodeOARouteInfo -Summary 'Create user.' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'createUser' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'User' )) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' -PassThru | + Add-PodeOAResponse -Default -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'User' ) + + + <# + POST '/user/createWithList' + #> + Add-PodeRoute -PassThru -Method post -Path '/user/createWithList' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + $responseMediaType = Get-PodeHeader -Name 'Accept' + $newUsers = @() + foreach ($user in $WebEvent.data) { + switch ($contentType) { + 'application/json' { $userJson = ConvertTo-Json $user } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + if ($contentType -eq 'application/json') { + $Validate = Test-PodeOAJsonSchemaCompliance -Json $userJson -SchemaReference 'User' + } + else { + #no test schema support for XML + $Validate = @{'result' = $true } + } + if ($Validate.result) { + $newUsers += $user + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + return + } + } + $createdUsers = @() + foreach ($u in $newUsers) { + $createdUsers += Add-User -User $u + } + Save-PodeState -Path $using:PetDataJson + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $createdUsers -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $createdUsers -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } | Set-PodeOARouteInfo -Summary 'Creates list of users with given input array.' -Description 'Creates list of users with given input array.' -Tags 'user' -OperationId 'createUsersWithListInput' -PassThru | + Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Content (New-PodeOAContentMediaType -MediaType 'application/json' -Content 'User' -Array)) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'User' -Array ) -PassThru | + Add-PodeOAResponse -Default -Description 'successful operation' + + + <# + GET '/user/login' + #> + Add-PodeRoute -PassThru -Method Get -Path '/user/login' -ScriptBlock { + $username = $WebEvent.Query['username'] + $password = $WebEvent.Query['password'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if ($username) { + $user = Get-User -Username $username + if ($user -and $user['password'] -eq $password) { + Set-PodeHeader -Name 'X-Expires-After' -Value ((Get-Date).AddHours(1).ToString('yyyy-MM-ddTHH:mm:ssK')) + Set-PodeHeader -Name 'X-Rate-Limit' -Value '5000' + $result = @{'api_key' = 'test-key' } + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $result -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $result -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -Value 'Invalid username/password supplied' -StatusCode 400 + } + } + else { + Write-PodeHtmlResponse -Value 'Invalid username/password supplied' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Logs user into the system.' -Tags 'user' -OperationId 'loginUser' -PassThru | + Set-PodeOARequest -Parameters ( New-PodeOAStringProperty -Name 'username' -Description 'The user name for login' | ConvertTo-PodeOAParameter -In Query ), + ( New-PodeOAStringProperty -Name 'password' -Description 'The password for login in clear text' -Format Password | ConvertTo-PodeOAParameter -In Query ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Description 'Successful operation' -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'string' ) ` + -Headers (New-PodeOAIntProperty -Name 'X-Rate-Limit' -Description 'calls per hour allowed by the user' -Format Int32), + (New-PodeOAStringProperty -Name 'X-Expires-After' -Description 'date in UTC when token expires' -Format Date-Time) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username/password supplied' + + <# + GET '/user/logout' + #> + Add-PodeRoute -PassThru -Method Get -Path '/user/logout' -ScriptBlock { + Write-PodeJsonResponse -Value 'Successful operation' -StatusCode 200 + } | Set-PodeOARouteInfo -Summary 'Logs out current logged in user session.' -Tags 'user' -OperationId 'logoutUser' -PassThru | + Add-PodeOAResponse -Default -Description 'Successful operation' + + + <# + GET '/user/{username}' + #> + Add-PodeRoute -PassThru -Method Get -Path '/user/:username' -ScriptBlock { + $username = $WebEvent.Parameters['username'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if ($username) { + $user = Get-User -Username $username + if ($user) { + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $user -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $user -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -Value 'User not found' -StatusCode 404 + } + } + else { + Write-PodeHtmlResponse -Value 'Invalid username supplied' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Get user by user name' -Tags 'user' -OperationId 'getUserByName' -PassThru | + Set-PodeOARequest -Parameters ( New-PodeOAStringProperty -Name 'username' -Description 'The name that needs to be fetched. Use user1 for testing.' -Required | ConvertTo-PodeOAParameter -In Path ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Content (New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml' -Content 'User' ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' + + <# + PUT '/user/{username}' + #> + Add-PodeRoute -PassThru -Method Put -Path '/user/:username' -ScriptBlock { + $contentType = Get-PodeHeader -Name 'Content-Type' + $username = $WebEvent.Parameters['username'] + $responseMediaType = Get-PodeHeader -Name 'Accept' + if (Test-User -Username $username) { + switch ($contentType) { + 'application/xml' { + $user = ConvertFrom-PodeXml -node $WebEvent.data | ConvertTo-Json + } + 'application/json' { $user = ConvertTo-Json $WebEvent.data } + 'application/x-www-form-urlencoded' { $user = ConvertTo-Json $WebEvent.data } + default { + Write-PodeHtmlResponse -StatusCode 415 + return + } + } + if ($contentType -eq 'application/json') { + $Validate = Test-PodeOAJsonSchemaCompliance -Json $user -SchemaReference 'User' + } + else { + #no test schema support for XML + $Validate = @{'result' = $true } + } + if ($Validate.result) { + $newUser = Add-user -User (convertfrom-json -InputObject $user -AsHashtable) + Save-PodeState -Path $using:PetDataJson + switch ($responseMediaType) { + 'application/xml' { Write-PodeXmlResponse -Value $newUser -StatusCode 200 } + 'application/json' { Write-PodeJsonResponse -Value $newUser -StatusCode 200 } + default { Write-PodeHtmlResponse -StatusCode 415 } + } + } + else { + Write-PodeHtmlResponse -StatusCode 405 -Value ($Validate.message -join ', ') + } + } + else { + Write-PodeHtmlResponse -StatusCode 404 -Value 'User not found' + } + } | Set-PodeOARouteInfo -Summary 'Update user' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'updateUser' -PassThru | + Set-PodeOARequest -Parameters ( New-PodeOAStringProperty -Name 'username' -Description ' name that need to be updated.' -Required | ConvertTo-PodeOAParameter -In Path ) ` + -RequestBody ( New-PodeOARequestBody -Required -Description 'Update an existent user in the store' -Content ( + New-PodeOAContentMediaType -MediaType 'application/json', 'application/xml', 'application/x-www-form-urlencoded' -Content 'User' + )) -PassThru | + Add-PodeOAResponse -StatusCode 405 -Description 'Invalid Input' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' -PassThru | + Add-PodeOAResponse -Default -Description 'successful operation' + + <# + DELETE '/user/{username}' + #> + Add-PodeRoute -PassThru -Method Delete -Path '/user/:username' -ScriptBlock { + $username = $WebEvent.Parameters['username'] + if ($username ) { + if ( Test-User -Username $username) { + Remove-User -Username $orderId + Save-PodeState -Path $using:PetDataJson + } + else { + Write-PodeHtmlResponse -Value 'User not found' -StatusCode 404 + } + } + else { + Write-PodeJsonReWrite-PodeHtmlResponsesponse -Value 'Invalid username supplied' -StatusCode 400 + } + } | Set-PodeOARouteInfo -Summary 'Delete user' -Description 'This can only be done by the logged in user.' -Tags 'user' -OperationId 'deleteUser' -PassThru | + Set-PodeOARequest -Parameters ( New-PodeOAStringProperty -Name 'username' -Description 'The name that needs to be deleted.' -Required | ConvertTo-PodeOAParameter -In Path ) -PassThru | + Add-PodeOAResponse -StatusCode 400 -Description 'Invalid username supplied' -PassThru | + Add-PodeOAResponse -StatusCode 404 -Description 'User not found' + } + } + $yaml = get-PodeOADefinition -Format Yaml -DefinitionTag 'v3.0.3' + + $yaml_31 = get-PodeOADefinition -Format Yaml -DefinitionTag 'v3.1' + + + + #$r= ConvertFrom-PodeXml -node $xmlDoc + + #$pet=$r |convertto-json + + #$Validate = Test-PodeOAJsonSchemaCompliance -Json $pet -SchemaReference 'Pet' + # $json= PodeOADefinition -Format Json +} \ No newline at end of file diff --git a/examples/PetStore/UserData.psm1 b/examples/PetStore/UserData.psm1 new file mode 100644 index 000000000..6cb8be1ec --- /dev/null +++ b/examples/PetStore/UserData.psm1 @@ -0,0 +1,130 @@ + +function Initialize-Users { + param ( + [switch] + $Reset + ) + New-PodeLockable -Name 'UserLock' + if ($Reset.IsPresent) { + Lock-PodeObject -Name 'UserLock' -ScriptBlock { + Set-PodeState -Scope 'Users' -Name 'users' -Value @{} | Out-Null + Add-User -Id 1 -Username 'user1' -FirstName 'first name 1' -LastName 'last name 1' -Email 'email1@test.com' -Phone '123-456-7890' -UserStatus 1 + + Add-User -Id 2 -Username 'user2' -FirstName 'first name 2' -LastName 'last name 2' -Email 'email2@test.com' -Phone '123-456-7890' -UserStatus 2 + + Add-User -Id 3 -Username 'user3' -FirstName 'first name 3' -LastName 'last name 3' -Email 'email3@test.com' -Phone '123-456-7890' -UserStatus 3 + + Add-User -Id 4 -Username 'user4' -FirstName 'first name 4' -LastName 'last name 4' -Email 'email4@test.com' -Phone '123-456-7890' -UserStatus 1 + + Add-User -Id 5 -Username 'user5' -FirstName 'first name 5' -LastName 'last name 5' -Email 'email5@test.com' -Phone '123-456-7890' -UserStatus 2 + + Add-User -Id 6 -Username 'user6' -FirstName 'first name 6' -LastName 'last name 6' -Email 'email6@test.com' -Phone '123-456-7890' -UserStatus 3 + + Add-User -Id 7 -Username 'user7' -FirstName 'first name 7' -LastName 'last name 7' -Email 'email7@test.com' -Phone '123-456-7890' -UserStatus 1 + + Add-User -Id 8 -Username 'user8' -FirstName 'first name 8' -LastName 'last name 8' -Email 'email8@test.com' -Phone '123-456-7890' -UserStatus 2 + + Add-User -Id 9 -Username 'user9' -FirstName 'first name 9' -LastName 'last name 9' -Email 'email9@test.com' -Phone '123-456-7890' -UserStatus 3 + + Add-User -Id 10 -Username 'user10' -FirstName 'first name 10' -LastName 'last name 10' -Email 'email10@test.com' -Phone '123-456-7890' -UserStatus 1 + + Add-User -Id 11 -Username 'user?10' -FirstName 'first name ?10' -LastName 'last name ?10' -Email 'email101@test.com' -Phone '123-456-7890' -UserStatus 1 + } + } +} +function Add-User { + + [CmdletBinding(DefaultParameterSetName = 'Items')] + param ( + [Parameter(Mandatory , ParameterSetName = 'Items')] + [long] + $Id, + [Parameter(Mandatory , ParameterSetName = 'Items')] + [String] + $Username, + [Parameter(Mandatory , ParameterSetName = 'Items')] + [String] + $FirstName, + [Parameter(Mandatory , ParameterSetName = 'Items')] + [String] + $LastName, + [Parameter(Mandatory , ParameterSetName = 'Items')] + [String] + $Email, + [Parameter(Mandatory , ParameterSetName = 'Items')] + [String] + $Phone, + [Parameter(Mandatory , ParameterSetName = 'Items')] + [int] + $UserStatus, + [Parameter(Mandatory, ParameterSetName = 'Object')] + [hashtable] + $User + ) + return Lock-PodeObject -Name 'UserLock' -Return -ScriptBlock { + $users = Get-PodeState -Name 'users' + switch ($PSCmdlet.ParameterSetName) { + 'Items' { + $users[$Username] = @{ + id = $Id + username = $Username + firstName = $FirstName + lastName = $LastName + email = $Email + password = 'XXXXXXXXXXX' + phone = $Phone + userStatus = $UserStatus + } + return $users[$Username] + } + 'Object' { + $users[$User.username] = $User + return $User + } + } + } +} + + +function Remove-User { + param ( + [Parameter(Mandatory )] + [String] + $Username + ) + Lock-PodeObject -Name 'UserLock' -ScriptBlock { + $users = Get-PodeState -Name 'users' + $users.Remove( $Username) + } +} + +function Get-User { + param ( + [Parameter(Mandatory )] + [String] + $Username + ) + return Lock-PodeObject -Name 'UserLock' -Return -ScriptBlock { + $users = Get-PodeState -Name 'users' + return $users[$username] + } +} + +function Test-User { + param ( + [Parameter(Mandatory )] + [String] + $Username + ) + return Lock-PodeObject -Name 'UserLock' -Return -ScriptBlock { + $users = Get-PodeState -Name 'users' + return $users.containsKey($username) + } +} + + +Export-ModuleMember -Function Initialize-Users +Export-ModuleMember -Function Get-User +Export-ModuleMember -Function Add-User +Export-ModuleMember -Function Test-User +Export-ModuleMember -Function Remove-User \ No newline at end of file diff --git a/examples/PetStore/data/PetData.json b/examples/PetStore/data/PetData.json new file mode 100644 index 000000000..dfee685c6 --- /dev/null +++ b/examples/PetStore/data/PetData.json @@ -0,0 +1,363 @@ +{ + "categories": { + "Value": { + "Cats": 2, + "Dogs": 1, + "Rabbits": 3, + "Lions": 4 + }, + "Scope": [ + "Categories" + ] + }, + "orders": { + "Value": { + "3": { + "status": "delivered", + "complete": true, + "shipdate": "2024-02-12T17:08:06.6050923-08:00", + "petId": 1, + "id": 3, + "quantity": 50 + }, + "1": { + "status": "placed", + "complete": true, + "shipdate": "2024-02-12T17:08:06.6050923-08:00", + "petId": 1, + "id": 1, + "quantity": 100 + }, + "4": { + "status": "placed", + "complete": false, + "shipdate": "2024-02-12T17:08:06.6050923-08:00", + "petId": 1, + "id": 4, + "quantity": 20 + }, + "2": { + "status": "approved", + "complete": true, + "shipdate": "2024-02-12T17:08:06.6050923-08:00", + "petId": 1, + "id": 2, + "quantity": 50 + } + }, + "Scope": [ + "Orders" + ] + }, + "pets": { + "Value": { + "5": { + "status": "sold", + "tags": [ + "tag2", + "tag3" + ], + "photoUrls": [ + "url1", + "url2" + ], + "categoryName": { + "id": 1, + "name": "Dogs" + }, + "name": "Dog 2", + "id": 5 + }, + "11": { + "status": "pending", + "tags": [ + "tag3", + "tag4" + ], + "photoUrls": [ + "url1", + "url2" + ], + "categoryName": { + "id": 3, + "name": "Rabbits" + }, + "name": "Rabbit 2", + "id": 11 + }, + "8": { + "status": "available", + "tags": [ + "tag2", + "tag3" + ], + "photoUrls": [ + "url1", + "url2" + ], + "categoryName": { + "id": 4, + "name": "Lions" + }, + "name": "Lion 2", + "id": 8 + }, + "7": { + "status": "available", + "tags": [ + "tag1", + "tag2" + ], + "photoUrls": [ + "url1", + "url2" + ], + "categoryName": { + "id": 4, + "name": "Lions" + }, + "name": "Lion 1", + "id": 7 + }, + "4": { + "status": "available", + "tags": [ + "tag1", + "tag2" + ], + "photoUrls": [ + "url1", + "url2" + ], + "categoryName": { + "id": 1, + "name": "Dogs" + }, + "name": "Dog 1", + "id": 4 + }, + "1": { + "status": "available", + "tags": [ + "tag1", + "tag2" + ], + "photoUrls": [ + "url1", + "url2" + ], + "categoryName": { + "id": 2, + "name": "Cats" + }, + "name": "Cat 1", + "id": 1 + }, + "2": { + "status": "available", + "tags": [ + "tag2", + "tag3" + ], + "photoUrls": [ + "url1", + "url2" + ], + "categoryName": { + "id": 2, + "name": "Cats" + }, + "name": "Cat 2", + "id": 2 + }, + "10": { + "status": "available", + "tags": [ + "tag2", + "tag3" + ], + "photoUrls": [ + "url1", + "url2" + ], + "categoryName": { + "id": 3, + "name": "Rabbits" + }, + "name": "Rabbit 1", + "id": 10 + }, + "6": { + "status": "pending", + "tags": [ + "tag3", + "tag4" + ], + "photoUrls": [ + "url1", + "url2" + ], + "categoryName": { + "id": 1, + "name": "Dogs" + }, + "name": "Dog 2", + "id": 6 + }, + "3": { + "status": "pending", + "tags": [ + "tag3", + "tag4" + ], + "photoUrls": [ + "url1", + "url2" + ], + "categoryName": { + "id": 2, + "name": "Cats" + }, + "name": "Cat 2", + "id": 3 + }, + "9": { + "status": "available", + "tags": [ + "tag3", + "tag4" + ], + "photoUrls": [ + "url1", + "url2" + ], + "categoryName": { + "id": 4, + "name": "Lions" + }, + "name": "Lion 2", + "id": 9 + } + }, + "Scope": [ + "Pets" + ] + }, + "users": { + "Value": { + "user5": { + "userStatus": 2, + "firstName": "first name 5", + "email": "email5@test.com", + "lastName": "last name 5", + "phone": "123-456-7890", + "username": "user5", + "id": 5, + "password": "XXXXXXXXXXX" + }, + "user2": { + "userStatus": 2, + "firstName": "first name 2", + "email": "email2@test.com", + "lastName": "last name 2", + "phone": "123-456-7890", + "username": "user2", + "id": 2, + "password": "XXXXXXXXXXX" + }, + "user?10": { + "userStatus": 1, + "firstName": "first name ?10", + "email": "email101@test.com", + "lastName": "last name ?10", + "phone": "123-456-7890", + "username": "user?10", + "id": 11, + "password": "XXXXXXXXXXX" + }, + "user10": { + "userStatus": 1, + "firstName": "first name 10", + "email": "email10@test.com", + "lastName": "last name 10", + "phone": "123-456-7890", + "username": "user10", + "id": 10, + "password": "XXXXXXXXXXX" + }, + "user7": { + "userStatus": 1, + "firstName": "first name 7", + "email": "email7@test.com", + "lastName": "last name 7", + "phone": "123-456-7890", + "username": "user7", + "id": 7, + "password": "XXXXXXXXXXX" + }, + "user1": { + "userStatus": 1, + "firstName": "first name 1", + "email": "email1@test.com", + "lastName": "last name 1", + "phone": "123-456-7890", + "username": "user1", + "id": 1, + "password": "XXXXXXXXXXX" + }, + "user8": { + "userStatus": 2, + "firstName": "first name 8", + "email": "email8@test.com", + "lastName": "last name 8", + "phone": "123-456-7890", + "username": "user8", + "id": 8, + "password": "XXXXXXXXXXX" + }, + "user9": { + "userStatus": 3, + "firstName": "first name 9", + "email": "email9@test.com", + "lastName": "last name 9", + "phone": "123-456-7890", + "username": "user9", + "id": 9, + "password": "XXXXXXXXXXX" + }, + "user3": { + "userStatus": 3, + "firstName": "first name 3", + "email": "email3@test.com", + "lastName": "last name 3", + "phone": "123-456-7890", + "username": "user3", + "id": 3, + "password": "XXXXXXXXXXX" + }, + "user4": { + "userStatus": 1, + "firstName": "first name 4", + "email": "email4@test.com", + "lastName": "last name 4", + "phone": "123-456-7890", + "username": "user4", + "id": 4, + "password": "XXXXXXXXXXX" + }, + "user6": { + "userStatus": 3, + "firstName": "first name 6", + "email": "email6@test.com", + "lastName": "last name 6", + "phone": "123-456-7890", + "username": "user6", + "id": 6, + "password": "XXXXXXXXXXX" + } + }, + "Scope": [ + "Users" + ] + } +} diff --git a/examples/PetStore/server.psd1 b/examples/PetStore/server.psd1 new file mode 100644 index 000000000..844eed9d3 --- /dev/null +++ b/examples/PetStore/server.psd1 @@ -0,0 +1,18 @@ +@{ + RestFulPort = 8081 + Protocol = 'Http' + Address = 'localhost' + Certificate = 'Certificate.pem' + CertificateKey = 'CertificateKey.key' + CertificatePassword = 'password@01' + SessionsTtlMinutes = 360 + Server = @{ + Timeout = 60 + BodySize = 100MB + } + Web=@{ + OpenApi=@{ + DefaultDefinitionTag = 'v3.0.3' + } + } +} \ No newline at end of file diff --git a/examples/SwaggerEditor/swagger-editor.ps1 b/examples/SwaggerEditor/swagger-editor.ps1 new file mode 100644 index 000000000..1a5d17d0b --- /dev/null +++ b/examples/SwaggerEditor/swagger-editor.ps1 @@ -0,0 +1,29 @@ +param( + [int] + $Port = 8080 +) + +$path = Split-Path -Parent -Path (Split-Path -Parent -Path (Split-Path -Parent -Path $MyInvocation.MyCommand.Path)) +Import-Module "$($path)/src/Pode.psm1" -Force -ErrorAction Stop + +# or just: +# Import-Module Pode + +# create a server, and start listening on port 8085 +Start-PodeServer -Threads 2 { + + # listen on localhost:8085 + Add-PodeEndpoint -Address localhost -Port $port -Protocol Http + New-PodeLoggingMethod -Terminal | Enable-PodeRequestLogging + New-PodeLoggingMethod -Terminal | Enable-PodeErrorLogging + + # set view engine to pode renderer + Set-PodeViewEngine -Type HTML + + # STATIC asset folder route + Add-PodeStaticRoute -Path '/editor/swagger-editor-dist' -Source "$($path)/src/Misc/swagger-editor-dist" -FileBrowser + Add-PodeStaticRoute -Path '/editor' -Source './www' -Defaults @('index.html') -FileBrowser + Add-PodeRoute -Method Get -Path '/' -ScriptBlock { + Move-PodeResponseUrl -Url '/editor/index.html' + } +} \ No newline at end of file diff --git a/examples/SwaggerEditor/www/index.html b/examples/SwaggerEditor/www/index.html new file mode 100644 index 000000000..092a23bf9 --- /dev/null +++ b/examples/SwaggerEditor/www/index.html @@ -0,0 +1,112 @@ + + + + + + + Swagger Editor + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/create-routes.ps1 b/examples/create-routes.ps1 new file mode 100644 index 000000000..8ae84cd7c --- /dev/null +++ b/examples/create-routes.ps1 @@ -0,0 +1,34 @@ + +#crete routes using different approaches +$ScriptPath=Split-Path -Parent -Path $MyInvocation.MyCommand.Path +$path = Split-Path -Parent -Path $ScriptPath +if (Test-Path -Path "$($path)/src/Pode.psm1" -PathType Leaf) { + Import-Module "$($path)/src/Pode.psm1" -Force -ErrorAction Stop +} else { + Import-Module -Name 'Pode' +} + + +Start-PodeServer -Threads 1 -ScriptBlock { + Add-PodeEndpoint -Address localhost -Port 8081 -Protocol Http + New-PodeLoggingMethod -Terminal | Enable-PodeErrorLogging + + Add-PodeRoute -PassThru -Method Get -Path '/routeCreateScriptBlock/:id' -ScriptBlock ([ScriptBlock]::Create( (Get-Content -Path "$ScriptPath\scripts\routeScript.ps1" -Raw))) | + Set-PodeOARouteInfo -Summary 'Test' -OperationId 'routeCreateScriptBlock' -PassThru | + Set-PodeOARequest -Parameters @((New-PodeOAStringProperty -Name 'id' | ConvertTo-PodeOAParameter -In Path -Required) ) + + + Add-PodeRoute -PassThru -Method Post -Path '/routeFilePath/:id' -FilePath '.\scripts\routeScript.ps1' | Set-PodeOARouteInfo -Summary 'Test' -OperationId 'routeFilePath' -PassThru | + Set-PodeOARequest -Parameters @((New-PodeOAStringProperty -Name 'id' | ConvertTo-PodeOAParameter -In Path -Required) ) + + + Add-PodeRoute -PassThru -Method Get -Path '/routeScriptBlock/:id' -ScriptBlock { $Id = $WebEvent.Parameters['id'] ; Write-PodeJsonResponse -StatusCode 200 -Value @{'id' = $Id } } | + Set-PodeOARouteInfo -Summary 'Test' -OperationId 'routeScriptBlock' -PassThru | + Set-PodeOARequest -Parameters @((New-PodeOAStringProperty -Name 'id' | ConvertTo-PodeOAParameter -In Path -Required) ) + + + Add-PodeRoute -PassThru -Method Get -Path '/routeScriptSameScope/:id' -ScriptBlock { . $ScriptPath\scripts\routeScript.ps1 } | + Set-PodeOARouteInfo -Summary 'Test' -OperationId 'routeScriptSameScope' -PassThru | + Set-PodeOARequest -Parameters @((New-PodeOAStringProperty -Name 'id' | ConvertTo-PodeOAParameter -In Path -Required) ) + +} \ No newline at end of file diff --git a/examples/logging.ps1 b/examples/logging.ps1 index a752fad8a..65dfe4a02 100644 --- a/examples/logging.ps1 +++ b/examples/logging.ps1 @@ -1,15 +1,19 @@ $path = Split-Path -Parent -Path (Split-Path -Parent -Path $MyInvocation.MyCommand.Path) -Import-Module "$($path)/src/Pode.psm1" -Force -ErrorAction Stop - +if (Test-Path -Path "$($path)/src/Pode.psm1" -PathType Leaf) { + Import-Module "$($path)/src/Pode.psm1" -Force -ErrorAction Stop +} +else { + Import-Module -Name 'Pode' +} # or just: # Import-Module Pode -$LOGGING_TYPE = 'Terminal' # Terminal, File, Custom +$LOGGING_TYPE = 'terminal' # Terminal, File, Custom # create a server, and start listening on port 8085 Start-PodeServer { - Add-PodeEndpoint -Address * -Port 8085 -Protocol Http + Add-PodeEndpoint -Address localhost -Port 8085 -Protocol Http Set-PodeViewEngine -Type Pode switch ($LOGGING_TYPE.ToLowerInvariant()) { diff --git a/examples/scripts/routeScript.ps1 b/examples/scripts/routeScript.ps1 new file mode 100644 index 000000000..6ced6153f --- /dev/null +++ b/examples/scripts/routeScript.ps1 @@ -0,0 +1,4 @@ +{ + $Id = $WebEvent.Parameters['id'] + Write-PodeJsonResponse -StatusCode 200 -Value @{'id' = $Id } +} \ No newline at end of file diff --git a/examples/web-auth-basic.ps1 b/examples/web-auth-basic.ps1 index fed990bee..1ac920dd4 100644 --- a/examples/web-auth-basic.ps1 +++ b/examples/web-auth-basic.ps1 @@ -1,5 +1,10 @@ $path = Split-Path -Parent -Path (Split-Path -Parent -Path $MyInvocation.MyCommand.Path) -Import-Module "$($path)/src/Pode.psm1" -Force -ErrorAction Stop +if (Test-Path -Path "$($path)/src/Pode.psm1" -PathType Leaf) { + Import-Module "$($path)/src/Pode.psm1" -Force -ErrorAction Stop +} +else { + Import-Module -Name 'Pode' +} # or just: # Import-Module Pode @@ -23,7 +28,7 @@ Invoke-RestMethod -Uri http://localhost:8085/users -Method Post -Headers @{ Auth Start-PodeServer -Threads 2 { # listen on localhost:8085 - Add-PodeEndpoint -Address * -Port 8085 -Protocol Http + Add-PodeEndpoint -Address localhost -Port 8085 -Protocol Http # request logging New-PodeLoggingMethod -Terminal -Batch 10 -BatchTimeout 10 | Enable-PodeRequestLogging diff --git a/examples/web-auth-form-access.ps1 b/examples/web-auth-form-access.ps1 index a7551dd30..de372faa3 100644 --- a/examples/web-auth-form-access.ps1 +++ b/examples/web-auth-form-access.ps1 @@ -1,8 +1,10 @@ $path = Split-Path -Parent -Path (Split-Path -Parent -Path $MyInvocation.MyCommand.Path) -Import-Module "$($path)/src/Pode.psm1" -Force -ErrorAction Stop - -# or just: -# Import-Module Pode +if (Test-Path -Path "$($path)/src/Pode.psm1" -PathType Leaf) { + Import-Module "$($path)/src/Pode.psm1" -Force -ErrorAction Stop +} +else { + Import-Module -Name 'Pode' +} <# This examples shows how to use session persistant authentication with access. @@ -22,7 +24,7 @@ take you back to the login page. Start-PodeServer -Threads 2 { # listen on localhost:8085 - Add-PodeEndpoint -Address * -Port 8085 -Protocol Http + Add-PodeEndpoint -Address localhost -Port 8085 -Protocol Http # set the view engine Set-PodeViewEngine -Type Pode diff --git a/examples/web-auth-oauth2-form.ps1 b/examples/web-auth-oauth2-form.ps1 index 4bf3a0b75..6cbc1baa6 100644 --- a/examples/web-auth-oauth2-form.ps1 +++ b/examples/web-auth-oauth2-form.ps1 @@ -18,7 +18,7 @@ Note: You'll need to register a new app in Azure, and note you clientId, secret, Start-PodeServer -Threads 2 { # listen on localhost:8085 - Add-PodeEndpoint -Address * -Port 8085 -Protocol Http -Default + Add-PodeEndpoint -Address localhost -Port 8085 -Protocol Http -Default New-PodeLoggingMethod -Terminal | Enable-PodeErrorLogging # set the view engine diff --git a/examples/web-rest-openapi-funcs.ps1 b/examples/web-rest-openapi-funcs.ps1 index 9f6c3a411..c50b72343 100644 --- a/examples/web-rest-openapi-funcs.ps1 +++ b/examples/web-rest-openapi-funcs.ps1 @@ -5,8 +5,14 @@ Start-PodeServer { Add-PodeEndpoint -Address localhost -Port 8080 -Protocol Http Enable-PodeOpenApi -Title 'OpenAPI Example' -RouteFilter '/api/*' -RestrictRoutes - Enable-PodeOpenApiViewer -Type Swagger -DarkMode - Enable-PodeOpenApiViewer -Type ReDoc + Enable-PodeOpenApiViewer -Type Swagger -Path '/docs/swagger' + Enable-PodeOpenApiViewer -Type ReDoc -Path '/docs/redoc' + Enable-PodeOpenApiViewer -Type RapiDoc -Path '/docs/rapidoc' + Enable-PodeOpenApiViewer -Type StopLight -Path '/docs/stoplight' + Enable-PodeOpenApiViewer -Type Explorer -Path '/docs/explorer' + Enable-PodeOpenApiViewer -Type RapiPdf -Path '/docs/rapipdf' + + Enable-PodeOpenApiViewer -Bookmarks -Path '/docs' #ConvertTo-PodeRoute -Path '/api' -Commands @('Get-ChildItem', 'New-Item') ConvertTo-PodeRoute -Path '/api' -Module Pester diff --git a/examples/web-rest-openapi-shared.ps1 b/examples/web-rest-openapi-shared.ps1 index 1054014b2..3571801c0 100644 --- a/examples/web-rest-openapi-shared.ps1 +++ b/examples/web-rest-openapi-shared.ps1 @@ -1,5 +1,6 @@ $path = Split-Path -Parent -Path (Split-Path -Parent -Path $MyInvocation.MyCommand.Path) Import-Module "$($path)/src/Pode.psm1" -Force -ErrorAction Stop +#Import-Module -Name powershell-yaml -Force -ErrorAction Stop Start-PodeServer { Add-PodeEndpoint -Address localhost -Port 8080 -Protocol Http -Name 'user' @@ -8,8 +9,16 @@ Start-PodeServer { New-PodeLoggingMethod -Terminal | Enable-PodeErrorLogging Enable-PodeOpenApi -Title 'OpenAPI Example' -RouteFilter '/api/*' -RestrictRoutes - Enable-PodeOpenApiViewer -Type Swagger -DarkMode + Enable-PodeOpenApiViewer -Type Swagger Enable-PodeOpenApiViewer -Type ReDoc + Enable-PodeOpenApiViewer -Type RapiDoc + Enable-PodeOpenApiViewer -Type StopLight + Enable-PodeOpenApiViewer -Type Explorer + Enable-PodeOpenApiViewer -Type RapiPdf + + + Enable-PodeOpenApiViewer -Editor + Enable-PodeOpenApiViewer -Bookmarks New-PodeAuthScheme -Basic | Add-PodeAuth -Name 'Validate' -Sessionless -ScriptBlock { @@ -19,7 +28,7 @@ Start-PodeServer { if ($username -eq 'morty' -and $password -eq 'pickle') { return @{ User = @{ - ID ='M0R7Y302' + ID = 'M0R7Y302' Name = 'Morty' Type = 'Human' } @@ -34,59 +43,58 @@ Start-PodeServer { 'application/json' = (New-PodeOAObjectProperty -Properties @( (New-PodeOAStringProperty -Name 'Name'), (New-PodeOAIntProperty -Name 'UserId') - )) + )) } New-PodeOAIntProperty -Name 'userId' -Required | - ConvertTo-PodeOAParameter -In Path | - Add-PodeOAComponentParameter -Name 'UserId' - + ConvertTo-PodeOAParameter -In Path | + Add-PodeOAComponentParameter -Name 'UserId' Add-PodeAuthMiddleware -Name AuthMiddleware -Authentication Validate -Route '/api/*' - - Add-PodeRoute -Method Get -Path "/api/resources" -EndpointName 'user' -ScriptBlock { + Add-PodeRoute -Method Get -Path '/api/resources' -EndpointName 'user' -ScriptBlock { Write-PodeJsonResponse -Value @{ Name = 'Rick'; UserId = 123 } } -PassThru | - Set-PodeOARouteInfo -Summary 'A cool summary' -Tags 'Resources' -PassThru | - Add-PodeOAResponse -StatusCode 200 -Reference 'OK' + Set-PodeOARouteInfo -Summary 'A cool summary' -Tags 'Resources' -PassThru | + Add-PodeOAResponse -StatusCode 200 -Reference 'OK' - Add-PodeRoute -Method Post -Path "/api/resources" -ScriptBlock { + Add-PodeRoute -Method Post -Path '/api/resources' -ScriptBlock { Write-PodeJsonResponse -Value @{ Name = 'Rick'; UserId = 123 } } -PassThru | - Set-PodeOARouteInfo -Summary 'A cool summary' -Tags 'Resources' -PassThru | - Add-PodeOAResponse -StatusCode 200 -Reference 'OK' + Set-PodeOARouteInfo -Summary 'A cool summary' -Tags 'Resources' -PassThru | + Add-PodeOAResponse -StatusCode 200 -Reference 'OK' Add-PodeRoute -Method Get -Path '/api/users/:userId' -ScriptBlock { Write-PodeJsonResponse -Value @{ Name = 'Rick'; UserId = $WebEvent.Parameters['userId'] } } -PassThru | - Set-PodeOARouteInfo -Summary 'A cool summary' -Tags 'Users' -PassThru | - Set-PodeOARequest -Parameters @( + Set-PodeOARouteInfo -Summary 'A cool summary' -Tags 'Users' -PassThru | + Set-PodeOARequest -Parameters @( (ConvertTo-PodeOAParameter -Reference 'UserId') - ) -PassThru | - Add-PodeOAResponse -StatusCode 200 -Reference 'OK' + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Reference 'OK' Add-PodeRoute -Method Get -Path '/api/users' -ScriptBlock { Write-PodeJsonResponse -Value @{ Name = 'Rick'; UserId = $WebEvent.Query['userId'] } } -PassThru | - Set-PodeOARouteInfo -Summary 'A cool summary' -Tags 'Users' -PassThru | - Set-PodeOARequest -Parameters @( + Set-PodeOARouteInfo -Summary 'A cool summary' -Tags 'Users' -PassThru | + Set-PodeOARequest -Parameters @( (New-PodeOAIntProperty -Name 'userId' -Required | ConvertTo-PodeOAParameter -In Query) - ) -PassThru | - Add-PodeOAResponse -StatusCode 200 -Reference 'OK' + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Reference 'OK' Add-PodeRoute -Method Post -Path '/api/users' -ScriptBlock { Write-PodeJsonResponse -Value @{ Name = 'Rick'; UserId = $WebEvent.Data.userId } } -PassThru | - Set-PodeOARouteInfo -Summary 'A cool summary' -Tags 'Users' -PassThru | - Set-PodeOARequest -RequestBody ( - New-PodeOARequestBody -Required -ContentSchemas @{ - 'application/json' = (New-PodeOAIntProperty -Name 'userId' -Object) - } - ) -PassThru | - Add-PodeOAResponse -StatusCode 200 -Reference 'OK' + Set-PodeOARouteInfo -Summary 'A cool summary' -Tags 'Users' -PassThru | + Set-PodeOARequest -RequestBody ( + New-PodeOARequestBody -Required -ContentSchemas @{ + 'application/json' = (New-PodeOAIntProperty -Name 'userId' -Object) + } + ) -PassThru | + Add-PodeOAResponse -StatusCode 200 -Reference 'OK' + } \ No newline at end of file diff --git a/examples/web-rest-openapi-simple.ps1 b/examples/web-rest-openapi-simple.ps1 index a578b1547..072e7eba2 100644 --- a/examples/web-rest-openapi-simple.ps1 +++ b/examples/web-rest-openapi-simple.ps1 @@ -8,43 +8,43 @@ Start-PodeServer { Enable-PodeOpenApi -Title 'OpenAPI Example' -RouteFilter '/api/*' -RestrictRoutes Enable-PodeOpenApiViewer -Type Swagger -DarkMode Enable-PodeOpenApiViewer -Type ReDoc + Enable-PodeOpenApiViewer -Bookmarks -Path '/docs' - - Add-PodeRoute -Method Get -Path "/api/resources" -EndpointName 'user' -ScriptBlock { + Add-PodeRoute -Method Get -Path '/api/resources' -EndpointName 'user' -ScriptBlock { Set-PodeResponseStatus -Code 200 } - Add-PodeRoute -Method Post -Path "/api/resources" -ScriptBlock { + Add-PodeRoute -Method Post -Path '/api/resources' -ScriptBlock { Set-PodeResponseStatus -Code 200 } Add-PodeRoute -Method Get -Path '/api/users/:userId' -ScriptBlock { Write-PodeJsonResponse -Value @{ Name = 'Rick'; UserId = $WebEvent.Parameters['userId'] } - } -PassThru | - Set-PodeOARequest -Parameters @( - (New-PodeOAIntProperty -Name 'userId' -Enum @(100,300,999) -Required | ConvertTo-PodeOAParameter -In Path) - ) + } -PassThru | Set-PodeOARouteInfo -PassThru | + Set-PodeOARequest -Parameters @( + (New-PodeOAIntProperty -Name 'userId' -Enum @(100, 300, 999) -Required | ConvertTo-PodeOAParameter -In Path) + ) Add-PodeRoute -Method Get -Path '/api/users' -ScriptBlock { Write-PodeJsonResponse -Value @{ Name = 'Rick'; UserId = $WebEvent.Query['userId'] } - } -PassThru | - Set-PodeOARequest -Parameters @( + } -PassThru | Set-PodeOARouteInfo -PassThru | + Set-PodeOARequest -Parameters @( (New-PodeOAIntProperty -Name 'userId' -Required | ConvertTo-PodeOAParameter -In Query) - ) + ) Add-PodeRoute -Method Post -Path '/api/users' -ScriptBlock { Write-PodeJsonResponse -Value @{ Name = $WebEvent.Data.Name; UserId = $WebEvent.Data.UserId } - } -PassThru | - Set-PodeOARequest -RequestBody ( - New-PodeOARequestBody -Required -ContentSchemas @{ - 'application/json' = (New-PodeOAObjectProperty -Properties @( + } -PassThru | Set-PodeOARouteInfo -PassThru | + Set-PodeOARequest -RequestBody ( + New-PodeOARequestBody -Required -ContentSchemas @{ + 'application/json' = (New-PodeOAObjectProperty -Properties @( (New-PodeOAStringProperty -Name 'Name' -MaxLength 5 -Pattern '[a-zA-Z]+'), (New-PodeOAIntProperty -Name 'UserId') )) - } - ) + } + ) } diff --git a/examples/web-rest-openapi.ps1 b/examples/web-rest-openapi.ps1 index 1e51408d8..0f6e25598 100644 --- a/examples/web-rest-openapi.ps1 +++ b/examples/web-rest-openapi.ps1 @@ -8,9 +8,14 @@ Start-PodeServer { New-PodeLoggingMethod -Terminal | Enable-PodeErrorLogging Enable-PodeOpenApi -Title 'OpenAPI Example' -RouteFilter '/api/*' -RestrictRoutes - Enable-PodeOpenApiViewer -Type Swagger -DarkMode - Enable-PodeOpenApiViewer -Type ReDoc - + Enable-PodeOpenApiViewer -Type Swagger -Path '/docs/swagger' + Enable-PodeOpenApiViewer -Type ReDoc -Path '/docs/redoc' + Enable-PodeOpenApiViewer -Type RapiDoc -Path '/docs/rapidoc' + Enable-PodeOpenApiViewer -Type StopLight -Path '/docs/stoplight' + Enable-PodeOpenApiViewer -Type Explorer -Path '/docs/explorer' + Enable-PodeOpenApiViewer -Type RapiPdf -Path '/docs/rapipdf' + Enable-PodeOpenApiViewer -Editor -Path '/docs/editor' + Enable-PodeOpenApiViewer -Bookmarks -Path '/docs' New-PodeAuthScheme -Basic | Add-PodeAuth -Name 'Validate' -Sessionless -ScriptBlock { return @{ diff --git a/examples/web-static-auth.ps1 b/examples/web-static-auth.ps1 index 8e16d9c67..b065771b0 100644 --- a/examples/web-static-auth.ps1 +++ b/examples/web-static-auth.ps1 @@ -1,14 +1,16 @@ $path = Split-Path -Parent -Path (Split-Path -Parent -Path $MyInvocation.MyCommand.Path) -Import-Module "$($path)/src/Pode.psm1" -Force -ErrorAction Stop - -# or just: -# Import-Module Pode +if (Test-Path -Path "$($path)/src/Pode.psm1" -PathType Leaf) { + Import-Module "$($path)/src/Pode.psm1" -Force -ErrorAction Stop +} +else { + Import-Module -Name 'Pode' +} # create a server, and start listening on port 8085 Start-PodeServer -Threads 2 { # listen on localhost:8085 - Add-PodeEndpoint -Address * -Port 8085 -Protocol Http + Add-PodeEndpoint -Address localhost -Port 8085 -Protocol Http New-PodeLoggingMethod -Terminal | Enable-PodeRequestLogging New-PodeLoggingMethod -Terminal | Enable-PodeErrorLogging diff --git a/packers/docker/arm32/Dockerfile b/packers/docker/arm32/Dockerfile index 9f842034a..8cc8c8b7f 100644 --- a/packers/docker/arm32/Dockerfile +++ b/packers/docker/arm32/Dockerfile @@ -1,6 +1,6 @@ FROM arm32v7/ubuntu:bionic -ENV PS_VERSION=7.3.1 +ENV PS_VERSION=7.3.11 ENV PS_PACKAGE=powershell-${PS_VERSION}-linux-arm32.tar.gz ENV PS_PACKAGE_URL=https://github.com/PowerShell/PowerShell/releases/download/v${PS_VERSION}/${PS_PACKAGE} diff --git a/src/Misc/default-doc-bookmarks.html.pode b/src/Misc/default-doc-bookmarks.html.pode new file mode 100644 index 000000000..d9418eacc --- /dev/null +++ b/src/Misc/default-doc-bookmarks.html.pode @@ -0,0 +1,280 @@ + + + + + OpenAPI Documentation Bookmarks + + + + + + + + + + + +

$($data.Title)

+

Documentation

+ + +
+

OpenAPI Definition

+ + +
+ +
+ + +
+ +
+ 
Loading JSON content...
+
+ +
+ 🧡 Powered by Pode +
+ + + + \ No newline at end of file diff --git a/src/Misc/default-explorer.html.pode b/src/Misc/default-explorer.html.pode new file mode 100644 index 000000000..7954646d5 --- /dev/null +++ b/src/Misc/default-explorer.html.pode @@ -0,0 +1,60 @@ + + + + + + + $($data.Title) + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/Misc/default-file-browsing.html.pode b/src/Misc/default-file-browsing.html.pode index f27780657..2c5c6103b 100644 --- a/src/Misc/default-file-browsing.html.pode +++ b/src/Misc/default-file-browsing.html.pode @@ -1,6 +1,6 @@ - + File Browser:$($Data.Path) diff --git a/src/Misc/default-rapidoc.html.pode b/src/Misc/default-rapidoc.html.pode new file mode 100644 index 000000000..a12aa9b62 --- /dev/null +++ b/src/Misc/default-rapidoc.html.pode @@ -0,0 +1,16 @@ + + + + + $($data.Title) + + + + + + + + + + \ No newline at end of file diff --git a/src/Misc/default-rapipdf.html.pode b/src/Misc/default-rapipdf.html.pode new file mode 100644 index 000000000..1268b051c --- /dev/null +++ b/src/Misc/default-rapipdf.html.pode @@ -0,0 +1,150 @@ + + + + + RapiPdf Web Page + + + + + + + + +
+

RapiPdf Configuration

+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DescriptionValue
Colour used for headings of main sections in PDF
Colour used for sub-headings
Title of the generated PDF
Text to be printed at the bottom of every page
Include the info section in the generated PDF? + + +
Include a table of contents in the generated PDF? + + +
Include the security section in the generated PDF? + + +
Include all API details in the generated PDF? + + +
Include a list of all APIs and their summaries at the end of the generated PDF? + + +
Include OpenAPI specified examples in the generated PDF? + + +
+
+ +
+ +
+
+ + + + + + \ No newline at end of file diff --git a/src/Misc/default-redoc.html.pode b/src/Misc/default-redoc.html.pode index f179bf848..929975a08 100644 --- a/src/Misc/default-redoc.html.pode +++ b/src/Misc/default-redoc.html.pode @@ -1,20 +1,22 @@ - - - $($data.Title) - - - + + + $($data.Title) + + + + + + + + + + + - - - - - - \ No newline at end of file diff --git a/src/Misc/default-stoplight.html.pode b/src/Misc/default-stoplight.html.pode new file mode 100644 index 000000000..ce94f72ec --- /dev/null +++ b/src/Misc/default-stoplight.html.pode @@ -0,0 +1,19 @@ + + + + + + + $($data.Title) + + + + + + + + + + + + \ No newline at end of file diff --git a/src/Misc/default-swagger-editor.html.pode b/src/Misc/default-swagger-editor.html.pode new file mode 100644 index 000000000..31f52981b --- /dev/null +++ b/src/Misc/default-swagger-editor.html.pode @@ -0,0 +1,106 @@ + + + + + + Swagger Editor + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/Misc/default-swagger.html.pode b/src/Misc/default-swagger.html.pode index 7cdd320f0..15b3ebefa 100644 --- a/src/Misc/default-swagger.html.pode +++ b/src/Misc/default-swagger.html.pode @@ -1,11 +1,11 @@ - - + + $($data.Title) - - + +