Created
August 13, 2015 17:52
-
-
Save DavidBiesack/a9048b151cd7935c8d76 to your computer and use it in GitHub Desktop.
swagger-codegen static html output (DavidBiesack/swagger-codegen branch static-html)
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?xml version="1.0"?> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| <html xmlns="http://www.w3.org/1999/xhtml"> | |
| <head> | |
| <title>Uber API</title> | |
| <link rel="stylesheet" type="text/css" href="site.css" media="screen" /> | |
| <style type="text/css"> | |
| body { | |
| font-family: Trebuchet MS, sans-serif; | |
| font-size: 15px; | |
| color: #444; | |
| margin-right: 24px; | |
| } | |
| h1 { | |
| font-size: 25px; | |
| } | |
| h2 { | |
| font-size: 20px; | |
| } | |
| h3 { | |
| font-size: 16px; | |
| font-weight: bold; | |
| } | |
| hr { | |
| height: 1px; | |
| border: 0; | |
| color: #ddd; | |
| background-color: #ddd; | |
| display: none; | |
| } | |
| .app-desc { | |
| clear: both; | |
| margin-left: 20px; | |
| } | |
| .param-name { | |
| width: 100%; | |
| } | |
| .license-info { | |
| margin-left: 20px; | |
| } | |
| .license-url { | |
| margin-left: 20px; | |
| } | |
| .model { | |
| margin: 0 0 0px 20px; | |
| } | |
| .method { | |
| margin-left: 20px; | |
| } | |
| .method-notes { | |
| margin: 10px 0 20px 0; | |
| font-size: 90%; | |
| color: #555; | |
| } | |
| pre { | |
| padding: 10px; | |
| margin-bottom: 2px; | |
| } | |
| .http-method { | |
| text-transform: uppercase; | |
| } | |
| pre.get { | |
| background-color: #0f6ab4; | |
| } | |
| pre.post { | |
| background-color: #10a54a; | |
| } | |
| pre.put { | |
| background-color: #c5862b; | |
| } | |
| pre.delete { | |
| background-color: #a41e22; | |
| } | |
| .huge { | |
| color: #fff; | |
| } | |
| pre.example { | |
| background-color: #f3f3f3; | |
| padding: 10px; | |
| border: 1px solid #ddd; | |
| } | |
| code { | |
| white-space: pre; | |
| } | |
| .nickname { | |
| font-weight: bold; | |
| } | |
| .method-path { | |
| font-size: 1.5em; | |
| background-color: #0f6ab4; | |
| } | |
| .up { | |
| float:right; | |
| } | |
| .parameter { | |
| width: 500px; | |
| } | |
| .param { | |
| width: 500px; | |
| padding: 10px 0 0 20px; | |
| font-weight: bold; | |
| } | |
| .param-desc { | |
| width: 700px; | |
| padding: 0 0 0 20px; | |
| color: #777; | |
| } | |
| .param-type { | |
| font-style: italic; | |
| } | |
| .field-label { | |
| padding: 0; | |
| margin: 0; | |
| clear: both; | |
| } | |
| .field-items { | |
| padding: 0 0 15px 0; | |
| margin-bottom: 15px; | |
| } | |
| .return-type { | |
| clear: both; | |
| padding-bottom: 10px; | |
| } | |
| .param-header { | |
| font-weight: bold; | |
| } | |
| .method-tags { | |
| text-align: right; | |
| } | |
| .method-tag { | |
| background: none repeat scroll 0% 0% #24A600; | |
| border-radius: 3px; | |
| padding: 2px 10px; | |
| margin: 2px; | |
| color: #FFF; | |
| display: inline-block; | |
| text-decoration: none; | |
| } | |
| </style> | |
| </head> | |
| <body> | |
| <h1>Uber API</h1> | |
| <div class="app-desc">Move your app forward with the Uber API</div> | |
| <div class="app-desc">More information: <a href="https://helloreverb.com">https://helloreverb.com</a></div> | |
| <div class="app-desc">Contact Info: <a href="hello@helloreverb.com">hello@helloreverb.com</a></div> | |
| <div class="app-desc">Version: 1.0.0</div> | |
| <div class="license-info">All rights reserved</div> | |
| <div class="license-url">http://apache.org/licenses/LICENSE-2.0.html</div> | |
| <h2>Access</h2> | |
| <h2><a name="__Methods">Methods</a></h2> | |
| [ Jump to <a href="#__Models">Models</a> ] | |
| <h2>Table of Contents </h2> | |
| <div class="method-summary"></div> | |
| <ol> | |
| <li><a href="#estimatesPriceGet"><code><span class="http-method">get</span> /estimates/price</code></a></li> | |
| <li><a href="#estimatesTimeGet"><code><span class="http-method">get</span> /estimates/time</code></a></li> | |
| <li><a href="#historyGet"><code><span class="http-method">get</span> /history</code></a></li> | |
| <li><a href="#meGet"><code><span class="http-method">get</span> /me</code></a></li> | |
| <li><a href="#productsGet"><code><span class="http-method">get</span> /products</code></a></li> | |
| </ol> | |
| <div class="method"><a name="estimatesPriceGet"/> | |
| <div class="method-path"> | |
| <a class="up" href="#__Methods">Up</a> | |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /estimates/price</code></pre></div> | |
| <div class="method-summary">Price Estimates (<span class="nickname">estimatesPriceGet</span>)</div> | |
| <div class="method-notes">The Price Estimates endpoint returns an estimated price range\nfor each product offered at a given location. The price estimate is\nprovided as a formatted string with the full price range and the localized\ncurrency symbol.<br><br>The response also includes low and high estimates,\nand the [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for\nsituations requiring currency conversion. When surge is active for a particular\nproduct, its surge_multiplier will be greater than 1, but the price estimate\nalready factors in this multiplier.\n</div> | |
| <!-- Remove Return type... unclear where this comes from; | |
| for our swagger.json files, it is always empty and there is no boolean guard or hasReturnType | |
| do we end up with a heading but not content | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#array">array[PriceEstimate]</a></div> | |
| Todo: process Response Object and its headers, schema, examples | |
| --> | |
| <h3 class="field-label">Responses</h3> | |
| <h4 class="field-label">200</h4> | |
| An array of price estimates by product | |
| <h4 class="field-label">0</h4> | |
| Unexpected error | |
| </div> <!-- method --> | |
| <hr/> | |
| <div class="method"><a name="estimatesTimeGet"/> | |
| <div class="method-path"> | |
| <a class="up" href="#__Methods">Up</a> | |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /estimates/time</code></pre></div> | |
| <div class="method-summary">Time Estimates (<span class="nickname">estimatesTimeGet</span>)</div> | |
| <div class="method-notes">The Time Estimates endpoint returns ETAs for all products offered at a given location, with the responses expressed as integers in seconds. We recommend that this endpoint be called every minute to provide the most accurate, up-to-date ETAs.</div> | |
| <!-- Remove Return type... unclear where this comes from; | |
| for our swagger.json files, it is always empty and there is no boolean guard or hasReturnType | |
| do we end up with a heading but not content | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#array">array[Product]</a></div> | |
| Todo: process Response Object and its headers, schema, examples | |
| --> | |
| <h3 class="field-label">Responses</h3> | |
| <h4 class="field-label">200</h4> | |
| An array of products | |
| <h4 class="field-label">0</h4> | |
| Unexpected error | |
| </div> <!-- method --> | |
| <hr/> | |
| <div class="method"><a name="historyGet"/> | |
| <div class="method-path"> | |
| <a class="up" href="#__Methods">Up</a> | |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /history</code></pre></div> | |
| <div class="method-summary">User Activity (<span class="nickname">historyGet</span>)</div> | |
| <div class="method-notes">The User Activity endpoint returns data about a user's lifetime activity with Uber. The response will include pickup locations and times, dropoff locations and times, the distance of past requests, and information about which products were requested.<br><br>The history array in the response will have a maximum length based on the limit parameter. The response value count may exceed limit, therefore subsequent API requests may be necessary.</div> | |
| <!-- Remove Return type... unclear where this comes from; | |
| for our swagger.json files, it is always empty and there is no boolean guard or hasReturnType | |
| do we end up with a heading but not content | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#">Activities</a></div> | |
| Todo: process Response Object and its headers, schema, examples | |
| --> | |
| <h3 class="field-label">Responses</h3> | |
| <h4 class="field-label">200</h4> | |
| History information for the given user | |
| <h4 class="field-label">0</h4> | |
| Unexpected error | |
| </div> <!-- method --> | |
| <hr/> | |
| <div class="method"><a name="meGet"/> | |
| <div class="method-path"> | |
| <a class="up" href="#__Methods">Up</a> | |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /me</code></pre></div> | |
| <div class="method-summary">User Profile (<span class="nickname">meGet</span>)</div> | |
| <div class="method-notes">The User Profile endpoint returns information about the Uber user that has authorized with the application.</div> | |
| <!-- Remove Return type... unclear where this comes from; | |
| for our swagger.json files, it is always empty and there is no boolean guard or hasReturnType | |
| do we end up with a heading but not content | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#">Profile</a></div> | |
| Todo: process Response Object and its headers, schema, examples | |
| --> | |
| <h3 class="field-label">Responses</h3> | |
| <h4 class="field-label">200</h4> | |
| Profile information for a user | |
| <h4 class="field-label">0</h4> | |
| Unexpected error | |
| </div> <!-- method --> | |
| <hr/> | |
| <div class="method"><a name="productsGet"/> | |
| <div class="method-path"> | |
| <a class="up" href="#__Methods">Up</a> | |
| <pre class="get"><code class="huge"><span class="http-method">get</span> /products</code></pre></div> | |
| <div class="method-summary">Product Types (<span class="nickname">productsGet</span>)</div> | |
| <div class="method-notes">The Products endpoint returns information about the *Uber* products\noffered at a given location. The response includes the display name\nand other details about each product, and lists the products in the\nproper display order.\n</div> | |
| <!-- Remove Return type... unclear where this comes from; | |
| for our swagger.json files, it is always empty and there is no boolean guard or hasReturnType | |
| do we end up with a heading but not content | |
| <h3 class="field-label">Return type</h3> | |
| <div class="return-type"><a href="#array">array[Product]</a></div> | |
| Todo: process Response Object and its headers, schema, examples | |
| --> | |
| <h3 class="field-label">Responses</h3> | |
| <h4 class="field-label">200</h4> | |
| An array of products | |
| <h4 class="field-label">0</h4> | |
| Unexpected error | |
| </div> <!-- method --> | |
| <hr/> | |
| <div class="up"><a href="#__Models">Up</a></div> | |
| <h2><a name="__Models">Models</a></h2> | |
| [ Jump to <a href="#__Methods">Methods</a> ] | |
| <h2>Table of Contents</h2> | |
| <ol> | |
| <li><a href="#Product"><code>Product</code></a></li> | |
| <li><a href="#PriceEstimate"><code>PriceEstimate</code></a></li> | |
| <li><a href="#Profile"><code>Profile</code></a></li> | |
| <li><a href="#Activity"><code>Activity</code></a></li> | |
| <li><a href="#Activities"><code>Activities</code></a></li> | |
| <li><a href="#Error"><code>Error</code></a></li> | |
| </ol> | |
| <div class="model"> | |
| <h3 class="field-label"><a name="Product">Product</a> <a class="up" href="#__Models">Up</a></h3> | |
| <div class="field-items"> | |
| <div class="param">product_id </div><div class="param-desc"><span class="param-type">String</span> Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles.</div> | |
| <div class="param">description </div><div class="param-desc"><span class="param-type">String</span> Description of product.</div> | |
| <div class="param">display_name </div><div class="param-desc"><span class="param-type">String</span> Display name of product.</div> | |
| <div class="param">capacity </div><div class="param-desc"><span class="param-type">String</span> Capacity of product. For example, 4 people.</div> | |
| <div class="param">image </div><div class="param-desc"><span class="param-type">String</span> Image URL representing the product.</div> | |
| </div> <!-- field-items --> | |
| </div> | |
| <div class="model"> | |
| <h3 class="field-label"><a name="PriceEstimate">PriceEstimate</a> <a class="up" href="#__Models">Up</a></h3> | |
| <div class="field-items"> | |
| <div class="param">product_id </div><div class="param-desc"><span class="param-type">String</span> Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles</div> | |
| <div class="param">currency_code </div><div class="param-desc"><span class="param-type">String</span> [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code.</div> | |
| <div class="param">display_name </div><div class="param-desc"><span class="param-type">String</span> Display name of product.</div> | |
| <div class="param">estimate </div><div class="param-desc"><span class="param-type">String</span> Formatted string of estimate in local currency of the start location. Estimate could be a range, a single number (flat rate) or \"Metered\" for TAXI.</div> | |
| <div class="param">low_estimate </div><div class="param-desc"><span class="param-type">BigDecimal</span> Lower bound of the estimated price.</div> | |
| <div class="param">high_estimate </div><div class="param-desc"><span class="param-type">BigDecimal</span> Upper bound of the estimated price.</div> | |
| <div class="param">surge_multiplier </div><div class="param-desc"><span class="param-type">BigDecimal</span> Expected surge multiplier. Surge is active if surge_multiplier is greater than 1. Price estimate already factors in the surge multiplier.</div> | |
| </div> <!-- field-items --> | |
| </div> | |
| <div class="model"> | |
| <h3 class="field-label"><a name="Profile">Profile</a> <a class="up" href="#__Models">Up</a></h3> | |
| <div class="field-items"> | |
| <div class="param">first_name </div><div class="param-desc"><span class="param-type">String</span> First name of the Uber user.</div> | |
| <div class="param">last_name </div><div class="param-desc"><span class="param-type">String</span> Last name of the Uber user.</div> | |
| <div class="param">email </div><div class="param-desc"><span class="param-type">String</span> Email address of the Uber user</div> | |
| <div class="param">picture </div><div class="param-desc"><span class="param-type">String</span> Image URL of the Uber user.</div> | |
| <div class="param">promo_code </div><div class="param-desc"><span class="param-type">String</span> Promo code of the Uber user.</div> | |
| </div> <!-- field-items --> | |
| </div> | |
| <div class="model"> | |
| <h3 class="field-label"><a name="Activity">Activity</a> <a class="up" href="#__Models">Up</a></h3> | |
| <div class="field-items"> | |
| <div class="param">uuid </div><div class="param-desc"><span class="param-type">String</span> Unique identifier for the activity</div> | |
| </div> <!-- field-items --> | |
| </div> | |
| <div class="model"> | |
| <h3 class="field-label"><a name="Activities">Activities</a> <a class="up" href="#__Models">Up</a></h3> | |
| <div class="field-items"> | |
| <div class="param">offset </div><div class="param-desc"><span class="param-type">Integer</span> Position in pagination.</div> | |
| <div class="param">limit </div><div class="param-desc"><span class="param-type">Integer</span> Number of items to retrieve (100 max).</div> | |
| <div class="param">count </div><div class="param-desc"><span class="param-type">Integer</span> Total number of items available.</div> | |
| <div class="param">history </div><div class="param-desc"><span class="param-type">array[Activity]</span> </div> | |
| </div> <!-- field-items --> | |
| </div> | |
| <div class="model"> | |
| <h3 class="field-label"><a name="Error">Error</a> <a class="up" href="#__Models">Up</a></h3> | |
| <div class="field-items"> | |
| <div class="param">code </div><div class="param-desc"><span class="param-type">Integer</span> </div> | |
| <div class="param">message </div><div class="param-desc"><span class="param-type">String</span> </div> | |
| <div class="param">fields </div><div class="param-desc"><span class="param-type">String</span> </div> | |
| </div> <!-- field-items --> | |
| </div> | |
| </body> | |
| </html> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment