Skip to content

[html2] Added method summary under the method name heading for HTML2 #4014

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 5 commits into from
Oct 17, 2016
Merged

[html2] Added method summary under the method name heading for HTML2 #4014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6789708
added method summary under the method name
MartinTeeVarga Oct 17, 2016
94ccee8
added batch file for html2 generation on windows
MartinTeeVarga Oct 17, 2016
c71933a
regenerated html2 example
MartinTeeVarga Oct 17, 2016
18d4646
changed the html2 windows batch to use yaml instead of json and regen…
MartinTeeVarga Oct 17, 2016
bae3038
fixed encoding issues
MartinTeeVarga Oct 17, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions bin/windows/html2-petstore.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
set executable=.\modules\swagger-codegen-cli\target\swagger-codegen-cli.jar

If Not Exist %executable% (
mvn clean package
)

REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -DloggerPath=conf/log4j.properties
set ags=generate -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -l html2 -o samples\html2

java %JAVA_OPTS% -jar %executable% %ags%
1 change: 1 addition & 0 deletions modules/swagger-codegen/src/main/resources/htmlDocs2/index.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ function loadGoogleFontCss() {
<article id="api-{{baseName}}-{{nickname}}-0" data-group="User" data-name="{{nickname}}" data-version="0">
<div class="pull-left">
<h1>{{nickname}}</h1>
<p>{{summary}}</p>
</div>
<div class="pull-right">

Expand Down
22 changes: 21 additions & 1 deletion samples/html2/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -997,6 +997,7 @@ <h1>Pet</h1>
<article id="api-Pet-addPet-0" data-group="User" data-name="addPet" data-version="0">
<div class="pull-left">
<h1>addPet</h1>
<p>Add a new pet to the store</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -1393,6 +1394,7 @@ <h3> Status: 405 - Invalid input </h3>
<article id="api-Pet-deletePet-0" data-group="User" data-name="deletePet" data-version="0">
<div class="pull-left">
<h1>deletePet</h1>
<p>Deletes a pet</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -1828,6 +1830,7 @@ <h3> Status: 400 - Invalid pet value </h3>
<article id="api-Pet-findPetsByStatus-0" data-group="User" data-name="findPetsByStatus" data-version="0">
<div class="pull-left">
<h1>findPetsByStatus</h1>
<p>Finds Pets by status</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -2307,6 +2310,7 @@ <h3> Status: 400 - Invalid status value </h3>
<article id="api-Pet-findPetsByTags-0" data-group="User" data-name="findPetsByTags" data-version="0">
<div class="pull-left">
<h1>findPetsByTags</h1>
<p>Finds Pets by tags</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -2784,6 +2788,7 @@ <h3> Status: 400 - Invalid tag value </h3>
<article id="api-Pet-getPetById-0" data-group="User" data-name="getPetById" data-version="0">
<div class="pull-left">
<h1>getPetById</h1>
<p>Find pet by ID</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -3341,6 +3346,7 @@ <h3> Status: 404 - Pet not found </h3>
<article id="api-Pet-updatePet-0" data-group="User" data-name="updatePet" data-version="0">
<div class="pull-left">
<h1>updatePet</h1>
<p>Update an existing pet</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -3889,6 +3895,7 @@ <h3> Status: 405 - Validation exception </h3>
<article id="api-Pet-updatePetWithForm-0" data-group="User" data-name="updatePetWithForm" data-version="0">
<div class="pull-left">
<h1>updatePetWithForm</h1>
<p>Updates a pet in the store with form data</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -4290,6 +4297,7 @@ <h3> Status: 405 - Invalid input </h3>
<article id="api-Pet-uploadFile-0" data-group="User" data-name="uploadFile" data-version="0">
<div class="pull-left">
<h1>uploadFile</h1>
<p>uploads an image</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -4705,6 +4713,7 @@ <h1>Store</h1>
<article id="api-Store-deleteOrder-0" data-group="User" data-name="deleteOrder" data-version="0">
<div class="pull-left">
<h1>deleteOrder</h1>
<p>Delete purchase order by ID</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -5145,6 +5154,7 @@ <h3> Status: 404 - Order not found </h3>
<article id="api-Store-getInventory-0" data-group="User" data-name="getInventory" data-version="0">
<div class="pull-left">
<h1>getInventory</h1>
<p>Returns pet inventories by status</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -5504,6 +5514,7 @@ <h3> Status: 200 - successful operation </h3>
<article id="api-Store-getOrderById-0" data-group="User" data-name="getOrderById" data-version="0">
<div class="pull-left">
<h1>getOrderById</h1>
<p>Find purchase order by ID</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -6032,6 +6043,7 @@ <h3> Status: 404 - Order not found </h3>
<article id="api-Store-placeOrder-0" data-group="User" data-name="placeOrder" data-version="0">
<div class="pull-left">
<h1>placeOrder</h1>
<p>Place an order for a pet</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -6497,6 +6509,7 @@ <h1>User</h1>
<article id="api-User-createUser-0" data-group="User" data-name="createUser" data-version="0">
<div class="pull-left">
<h1>createUser</h1>
<p>Create user</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -6872,6 +6885,7 @@ <h3> Status: 0 - successful operation </h3>
<article id="api-User-createUsersWithArrayInput-0" data-group="User" data-name="createUsersWithArrayInput" data-version="0">
<div class="pull-left">
<h1>createUsersWithArrayInput</h1>
<p>Creates list of users with given input array</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -7250,6 +7264,7 @@ <h3> Status: 0 - successful operation </h3>
<article id="api-User-createUsersWithListInput-0" data-group="User" data-name="createUsersWithListInput" data-version="0">
<div class="pull-left">
<h1>createUsersWithListInput</h1>
<p>Creates list of users with given input array</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -7628,6 +7643,7 @@ <h3> Status: 0 - successful operation </h3>
<article id="api-User-deleteUser-0" data-group="User" data-name="deleteUser" data-version="0">
<div class="pull-left">
<h1>deleteUser</h1>
<p>Delete user</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -8067,6 +8083,7 @@ <h3> Status: 404 - User not found </h3>
<article id="api-User-getUserByName-0" data-group="User" data-name="getUserByName" data-version="0">
<div class="pull-left">
<h1>getUserByName</h1>
<p>Get user by user name</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -8592,6 +8609,7 @@ <h3> Status: 404 - User not found </h3>
<article id="api-User-loginUser-0" data-group="User" data-name="loginUser" data-version="0">
<div class="pull-left">
<h1>loginUser</h1>
<p>Logs user into the system</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -9094,6 +9112,7 @@ <h3> Status: 400 - Invalid username/password supplied </h3>
<article id="api-User-logoutUser-0" data-group="User" data-name="logoutUser" data-version="0">
<div class="pull-left">
<h1>logoutUser</h1>
<p>Logs out current logged in user session</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -9408,6 +9427,7 @@ <h3> Status: 0 - successful operation </h3>
<article id="api-User-updateUser-0" data-group="User" data-name="updateUser" data-version="0">
<div class="pull-left">
<h1>updateUser</h1>
<p>Updated user</p>
</div>
<div class="pull-right">

Expand Down Expand Up @@ -9921,7 +9941,7 @@ <h3> Status: 404 - User not found </h3>
</div>
<div id="generator">
<div class="content">
Generated 2016-10-13T09:03:51.792-07:00
Generated 2016-10-17T21:36:47.443+11:00
</div>
</div>
</div>
Expand Down