diff --git a/bin/cwiki-petstore.sh b/bin/cwiki-petstore.sh new file mode 100755 index 00000000000..a24d13346dd --- /dev/null +++ b/bin/cwiki-petstore.sh @@ -0,0 +1,31 @@ +#!/bin/sh + +SCRIPT="$0" + +while [ -h "$SCRIPT" ] ; do + ls=`ls -ld "$SCRIPT"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + SCRIPT="$link" + else + SCRIPT=`dirname "$SCRIPT"`/"$link" + fi +done + +if [ ! -d "${APP_DIR}" ]; then + APP_DIR=`dirname "$SCRIPT"`/.. + APP_DIR=`cd "${APP_DIR}"; pwd` +fi + +executable="./modules/swagger-codegen-cli/target/swagger-codegen-cli.jar" + +if [ ! -f "$executable" ] +then + mvn clean package +fi + +# if you've executed sbt assembly previously it will use that instead. +export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties" +ags="$@ generate -i modules/swagger-codegen/src/test/resources/2_0/petstore.yaml -l cwiki -o samples/documentation/cwiki" + +java $JAVA_OPTS -jar $executable $ags diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ConfluenceWikiGenerator.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ConfluenceWikiGenerator.java new file mode 100644 index 00000000000..747dcdfd769 --- /dev/null +++ b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ConfluenceWikiGenerator.java @@ -0,0 +1,95 @@ +package io.swagger.codegen.languages; + +import io.swagger.codegen.*; +import io.swagger.models.properties.ArrayProperty; +import io.swagger.models.properties.MapProperty; +import io.swagger.models.properties.Property; + +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; + +public class ConfluenceWikiGenerator extends DefaultCodegen implements CodegenConfig { + private static final String ALL_OPERATIONS = ""; + protected String invokerPackage = "io.swagger.client"; + protected String groupId = "io.swagger"; + protected String artifactId = "swagger-client"; + protected String artifactVersion = "1.0.0"; + + public ConfluenceWikiGenerator() { + super(); + outputFolder = "docs"; + embeddedTemplateDir = templateDir = "confluenceWikiDocs"; + + defaultIncludes = new HashSet(); + + cliOptions.add(new CliOption("appName", "short name of the application")); + cliOptions.add(new CliOption("appDescription", "description of the application")); + cliOptions.add(new CliOption("infoUrl", "a URL where users can get more information about the application")); + cliOptions.add(new CliOption("infoEmail", "an email address to contact for inquiries about the application")); + cliOptions.add(new CliOption("licenseInfo", "a short description of the license")); + cliOptions.add(new CliOption("licenseUrl", "a URL pointing to the full license")); + cliOptions.add(new CliOption(CodegenConstants.INVOKER_PACKAGE, CodegenConstants.INVOKER_PACKAGE_DESC)); + cliOptions.add(new CliOption(CodegenConstants.GROUP_ID, CodegenConstants.GROUP_ID_DESC)); + cliOptions.add(new CliOption(CodegenConstants.ARTIFACT_ID, CodegenConstants.ARTIFACT_ID_DESC)); + cliOptions.add(new CliOption(CodegenConstants.ARTIFACT_VERSION, CodegenConstants.ARTIFACT_VERSION_DESC)); + + additionalProperties.put("appName", "Swagger Sample"); + additionalProperties.put("appDescription", "A sample swagger server"); + additionalProperties.put("infoUrl", "https://helloreverb.com"); + additionalProperties.put("infoEmail", "hello@helloreverb.com"); + additionalProperties.put("licenseInfo", "All rights reserved"); + additionalProperties.put("licenseUrl", "http://apache.org/licenses/LICENSE-2.0.html"); + additionalProperties.put(CodegenConstants.INVOKER_PACKAGE, invokerPackage); + additionalProperties.put(CodegenConstants.GROUP_ID, groupId); + additionalProperties.put(CodegenConstants.ARTIFACT_ID, artifactId); + additionalProperties.put(CodegenConstants.ARTIFACT_VERSION, artifactVersion); + + supportingFiles.add(new SupportingFile("index.mustache", "", "confluence-markup.txt")); + reservedWords = new HashSet(); + + languageSpecificPrimitives = new HashSet(); + importMapping = new HashMap(); + } + + @Override + public CodegenType getTag() { + return CodegenType.DOCUMENTATION; + } + + @Override + public String getName() { + return "cwiki"; + } + + @Override + public String getHelp() { + return "Generates confluence wiki markup."; + } + + @Override + public String getTypeDeclaration(Property p) { + if (p instanceof ArrayProperty) { + ArrayProperty ap = (ArrayProperty) p; + Property inner = ap.getItems(); + return getSwaggerType(p) + "[" + getTypeDeclaration(inner) + "]"; + } else if (p instanceof MapProperty) { + MapProperty mp = (MapProperty) p; + Property inner = mp.getAdditionalProperties(); + + return getSwaggerType(p) + "[String, " + getTypeDeclaration(inner) + "]"; + } + return super.getTypeDeclaration(p); + } + + @Override + public Map postProcessOperations(Map objs) { + Map operations = (Map) objs.get("operations"); + List operationList = (List) operations.get("operation"); + for (CodegenOperation op : operationList) { + op.httpMethod = op.httpMethod.toLowerCase(); + } + return objs; + } +} diff --git a/modules/swagger-codegen/src/main/resources/META-INF/services/io.swagger.codegen.CodegenConfig b/modules/swagger-codegen/src/main/resources/META-INF/services/io.swagger.codegen.CodegenConfig index aea2e3b1245..9d512284bda 100644 --- a/modules/swagger-codegen/src/main/resources/META-INF/services/io.swagger.codegen.CodegenConfig +++ b/modules/swagger-codegen/src/main/resources/META-INF/services/io.swagger.codegen.CodegenConfig @@ -1,6 +1,7 @@ io.swagger.codegen.languages.AndroidClientCodegen io.swagger.codegen.languages.AspNet5ServerCodegen io.swagger.codegen.languages.AsyncScalaClientCodegen +io.swagger.codegen.languages.ConfluenceWikiGenerator io.swagger.codegen.languages.CSharpClientCodegen io.swagger.codegen.languages.CppRestClientCodegen io.swagger.codegen.languages.DartClientCodegen diff --git a/modules/swagger-codegen/src/main/resources/confluenceWikiDocs/index.mustache b/modules/swagger-codegen/src/main/resources/confluenceWikiDocs/index.mustache new file mode 100644 index 00000000000..0a90ab4c549 --- /dev/null +++ b/modules/swagger-codegen/src/main/resources/confluenceWikiDocs/index.mustache @@ -0,0 +1,94 @@ +h1. {{{appName}}} {{{appDescription}}} + +{{#version}}*Version:* {{{version}}}{{/version}} + +---- + +{toc:printable=true|style=square|minLevel=2|maxLevel=3|type=list|outline=false|include=.*} + +h2. Endpoints +{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}} + h3. {{nickname}} + {status:colour=Yellow|title={{httpMethod}}|subtle=false} + {code} + {{httpMethod}} {{path}} + {code} + *Summary:* {{summary}} + *Description:* {{notes}} + + + h4. Parameters + {{#hasPathParams}} + h5. Path Parameters + ||Name||Description||Required||Default||Pattern|| + {{#pathParams}}{{>param}} + {{/pathParams}} + {{/hasPathParams}} + + {{#hasBodyParam}} + h5. Body Parameter + ||Name||Description||Required||Default||Pattern|| + {{#bodyParams}}{{>param}} + {{/bodyParams}} + {{/hasBodyParam}} + + {{#hasHeaderParam}} + h5. Header Parameters + ||Name||Description||Required||Default||Pattern|| + {{#headerParam}}{{>param}} + {{/headerParam}} + {{/hasHeaderParam}} + + {{#hasQueryParams}} + h5. Query Parameters + ||Name||Description||Required||Default||Pattern|| + {{#queryParams}}{{>param}} + {{/queryParams}} + {{/hasQueryParams}} + + + + + h4. Responses + {{#responses}} + *Status Code:* {{code}} + *Message:* {{message}} + {code:title=Response Type} +{{{dataType}}} + {code} + See [#models] + + {{#hasExamples}} + {{#examples}} + {code:title=Example {{{contentType}}} |collapse=true } + {{{example}}} +{code} + {{/examples}} + {{/hasExamples}} + + + {code:title=Response Schema |collapse=true} +{{{jsonSchema}}} + {code} + {{#examples}} + {code:title=Example {{{contentType}}} |collapse=true } +{{{example}}} + {code} + {{/examples}} + {{/responses}} + ---- +{{/operation}} +{{/operations}} +{{/apis}} +{{/apiInfo}} + +h2. Models + +{{#models}} + {{#model}} + h3. {{classname}} + ||Field Name||Required||Type||Description|| + {{#vars}} |{{name}} |{{#isNotRequired}}(x){{/isNotRequired}} |{{datatype}} |{{description}} | + {{/vars}} + {{/model}} +{{/models}} \ No newline at end of file diff --git a/modules/swagger-codegen/src/main/resources/confluenceWikiDocs/param.mustache b/modules/swagger-codegen/src/main/resources/confluenceWikiDocs/param.mustache new file mode 100644 index 00000000000..fd7d3166c37 --- /dev/null +++ b/modules/swagger-codegen/src/main/resources/confluenceWikiDocs/param.mustache @@ -0,0 +1 @@ +|{{paramName}} |{{description}} |{{^required}}(x){{/required}}{{#required}}(/){{/required}} |{{defaultValue}} | {{pattern}} | \ No newline at end of file diff --git a/samples/documentation/cwiki/.swagger-codegen-ignore b/samples/documentation/cwiki/.swagger-codegen-ignore new file mode 100644 index 00000000000..c5fa491b4c5 --- /dev/null +++ b/samples/documentation/cwiki/.swagger-codegen-ignore @@ -0,0 +1,23 @@ +# Swagger Codegen Ignore +# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/samples/documentation/cwiki/LICENSE b/samples/documentation/cwiki/LICENSE new file mode 100644 index 00000000000..8dada3edaf5 --- /dev/null +++ b/samples/documentation/cwiki/LICENSE @@ -0,0 +1,201 @@ + 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. diff --git a/samples/documentation/cwiki/confluence-markup.txt b/samples/documentation/cwiki/confluence-markup.txt new file mode 100644 index 00000000000..dcbba6877a7 --- /dev/null +++ b/samples/documentation/cwiki/confluence-markup.txt @@ -0,0 +1,1048 @@ +h1. Swagger Petstore This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + +*Version:* 1.0.0 + +---- + +{toc:printable=true|style=square|minLevel=2|maxLevel=3|type=list|outline=false|include=.*} + +h2. Endpoints + + h3. addPet + {status:colour=Yellow|title=post|subtle=false} + {code} + post /pet + {code} + *Summary:* Add a new pet to the store + *Description:* + + + h4. Parameters + + h5. Body Parameter + ||Name||Description||Required||Default||Pattern|| + |body |Pet object that needs to be added to the store |(/) | | | + + + + + + + h4. Responses + *Status Code:* 405 + *Message:* Invalid input + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid input" +} + {code} + ---- + + h3. deletePet + {status:colour=Yellow|title=delete|subtle=false} + {code} + delete /pet/{petId} + {code} + *Summary:* Deletes a pet + *Description:* + + + h4. Parameters + h5. Path Parameters + ||Name||Description||Required||Default||Pattern|| + |petId |Pet id to delete |(/) | | | + + + + + + + + h4. Responses + *Status Code:* 400 + *Message:* Invalid pet value + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid pet value" +} + {code} + ---- + + h3. findPetsByStatus + {status:colour=Yellow|title=get|subtle=false} + {code} + get /pet/findByStatus + {code} + *Summary:* Finds Pets by status + *Description:* Multiple status values can be provided with comma separated strings + + + h4. Parameters + + + + h5. Query Parameters + ||Name||Description||Required||Default||Pattern|| + |status |Status values that need to be considered for filter |(/) | | | + + + + + h4. Responses + *Status Code:* 200 + *Message:* successful operation + {code:title=Response Type} +array[Pet] + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Pet" + } + } +} + {code} + *Status Code:* 400 + *Message:* Invalid status value + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid status value" +} + {code} + ---- + + h3. findPetsByTags + {status:colour=Yellow|title=get|subtle=false} + {code} + get /pet/findByTags + {code} + *Summary:* Finds Pets by tags + *Description:* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + + + h4. Parameters + + + + h5. Query Parameters + ||Name||Description||Required||Default||Pattern|| + |tags |Tags to filter by |(/) | | | + + + + + h4. Responses + *Status Code:* 200 + *Message:* successful operation + {code:title=Response Type} +array[Pet] + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Pet" + } + } +} + {code} + *Status Code:* 400 + *Message:* Invalid tag value + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid tag value" +} + {code} + ---- + + h3. getPetById + {status:colour=Yellow|title=get|subtle=false} + {code} + get /pet/{petId} + {code} + *Summary:* Find pet by ID + *Description:* Returns a single pet + + + h4. Parameters + h5. Path Parameters + ||Name||Description||Required||Default||Pattern|| + |petId |ID of pet to return |(/) | | | + + + + + + + + h4. Responses + *Status Code:* 200 + *Message:* successful operation + {code:title=Response Type} +Pet + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Pet" + } +} + {code} + *Status Code:* 400 + *Message:* Invalid ID supplied + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid ID supplied" +} + {code} + *Status Code:* 404 + *Message:* Pet not found + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Pet not found" +} + {code} + ---- + + h3. updatePet + {status:colour=Yellow|title=put|subtle=false} + {code} + put /pet + {code} + *Summary:* Update an existing pet + *Description:* + + + h4. Parameters + + h5. Body Parameter + ||Name||Description||Required||Default||Pattern|| + |body |Pet object that needs to be added to the store |(/) | | | + + + + + + + h4. Responses + *Status Code:* 400 + *Message:* Invalid ID supplied + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid ID supplied" +} + {code} + *Status Code:* 404 + *Message:* Pet not found + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Pet not found" +} + {code} + *Status Code:* 405 + *Message:* Validation exception + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Validation exception" +} + {code} + ---- + + h3. updatePetWithForm + {status:colour=Yellow|title=post|subtle=false} + {code} + post /pet/{petId} + {code} + *Summary:* Updates a pet in the store with form data + *Description:* + + + h4. Parameters + h5. Path Parameters + ||Name||Description||Required||Default||Pattern|| + |petId |ID of pet that needs to be updated |(/) | | | + + + + + + + + h4. Responses + *Status Code:* 405 + *Message:* Invalid input + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid input" +} + {code} + ---- + + h3. uploadFile + {status:colour=Yellow|title=post|subtle=false} + {code} + post /pet/{petId}/uploadImage + {code} + *Summary:* uploads an image + *Description:* + + + h4. Parameters + h5. Path Parameters + ||Name||Description||Required||Default||Pattern|| + |petId |ID of pet to update |(/) | | | + + + + + + + + h4. Responses + *Status Code:* 200 + *Message:* successful operation + {code:title=Response Type} +ApiResponse + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/ApiResponse" + } +} + {code} + ---- + + h3. deleteOrder + {status:colour=Yellow|title=delete|subtle=false} + {code} + delete /store/order/{orderId} + {code} + *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 + + + h4. Parameters + h5. Path Parameters + ||Name||Description||Required||Default||Pattern|| + |orderId |ID of the order that needs to be deleted |(/) | | | + + + + + + + + h4. Responses + *Status Code:* 400 + *Message:* Invalid ID supplied + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid ID supplied" +} + {code} + *Status Code:* 404 + *Message:* Order not found + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Order not found" +} + {code} + ---- + + h3. getInventory + {status:colour=Yellow|title=get|subtle=false} + {code} + get /store/inventory + {code} + *Summary:* Returns pet inventories by status + *Description:* Returns a map of status codes to quantities + + + h4. Parameters + + + + + + + + h4. Responses + *Status Code:* 200 + *Message:* successful operation + {code:title=Response Type} +map[String, Integer] + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation", + "schema" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32" + } + } +} + {code} + ---- + + h3. getOrderById + {status:colour=Yellow|title=get|subtle=false} + {code} + get /store/order/{orderId} + {code} + *Summary:* Find purchase order by ID + *Description:* For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + + + h4. Parameters + h5. Path Parameters + ||Name||Description||Required||Default||Pattern|| + |orderId |ID of pet that needs to be fetched |(/) | | | + + + + + + + + h4. Responses + *Status Code:* 200 + *Message:* successful operation + {code:title=Response Type} +Order + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Order" + } +} + {code} + *Status Code:* 400 + *Message:* Invalid ID supplied + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid ID supplied" +} + {code} + *Status Code:* 404 + *Message:* Order not found + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Order not found" +} + {code} + ---- + + h3. placeOrder + {status:colour=Yellow|title=post|subtle=false} + {code} + post /store/order + {code} + *Summary:* Place an order for a pet + *Description:* + + + h4. Parameters + + h5. Body Parameter + ||Name||Description||Required||Default||Pattern|| + |body |order placed for purchasing the pet |(/) | | | + + + + + + + h4. Responses + *Status Code:* 200 + *Message:* successful operation + {code:title=Response Type} +Order + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Order" + } +} + {code} + *Status Code:* 400 + *Message:* Invalid Order + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid Order" +} + {code} + ---- + + h3. createUser + {status:colour=Yellow|title=post|subtle=false} + {code} + post /user + {code} + *Summary:* Create user + *Description:* This can only be done by the logged in user. + + + h4. Parameters + + h5. Body Parameter + ||Name||Description||Required||Default||Pattern|| + |body |Created user object |(/) | | | + + + + + + + h4. Responses + *Status Code:* 0 + *Message:* successful operation + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation" +} + {code} + ---- + + h3. createUsersWithArrayInput + {status:colour=Yellow|title=post|subtle=false} + {code} + post /user/createWithArray + {code} + *Summary:* Creates list of users with given input array + *Description:* + + + h4. Parameters + + h5. Body Parameter + ||Name||Description||Required||Default||Pattern|| + |body |List of user object |(/) | | | + + + + + + + h4. Responses + *Status Code:* 0 + *Message:* successful operation + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation" +} + {code} + ---- + + h3. createUsersWithListInput + {status:colour=Yellow|title=post|subtle=false} + {code} + post /user/createWithList + {code} + *Summary:* Creates list of users with given input array + *Description:* + + + h4. Parameters + + h5. Body Parameter + ||Name||Description||Required||Default||Pattern|| + |body |List of user object |(/) | | | + + + + + + + h4. Responses + *Status Code:* 0 + *Message:* successful operation + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation" +} + {code} + ---- + + h3. deleteUser + {status:colour=Yellow|title=delete|subtle=false} + {code} + delete /user/{username} + {code} + *Summary:* Delete user + *Description:* This can only be done by the logged in user. + + + h4. Parameters + h5. Path Parameters + ||Name||Description||Required||Default||Pattern|| + |username |The name that needs to be deleted |(/) | | | + + + + + + + + h4. Responses + *Status Code:* 400 + *Message:* Invalid username supplied + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid username supplied" +} + {code} + *Status Code:* 404 + *Message:* User not found + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "User not found" +} + {code} + ---- + + h3. getUserByName + {status:colour=Yellow|title=get|subtle=false} + {code} + get /user/{username} + {code} + *Summary:* Get user by user name + *Description:* + + + h4. Parameters + h5. Path Parameters + ||Name||Description||Required||Default||Pattern|| + |username |The name that needs to be fetched. Use user1 for testing. |(/) | | | + + + + + + + + h4. Responses + *Status Code:* 200 + *Message:* successful operation + {code:title=Response Type} +User + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + } +} + {code} + *Status Code:* 400 + *Message:* Invalid username supplied + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid username supplied" +} + {code} + *Status Code:* 404 + *Message:* User not found + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "User not found" +} + {code} + ---- + + h3. loginUser + {status:colour=Yellow|title=get|subtle=false} + {code} + get /user/login + {code} + *Summary:* Logs user into the system + *Description:* + + + h4. Parameters + + + + h5. Query Parameters + ||Name||Description||Required||Default||Pattern|| + |username |The user name for login |(/) | | | +|password |The password for login in clear text |(/) | | | + + + + + h4. Responses + *Status Code:* 200 + *Message:* successful operation + {code:title=Response Type} +String + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation", + "schema" : { + "type" : "string" + }, + "headers" : { + "X-Rate-Limit" : { + "type" : "integer", + "format" : "int32", + "description" : "calls per hour allowed by the user" + }, + "X-Expires-After" : { + "type" : "string", + "format" : "date-time", + "description" : "date in UTC when toekn expires" + } + } +} + {code} + *Status Code:* 400 + *Message:* Invalid username/password supplied + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid username/password supplied" +} + {code} + ---- + + h3. logoutUser + {status:colour=Yellow|title=get|subtle=false} + {code} + get /user/logout + {code} + *Summary:* Logs out current logged in user session + *Description:* + + + h4. Parameters + + + + + + + + h4. Responses + *Status Code:* 0 + *Message:* successful operation + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "successful operation" +} + {code} + ---- + + h3. updateUser + {status:colour=Yellow|title=put|subtle=false} + {code} + put /user/{username} + {code} + *Summary:* Updated user + *Description:* This can only be done by the logged in user. + + + h4. Parameters + h5. Path Parameters + ||Name||Description||Required||Default||Pattern|| + |username |name that need to be deleted |(/) | | | + + h5. Body Parameter + ||Name||Description||Required||Default||Pattern|| + |body |Updated user object |(/) | | | + + + + + + + h4. Responses + *Status Code:* 400 + *Message:* Invalid user supplied + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "Invalid user supplied" +} + {code} + *Status Code:* 404 + *Message:* User not found + {code:title=Response Type} + + {code} + See [#models] + + + + {code:title=Response Schema |collapse=true} +{ + "description" : "User not found" +} + {code} + ---- + +h2. Models + + h3. ApiResponse + ||Field Name||Required||Type||Description|| + |code | |Integer | | + |type | |String | | + |message | |String | | + h3. Category + ||Field Name||Required||Type||Description|| + |id | |Long | | + |name | |String | | + h3. Order + ||Field Name||Required||Type||Description|| + |id | |Long | | + |petId | |Long | | + |quantity | |Integer | | + |shipDate | |Date | | + |status | |String |Order Status | + |complete | |Boolean | | + h3. Pet + ||Field Name||Required||Type||Description|| + |id | |Long | | + |category | |Category | | + |name | |String | | + |photoUrls | |array[String] | | + |tags | |array[Tag] | | + |status | |String |pet status in the store | + h3. Tag + ||Field Name||Required||Type||Description|| + |id | |Long | | + |name | |String | | + h3. User + ||Field Name||Required||Type||Description|| + |id | |Long | | + |username | |String | | + |firstName | |String | | + |lastName | |String | | + |email | |String | | + |password | |String | | + |phone | |String | | + |userStatus | |Integer |User Status |