From e0b56502a3619921d2a76f3d6c92d22bc69d131d Mon Sep 17 00:00:00 2001 From: William Cheng Date: Sat, 14 Sep 2019 20:30:34 +0800 Subject: [PATCH] Minor improvement to asciidoc doc generator (#3889) * minor improvement to asciidoc geneator * remove empty line --- bin/asciidoc-documentation-petstore.sh | 0 .../AsciidocDocumentationCodegen.java | 34 +- .../asciidoc/.openapi-generator/VERSION | 2 +- samples/documentation/asciidoc/index.adoc | 3276 +++++++++-------- 4 files changed, 1818 insertions(+), 1494 deletions(-) mode change 100644 => 100755 bin/asciidoc-documentation-petstore.sh diff --git a/bin/asciidoc-documentation-petstore.sh b/bin/asciidoc-documentation-petstore.sh old mode 100644 new mode 100755 diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AsciidocDocumentationCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AsciidocDocumentationCodegen.java index 0f4dad2818b..5e8e788209a 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AsciidocDocumentationCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AsciidocDocumentationCodegen.java @@ -1,3 +1,19 @@ +/* + * Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech) + * + * 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. + */ + package org.openapitools.codegen.languages; import org.openapitools.codegen.*; @@ -21,7 +37,7 @@ import io.swagger.v3.oas.models.OpenAPI; /** * basic asciidoc markup generator. - * + * * @see asciidoctor */ public class AsciidocDocumentationCodegen extends DefaultCodegen implements CodegenConfig { @@ -34,7 +50,7 @@ public class AsciidocDocumentationCodegen extends DefaultCodegen implements Code /** * Lambda emitting an asciidoc "include::filename.adoc[]" if file is found in * path. Use: - * + * * 
      * {{#includemarkup}}{{name}}/description.adoc{{/includemarkup}}
      *
@@ -75,7 +91,7 @@ public class AsciidocDocumentationCodegen extends DefaultCodegen implements Code /** * Lambda emitting an asciidoc "http link" if file is found in path. Use: - * + * * 
      * {{#snippetLink}}markup until koma, /{{name}}.json{{/snippetLink}}
      *
@@ -136,7 +152,7 @@ public class AsciidocDocumentationCodegen extends DefaultCodegen implements Code /** * extracted filter value should be relative to be of use as link or include * file. - * + * * @param name filename to sanitize * @return trimmed and striped path part or empty string. */ @@ -184,10 +200,10 @@ public class AsciidocDocumentationCodegen extends DefaultCodegen implements Code cliOptions.add(new CliOption(SNIPPET_DIR, "path with includable markup snippets (e.g. test output generated by restdoc, default: .") - .defaultValue(".")); + .defaultValue(".")); cliOptions.add(new CliOption(SPEC_DIR, "path with includable markup spec files (e.g. handwritten additional docs, default: .") - .defaultValue("..")); + .defaultValue("..")); additionalProperties.put("appName", "OpenAPI Sample description"); additionalProperties.put("appDescription", "A sample OpenAPI documentation"); @@ -227,7 +243,6 @@ public class AsciidocDocumentationCodegen extends DefaultCodegen implements Code LOGGER.warn("base part for include markup lambda not found: " + specDir + " as " + Paths.get(specDir).toAbsolutePath()); } - ; this.includeSpecMarkupLambda = new IncludeMarkupLambda(specDir); additionalProperties.put("specinclude", this.includeSpecMarkupLambda); @@ -237,7 +252,6 @@ public class AsciidocDocumentationCodegen extends DefaultCodegen implements Code LOGGER.warn("base part for include markup lambda not found: " + snippetDir + " as " + Paths.get(snippetDir).toAbsolutePath()); } - ; this.includeSnippetMarkupLambda = new IncludeMarkupLambda(snippetDir); additionalProperties.put("snippetinclude", this.includeSnippetMarkupLambda); @@ -249,10 +263,10 @@ public class AsciidocDocumentationCodegen extends DefaultCodegen implements Code @Override public void processOpenAPI(OpenAPI openAPI) { if (this.includeSpecMarkupLambda != null) { - LOGGER.info("specs: " + ": " + this.includeSpecMarkupLambda.resetCounter()); + LOGGER.debug("specs: " + ": " + this.includeSpecMarkupLambda.resetCounter()); } if (this.includeSnippetMarkupLambda != null) { - LOGGER.info("snippets: " + ": " + this.includeSnippetMarkupLambda.resetCounter()); + LOGGER.debug("snippets: " + ": " + this.includeSnippetMarkupLambda.resetCounter()); } super.processOpenAPI(openAPI); } diff --git a/samples/documentation/asciidoc/.openapi-generator/VERSION b/samples/documentation/asciidoc/.openapi-generator/VERSION index 717311e32e3..0e97bd19efb 100644 --- a/samples/documentation/asciidoc/.openapi-generator/VERSION +++ b/samples/documentation/asciidoc/.openapi-generator/VERSION @@ -1 +1 @@ -unset \ No newline at end of file +4.1.3-SNAPSHOT \ No newline at end of file diff --git a/samples/documentation/asciidoc/index.adoc b/samples/documentation/asciidoc/index.adoc index e90df86635d..148466dd320 100644 --- a/samples/documentation/asciidoc/index.adoc +++ b/samples/documentation/asciidoc/index.adoc @@ -1,1659 +1,1969 @@ -= OpenAPI Petstore -team@openapitools.org -1.0.0 -:toc: left -:numbered: -:toclevels: 3 -:source-highlighter: highlightjs -:keywords: openapi, rest, OpenAPI Petstore -:specDir: modules\openapi-generator\src\main\resources\asciidoc-documentation -:snippetDir: . - -[abstract] -.Abstract -This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters. - += OpenAPI Petstore +team@openapitools.org +1.0.0 +:toc: left +:numbered: +:toclevels: 3 +:source-highlighter: highlightjs +:keywords: openapi, rest, OpenAPI Petstore +:specDir: modules/openapi-generator/src/main/resources/asciidoc-documentation +:snippetDir: . +:generator-template: v1 2019-09-03 +:info-url: https://openapi-generator.tech +:app-name: OpenAPI Petstore + +[abstract] +.Abstract +This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters. + + +// markup not found, no include ::intro.adoc[] + + +== Endpoints + + +[.Pet] +=== Pet + + +[.addPet] +==== addPet + +`POST /pet` + +Add a new pet to the store + +===== Description + + + + +// markup not found, no include ::pet/POST/spec.adoc[] + + + +===== Parameters + + +===== Body Parameter + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern -include::stubs/empty.adoc[] - - -== Endpoints - - -[.Pet] -=== Pet - - -[.addPet] -==== addPet - -`POST /pet` - -Add a new pet to the store - - -===== Parameters - - -===== Body Parameter - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - | body | Pet object that needs to be added to the store <> | X | | - -|=== - - - - -===== Return Type - - - -- - - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 405 -| Invalid input -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::Pet/addPet/POST/http-request.adoc[] - -// markup not included, not found: include::Pet/addPet/POST/http-response.adoc[] - - - -[.deletePet] -==== deletePet - -`DELETE /pet/{petId}` - -Deletes a pet - - -===== Parameters - -====== Path Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - + + +===== Return Type + + + +- + + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 405 +| Invalid input +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::pet/POST/http-request.adoc[] + + +// markup not found, no include ::pet/POST/http-response.adoc[] + + + +// file not found, no * wiremock data link :pet/POST/POST.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::pet/POST/implementation.adoc[] + + +endif::internal-generation[] + + +[.deletePet] +==== deletePet + +`DELETE /pet/{petId}` + +Deletes a pet + +===== Description + + + + +// markup not found, no include ::pet/{petId}/DELETE/spec.adoc[] + + + +===== Parameters + +====== Path Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | petId | Pet id to delete | X | null | - -|=== - - -====== Header Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - +|=== + + +====== Header Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | apiKey | | - | null | - -|=== - - - -===== Return Type - - - -- - - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 400 -| Invalid pet value -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::Pet/deletePet/DELETE/http-request.adoc[] - -// markup not included, not found: include::Pet/deletePet/DELETE/http-response.adoc[] - - - -[.findPetsByStatus] -==== findPetsByStatus - -`GET /pet/findByStatus` - -Finds Pets by status - - -// markup not included, not found: include::Pet/findPetsByStatus/operation-spec.adoc[] - - -===== Description - -Multiple status values can be provided with comma separated strings - -===== Parameters - - - - -====== Query Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - +===== Return Type + + + +- + + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 400 +| Invalid pet value +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::pet/{petId}/DELETE/http-request.adoc[] + + +// markup not found, no include ::pet/{petId}/DELETE/http-response.adoc[] + + + +// file not found, no * wiremock data link :pet/{petId}/DELETE/DELETE.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::pet/{petId}/DELETE/implementation.adoc[] + + +endif::internal-generation[] + + +[.findPetsByStatus] +==== findPetsByStatus + +`GET /pet/findByStatus` + +Finds Pets by status + +===== Description + +Multiple status values can be provided with comma separated strings + + +// markup not found, no include ::pet/findByStatus/GET/spec.adoc[] + + + +===== Parameters + + + + +====== Query Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | status | Status values that need to be considered for filter <> | X | null | - -|=== - - -===== Return Type - -array[<>] - - -===== Content Type - -* application/xml -* application/json - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 200 -| successful operation -| List[<>] - - -| 400 -| Invalid status value -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::Pet/findPetsByStatus/GET/http-request.adoc[] - -// markup not included, not found: include::Pet/findPetsByStatus/GET/http-response.adoc[] - - - -[.findPetsByTags] -==== findPetsByTags - -`GET /pet/findByTags` - -Finds Pets by tags - - +===== Return Type + +array[<>] + + +===== Content Type + +* application/xml +* application/json + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| successful operation +| List[<>] + + +| 400 +| Invalid status value +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::pet/findByStatus/GET/http-request.adoc[] + + +// markup not found, no include ::pet/findByStatus/GET/http-response.adoc[] + + + +// file not found, no * wiremock data link :pet/findByStatus/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::pet/findByStatus/GET/implementation.adoc[] + + +endif::internal-generation[] + + +[.findPetsByTags] +==== findPetsByTags + +`GET /pet/findByTags` + +Finds Pets by tags + +===== Description + +Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + + +// markup not found, no include ::pet/findByTags/GET/spec.adoc[] + + + +===== Parameters + + + + +====== Query Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern -// markup not included, not found: include::Pet/findPetsByTags/operation-spec.adoc[] - - -===== Description - -Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. - -===== Parameters - - - - -====== Query Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - | tags | Tags to filter by <> | X | null | - -|=== - - -===== Return Type - -array[<>] - - -===== Content Type - -* application/xml -* application/json - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 200 -| successful operation -| List[<>] - - -| 400 -| Invalid tag value -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::Pet/findPetsByTags/GET/http-request.adoc[] - -// markup not included, not found: include::Pet/findPetsByTags/GET/http-response.adoc[] - - - -[.getPetById] -==== getPetById - -`GET /pet/{petId}` - -Find pet by ID - - +===== Return Type + +array[<>] + + +===== Content Type + +* application/xml +* application/json + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| successful operation +| List[<>] + + +| 400 +| Invalid tag value +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::pet/findByTags/GET/http-request.adoc[] + + +// markup not found, no include ::pet/findByTags/GET/http-response.adoc[] + + + +// file not found, no * wiremock data link :pet/findByTags/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::pet/findByTags/GET/implementation.adoc[] + + +endif::internal-generation[] + + +[.getPetById] +==== getPetById + +`GET /pet/{petId}` + +Find pet by ID + +===== Description + +Returns a single pet + + +// markup not found, no include ::pet/{petId}/GET/spec.adoc[] + + + +===== Parameters + +====== Path Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern -// markup not included, not found: include::Pet/getPetById/operation-spec.adoc[] - - -===== Description - -Returns a single pet - -===== Parameters - -====== Path Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - | petId | ID of pet to return | X | null | - -|=== - - - - - -===== Return Type - -<> - - -===== Content Type - -* application/xml -* application/json - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 200 -| successful operation -| <> - - -| 400 -| Invalid ID supplied -| <<>> - - -| 404 -| Pet not found -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::Pet/getPetById/GET/http-request.adoc[] - -// markup not included, not found: include::Pet/getPetById/GET/http-response.adoc[] - - - -[.updatePet] -==== updatePet - -`PUT /pet` - -Update an existing pet - - -===== Parameters - - -===== Body Parameter - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - + + + +===== Return Type + +<> + + +===== Content Type + +* application/xml +* application/json + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| successful operation +| <> + + +| 400 +| Invalid ID supplied +| <<>> + + +| 404 +| Pet not found +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::pet/{petId}/GET/http-request.adoc[] + + +// markup not found, no include ::pet/{petId}/GET/http-response.adoc[] + + + +// file not found, no * wiremock data link :pet/{petId}/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::pet/{petId}/GET/implementation.adoc[] + + +endif::internal-generation[] + + +[.updatePet] +==== updatePet + +`PUT /pet` + +Update an existing pet + +===== Description + + + + +// markup not found, no include ::pet/PUT/spec.adoc[] + + + +===== Parameters + + +===== Body Parameter + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | body | Pet object that needs to be added to the store <> | X | | - -|=== - - - - -===== Return Type - - - -- - - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 400 -| Invalid ID supplied -| <<>> - - -| 404 -| Pet not found -| <<>> - - -| 405 -| Validation exception -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::Pet/updatePet/PUT/http-request.adoc[] - -// markup not included, not found: include::Pet/updatePet/PUT/http-response.adoc[] - - - -[.updatePetWithForm] -==== updatePetWithForm - -`POST /pet/{petId}` - -Updates a pet in the store with form data - - -===== Parameters - -====== Path Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - + + +===== Return Type + + + +- + + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 400 +| Invalid ID supplied +| <<>> + + +| 404 +| Pet not found +| <<>> + + +| 405 +| Validation exception +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::pet/PUT/http-request.adoc[] + + +// markup not found, no include ::pet/PUT/http-response.adoc[] + + + +// file not found, no * wiremock data link :pet/PUT/PUT.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::pet/PUT/implementation.adoc[] + + +endif::internal-generation[] + + +[.updatePetWithForm] +==== updatePetWithForm + +`POST /pet/{petId}` + +Updates a pet in the store with form data + +===== Description + + + + +// markup not found, no include ::pet/{petId}/POST/spec.adoc[] + + + +===== Parameters + +====== Path Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | petId | ID of pet that needs to be updated | X | null | - -|=== - - - - - -===== Return Type - - - -- - - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 405 -| Invalid input -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::Pet/updatePetWithForm/POST/http-request.adoc[] - -// markup not included, not found: include::Pet/updatePetWithForm/POST/http-response.adoc[] - - - -[.uploadFile] -==== uploadFile - -`POST /pet/{petId}/uploadImage` - -uploads an image - - -===== Parameters - -====== Path Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - + + + +===== Return Type + + + +- + + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 405 +| Invalid input +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::pet/{petId}/POST/http-request.adoc[] + + +// markup not found, no include ::pet/{petId}/POST/http-response.adoc[] + + + +// file not found, no * wiremock data link :pet/{petId}/POST/POST.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::pet/{petId}/POST/implementation.adoc[] + + +endif::internal-generation[] + + +[.uploadFile] +==== uploadFile + +`POST /pet/{petId}/uploadImage` + +uploads an image + +===== Description + + + + +// markup not found, no include ::pet/{petId}/uploadImage/POST/spec.adoc[] + + + +===== Parameters + +====== Path Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | petId | ID of pet to update | X | null | - -|=== - - - - - -===== Return Type - -<> - - -===== Content Type - -* application/json - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 200 -| successful operation -| <> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::Pet/uploadFile/POST/http-request.adoc[] - -// markup not included, not found: include::Pet/uploadFile/POST/http-response.adoc[] - - - -[.Store] -=== Store - - -[.deleteOrder] -==== deleteOrder - -`DELETE /store/order/{orderId}` - -Delete purchase order by ID - - -// markup not included, not found: include::Store/deleteOrder/operation-spec.adoc[] - - -===== Description - -For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors - -===== Parameters - -====== Path Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - + + +===== Return Type + +<> + + +===== Content Type + +* application/json + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| successful operation +| <> + +|=== + +===== Samples + + +// markup not found, no include ::pet/{petId}/uploadImage/POST/http-request.adoc[] + + +// markup not found, no include ::pet/{petId}/uploadImage/POST/http-response.adoc[] + + + +// file not found, no * wiremock data link :pet/{petId}/uploadImage/POST/POST.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::pet/{petId}/uploadImage/POST/implementation.adoc[] + + +endif::internal-generation[] + + +[.Store] +=== Store + + +[.deleteOrder] +==== deleteOrder + +`DELETE /store/order/{orderId}` + +Delete purchase order by ID + +===== Description + +For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + + +// markup not found, no include ::store/order/{orderId}/DELETE/spec.adoc[] + + + +===== Parameters + +====== Path Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | orderId | ID of the order that needs to be deleted | X | null | - -|=== - - - - - -===== Return Type - - - -- - - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 400 -| Invalid ID supplied -| <<>> - - -| 404 -| Order not found -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::Store/deleteOrder/DELETE/http-request.adoc[] - -// markup not included, not found: include::Store/deleteOrder/DELETE/http-response.adoc[] - - - -[.getInventory] -==== getInventory - -`GET /store/inventory` - -Returns pet inventories by status - - -// markup not included, not found: include::Store/getInventory/operation-spec.adoc[] - - -===== Description - -Returns a map of status codes to quantities - -===== Parameters - - - - - - -===== Return Type - - -<> - - -===== Content Type - -* application/json - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 200 -| successful operation -| Map[<>] - -|=== - -===== Samples - -// markup not included, not found: include::Store/getInventory/GET/http-request.adoc[] - -// markup not included, not found: include::Store/getInventory/GET/http-response.adoc[] - - - -[.getOrderById] -==== getOrderById - -`GET /store/order/{orderId}` - -Find purchase order by ID - - +===== Return Type + + + +- + + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 400 +| Invalid ID supplied +| <<>> + + +| 404 +| Order not found +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::store/order/{orderId}/DELETE/http-request.adoc[] + + +// markup not found, no include ::store/order/{orderId}/DELETE/http-response.adoc[] + + + +// file not found, no * wiremock data link :store/order/{orderId}/DELETE/DELETE.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::store/order/{orderId}/DELETE/implementation.adoc[] + + +endif::internal-generation[] + + +[.getInventory] +==== getInventory + +`GET /store/inventory` + +Returns pet inventories by status + +===== Description + +Returns a map of status codes to quantities + + +// markup not found, no include ::store/inventory/GET/spec.adoc[] + + + +===== Parameters + + + + + + +===== Return Type + + +<> + + +===== Content Type + +* application/json + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| successful operation +| Map[<>] + +|=== + +===== Samples + + +// markup not found, no include ::store/inventory/GET/http-request.adoc[] + + +// markup not found, no include ::store/inventory/GET/http-response.adoc[] + + + +// file not found, no * wiremock data link :store/inventory/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::store/inventory/GET/implementation.adoc[] + + +endif::internal-generation[] + + +[.getOrderById] +==== getOrderById + +`GET /store/order/{orderId}` + +Find purchase order by ID + +===== Description + +For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + + +// markup not found, no include ::store/order/{orderId}/GET/spec.adoc[] + + + +===== Parameters + +====== Path Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern -// markup not included, not found: include::Store/getOrderById/operation-spec.adoc[] - - -===== Description - -For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions - -===== Parameters - -====== Path Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - | orderId | ID of pet that needs to be fetched | X | null | - -|=== - - - - - -===== Return Type - -<> - - -===== Content Type - -* application/xml -* application/json - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 200 -| successful operation -| <> - - -| 400 -| Invalid ID supplied -| <<>> - - -| 404 -| Order not found -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::Store/getOrderById/GET/http-request.adoc[] - -// markup not included, not found: include::Store/getOrderById/GET/http-response.adoc[] - - - -[.placeOrder] -==== placeOrder - -`POST /store/order` - -Place an order for a pet - - -===== Parameters - - -===== Body Parameter - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - + + + +===== Return Type + +<> + + +===== Content Type + +* application/xml +* application/json + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| successful operation +| <> + + +| 400 +| Invalid ID supplied +| <<>> + + +| 404 +| Order not found +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::store/order/{orderId}/GET/http-request.adoc[] + + +// markup not found, no include ::store/order/{orderId}/GET/http-response.adoc[] + + + +// file not found, no * wiremock data link :store/order/{orderId}/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::store/order/{orderId}/GET/implementation.adoc[] + + +endif::internal-generation[] + + +[.placeOrder] +==== placeOrder + +`POST /store/order` + +Place an order for a pet + +===== Description + + + + +// markup not found, no include ::store/order/POST/spec.adoc[] + + + +===== Parameters + + +===== Body Parameter + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | body | order placed for purchasing the pet <> | X | | - -|=== - - - - -===== Return Type - -<> - - -===== Content Type - -* application/xml -* application/json - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 200 -| successful operation -| <> - - -| 400 -| Invalid Order -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::Store/placeOrder/POST/http-request.adoc[] - -// markup not included, not found: include::Store/placeOrder/POST/http-response.adoc[] - - - -[.User] -=== User - - -[.createUser] -==== createUser - -`POST /user` - -Create user - - -// markup not included, not found: include::User/createUser/operation-spec.adoc[] - - -===== Description - -This can only be done by the logged in user. - -===== Parameters - - -===== Body Parameter - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - + +===== Return Type + +<> + + +===== Content Type + +* application/xml +* application/json + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| successful operation +| <> + + +| 400 +| Invalid Order +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::store/order/POST/http-request.adoc[] + + +// markup not found, no include ::store/order/POST/http-response.adoc[] + + + +// file not found, no * wiremock data link :store/order/POST/POST.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::store/order/POST/implementation.adoc[] + + +endif::internal-generation[] + + +[.User] +=== User + + +[.createUser] +==== createUser + +`POST /user` + +Create user + +===== Description + +This can only be done by the logged in user. + + +// markup not found, no include ::user/POST/spec.adoc[] + + + +===== Parameters + + +===== Body Parameter + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | body | Created user object <> | X | | - -|=== - - - - -===== Return Type - - - -- - - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 0 -| successful operation -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::User/createUser/POST/http-request.adoc[] - -// markup not included, not found: include::User/createUser/POST/http-response.adoc[] - - - -[.createUsersWithArrayInput] -==== createUsersWithArrayInput - -`POST /user/createWithArray` - -Creates list of users with given input array - - -===== Parameters - - -===== Body Parameter - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - + + +===== Return Type + + + +- + + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 0 +| successful operation +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::user/POST/http-request.adoc[] + + +// markup not found, no include ::user/POST/http-response.adoc[] + + + +// file not found, no * wiremock data link :user/POST/POST.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::user/POST/implementation.adoc[] + + +endif::internal-generation[] + + +[.createUsersWithArrayInput] +==== createUsersWithArrayInput + +`POST /user/createWithArray` + +Creates list of users with given input array + +===== Description + + + + +// markup not found, no include ::user/createWithArray/POST/spec.adoc[] + + + +===== Parameters + + +===== Body Parameter + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | body | List of user object <> | X | | - -|=== - - - - -===== Return Type - - - -- - - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 0 -| successful operation -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::User/createUsersWithArrayInput/POST/http-request.adoc[] - -// markup not included, not found: include::User/createUsersWithArrayInput/POST/http-response.adoc[] - - - -[.createUsersWithListInput] -==== createUsersWithListInput - -`POST /user/createWithList` - -Creates list of users with given input array - - -===== Parameters - - -===== Body Parameter - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - + + +===== Return Type + + + +- + + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 0 +| successful operation +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::user/createWithArray/POST/http-request.adoc[] + + +// markup not found, no include ::user/createWithArray/POST/http-response.adoc[] + + + +// file not found, no * wiremock data link :user/createWithArray/POST/POST.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::user/createWithArray/POST/implementation.adoc[] + + +endif::internal-generation[] + + +[.createUsersWithListInput] +==== createUsersWithListInput + +`POST /user/createWithList` + +Creates list of users with given input array + +===== Description + + + + +// markup not found, no include ::user/createWithList/POST/spec.adoc[] + + + +===== Parameters + + +===== Body Parameter + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | body | List of user object <> | X | | - -|=== - - - - -===== Return Type - - - -- - - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 0 -| successful operation -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::User/createUsersWithListInput/POST/http-request.adoc[] - -// markup not included, not found: include::User/createUsersWithListInput/POST/http-response.adoc[] - - - -[.deleteUser] -==== deleteUser - -`DELETE /user/{username}` - -Delete user - - -// markup not included, not found: include::User/deleteUser/operation-spec.adoc[] - - -===== Description - -This can only be done by the logged in user. - -===== Parameters - -====== Path Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - + +===== Return Type + + + +- + + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 0 +| successful operation +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::user/createWithList/POST/http-request.adoc[] + + +// markup not found, no include ::user/createWithList/POST/http-response.adoc[] + + + +// file not found, no * wiremock data link :user/createWithList/POST/POST.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::user/createWithList/POST/implementation.adoc[] + + +endif::internal-generation[] + + +[.deleteUser] +==== deleteUser + +`DELETE /user/{username}` + +Delete user + +===== Description + +This can only be done by the logged in user. + + +// markup not found, no include ::user/{username}/DELETE/spec.adoc[] + + + +===== Parameters + +====== Path Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | username | The name that needs to be deleted | X | null | - -|=== - - - - - -===== Return Type - - - -- - - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 400 -| Invalid username supplied -| <<>> - - -| 404 -| User not found -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::User/deleteUser/DELETE/http-request.adoc[] - -// markup not included, not found: include::User/deleteUser/DELETE/http-response.adoc[] - - - -[.getUserByName] -==== getUserByName - -`GET /user/{username}` - -Get user by user name - - -===== Parameters - -====== Path Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - + + + +===== Return Type + + + +- + + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 400 +| Invalid username supplied +| <<>> + + +| 404 +| User not found +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::user/{username}/DELETE/http-request.adoc[] + + +// markup not found, no include ::user/{username}/DELETE/http-response.adoc[] + + + +// file not found, no * wiremock data link :user/{username}/DELETE/DELETE.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::user/{username}/DELETE/implementation.adoc[] + + +endif::internal-generation[] + + +[.getUserByName] +==== getUserByName + +`GET /user/{username}` + +Get user by user name + +===== Description + + + + +// markup not found, no include ::user/{username}/GET/spec.adoc[] + + + +===== Parameters + +====== Path Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | username | The name that needs to be fetched. Use user1 for testing. | X | null | - -|=== - - - - - -===== Return Type - -<> - - -===== Content Type - -* application/xml -* application/json - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 200 -| successful operation -| <> - - -| 400 -| Invalid username supplied -| <<>> - - -| 404 -| User not found -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::User/getUserByName/GET/http-request.adoc[] - -// markup not included, not found: include::User/getUserByName/GET/http-response.adoc[] - - - -[.loginUser] -==== loginUser - -`GET /user/login` - -Logs user into the system - - -===== Parameters - - - - -====== Query Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - + + + +===== Return Type + +<> + + +===== Content Type + +* application/xml +* application/json + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| successful operation +| <> + + +| 400 +| Invalid username supplied +| <<>> + + +| 404 +| User not found +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::user/{username}/GET/http-request.adoc[] + + +// markup not found, no include ::user/{username}/GET/http-response.adoc[] + + + +// file not found, no * wiremock data link :user/{username}/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::user/{username}/GET/implementation.adoc[] + + +endif::internal-generation[] + + +[.loginUser] +==== loginUser + +`GET /user/login` + +Logs user into the system + +===== Description + + + + +// markup not found, no include ::user/login/GET/spec.adoc[] + + + +===== Parameters + + + + +====== Query Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | username | The user name for login | X | null | - | password | The password for login in clear text | X | null | - -|=== - - -===== Return Type - - -<> - - -===== Content Type - -* application/xml -* application/json - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 200 -| successful operation -| <> - - -| 400 -| Invalid username/password supplied -| <<>> - -|=== - -===== Samples - +|=== -// markup not included, not found: include::User/loginUser/GET/http-request.adoc[] - -// markup not included, not found: include::User/loginUser/GET/http-response.adoc[] - - - -[.logoutUser] -==== logoutUser - -`GET /user/logout` - -Logs out current logged in user session - - -===== Parameters - - - - - - -===== Return Type - - - -- - - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 0 -| successful operation -| <<>> - -|=== - -===== Samples - +===== Return Type -// markup not included, not found: include::User/logoutUser/GET/http-request.adoc[] - -// markup not included, not found: include::User/logoutUser/GET/http-response.adoc[] - - - -[.updateUser] -==== updateUser - -`PUT /user/{username}` - -Updated user - - +<> + + +===== Content Type + +* application/xml +* application/json + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| successful operation +| <> + + +| 400 +| Invalid username/password supplied +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::user/login/GET/http-request.adoc[] + + +// markup not found, no include ::user/login/GET/http-response.adoc[] + + + +// file not found, no * wiremock data link :user/login/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::user/login/GET/implementation.adoc[] + + +endif::internal-generation[] + + +[.logoutUser] +==== logoutUser + +`GET /user/logout` + +Logs out current logged in user session + +===== Description + + + + +// markup not found, no include ::user/logout/GET/spec.adoc[] + + + +===== Parameters + + + + + + +===== Return Type + + + +- + + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 0 +| successful operation +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::user/logout/GET/http-request.adoc[] + + +// markup not found, no include ::user/logout/GET/http-response.adoc[] + + + +// file not found, no * wiremock data link :user/logout/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::user/logout/GET/implementation.adoc[] + + +endif::internal-generation[] + + +[.updateUser] +==== updateUser + +`PUT /user/{username}` + +Updated user + +===== Description + +This can only be done by the logged in user. + + +// markup not found, no include ::user/{username}/PUT/spec.adoc[] + + + +===== Parameters + +====== Path Parameters + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern -// markup not included, not found: include::User/updateUser/operation-spec.adoc[] - - -===== Description - -This can only be done by the logged in user. - -===== Parameters - -====== Path Parameters - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - | username | name that need to be deleted | X | null | - -|=== - -===== Body Parameter - -[cols="2,3,1,1,1"] -|=== -|Name| Description| Required| Default| Pattern - +|=== + +===== Body Parameter + +[cols="2,3,1,1,1"] +|=== +|Name| Description| Required| Default| Pattern + | body | Updated user object <> | X | | - -|=== - - - - -===== Return Type - - - -- - - -===== Responses - -.http response codes -[cols="2,3,1"] -|=== -| Code | Message | Datatype - - -| 400 -| Invalid user supplied -| <<>> - - -| 404 -| User not found -| <<>> - -|=== - -===== Samples - +|=== + + + + +===== Return Type + + + +- + + +===== Responses + +.http response codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 400 +| Invalid user supplied +| <<>> + + +| 404 +| User not found +| <<>> + +|=== + +===== Samples + + +// markup not found, no include ::user/{username}/PUT/http-request.adoc[] + + +// markup not found, no include ::user/{username}/PUT/http-response.adoc[] + + + +// file not found, no * wiremock data link :user/{username}/PUT/PUT.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include ::user/{username}/PUT/implementation.adoc[] + + +endif::internal-generation[] + + +[#models] +== Models + + +[#ApiResponse] +==== _ApiResponse_ An uploaded response + +Describes the result of uploading an image resource + +[.fields-ApiResponse] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| code +| +| Integer +| +| int32 _ + +| type +| +| String +| +| _ + +| message +| +| String +| +| _ + +|=== + + +[#Category] +==== _Category_ Pet category + +A category for a pet + +[.fields-Category] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| id +| +| Long +| +| int64 _ + +| name +| +| String +| +| _ + +|=== + + +[#Order] +==== _Order_ Pet Order + +An order for a pets from the pet store + +[.fields-Order] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| id +| +| Long +| +| int64 _ + +| petId +| +| Long +| +| int64 _ + +| quantity +| +| Integer +| +| int32 _ + +| shipDate +| +| Date +| +| date-time _ + +| status +| +| String +| Order Status +| Enum: _ placed, approved, delivered, _ + +| complete +| +| Boolean +| +| _ + +|=== + + +[#Pet] +==== _Pet_ a Pet + +A pet for sale in the pet store + +[.fields-Pet] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| id +| +| Long +| +| int64 _ + +| category +| +| Category +| +| _ + +| name +| X +| String +| +| _ + +| photoUrls +| X +| List of <> +| +| _ + +| tags +| +| List of <> +| +| _ + +| status +| +| String +| pet status in the store +| Enum: _ available, pending, sold, _ + +|=== + + +[#Tag] +==== _Tag_ Pet Tag + +A tag for a pet + +[.fields-Tag] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| id +| +| Long +| +| int64 _ + +| name +| +| String +| +| _ + +|=== + + +[#User] +==== _User_ a User + +A User who is purchasing from the pet store + +[.fields-User] +[cols="2,1,2,4,1"] +|=== +| Field Name| Required| Type| Description| Format + +| id +| +| Long +| +| int64 _ + +| username +| +| String +| +| _ + +| firstName +| +| String +| +| _ + +| lastName +| +| String +| +| _ + +| email +| +| String +| +| _ + +| password +| +| String +| +| _ + +| phone +| +| String +| +| _ + +| userStatus +| +| Integer +| User Status +| int32 _ + +|=== -// markup not included, not found: include::User/updateUser/PUT/http-request.adoc[] - -// markup not included, not found: include::User/updateUser/PUT/http-response.adoc[] - - - -[#models] -== Models - - -[#ApiResponse] -==== _ApiResponse_ An uploaded response - -Describes the result of uploading an image resource - -[.fields-ApiResponse] -[cols="2,1,2,4,1"] -|=== -| Field Name| Required| Type| Description| Format - -| code -| -| Integer -| -| int32 _ - -| type -| -| String -| -| _ - -| message -| -| String -| -| _ - -|=== - - -[#Category] -==== _Category_ Pet category - -A category for a pet - -[.fields-Category] -[cols="2,1,2,4,1"] -|=== -| Field Name| Required| Type| Description| Format - -| id -| -| Long -| -| int64 _ - -| name -| -| String -| -| _ - -|=== - - -[#Order] -==== _Order_ Pet Order - -An order for a pets from the pet store - -[.fields-Order] -[cols="2,1,2,4,1"] -|=== -| Field Name| Required| Type| Description| Format - -| id -| -| Long -| -| int64 _ - -| petId -| -| Long -| -| int64 _ - -| quantity -| -| Integer -| -| int32 _ - -| shipDate -| -| Date -| -| date-time _ - -| status -| -| String -| Order Status -| Enum: _ placed, approved, delivered, _ - -| complete -| -| Boolean -| -| _ - -|=== - - -[#Pet] -==== _Pet_ a Pet - -A pet for sale in the pet store - -[.fields-Pet] -[cols="2,1,2,4,1"] -|=== -| Field Name| Required| Type| Description| Format - -| id -| -| Long -| -| int64 _ - -| category -| -| Category -| -| _ - -| name -| X -| String -| -| _ - -| photoUrls -| X -| List of <> -| -| _ - -| tags -| -| List of <> -| -| _ - -| status -| -| String -| pet status in the store -| Enum: _ available, pending, sold, _ - -|=== - - -[#Tag] -==== _Tag_ Pet Tag - -A tag for a pet - -[.fields-Tag] -[cols="2,1,2,4,1"] -|=== -| Field Name| Required| Type| Description| Format - -| id -| -| Long -| -| int64 _ - -| name -| -| String -| -| _ - -|=== - - -[#User] -==== _User_ a User - -A User who is purchasing from the pet store - -[.fields-User] -[cols="2,1,2,4,1"] -|=== -| Field Name| Required| Type| Description| Format - -| id -| -| Long -| -| int64 _ - -| username -| -| String -| -| _ - -| firstName -| -| String -| -| _ - -| lastName -| -| String -| -| _ - -| email -| -| String -| -| _ - -| password -| -| String -| -| _ - -| phone -| -| String -| -| _ - -| userStatus -| -| Integer -| User Status -| int32 _ - -|=== - -