forked from loafle/openapi-generator-original
added files
This commit is contained in:
Tony Tam
parent
fede9e97e4
commit
cb1c36721c
119
samples/docs/swagger-static-docs/pom.xml
Normal file
119
samples/docs/swagger-static-docs/pom.xml
Normal file
@ -0,0 +1,119 @@
|
|||||||
|
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
|
||||||
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
<groupId>com.wordnik</groupId>
|
||||||
|
<artifactId>wordnik-swagger-demo</artifactId>
|
||||||
|
<packaging>jar</packaging>
|
||||||
|
<name>wordnik-swagger-demo</name>
|
||||||
|
<version>1.0.0-SNAPSHOT</version>
|
||||||
|
<prerequisites>
|
||||||
|
<maven>2.2.0</maven>
|
||||||
|
</prerequisites>
|
||||||
|
|
||||||
|
<build>
|
||||||
|
<sourceDirectory>src/main/scala</sourceDirectory>
|
||||||
|
<testSourceDirectory>src/test/scala</testSourceDirectory>
|
||||||
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
<groupId>net.alchim31.maven</groupId>
|
||||||
|
<artifactId>scala-maven-plugin</artifactId>
|
||||||
|
<version>${maven-plugin.version}</version>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<goals>
|
||||||
|
<goal>compile</goal>
|
||||||
|
<goal>testCompile</goal>
|
||||||
|
</goals>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
<configuration>
|
||||||
|
<jvmArgs>
|
||||||
|
<jvmArg>-Xms64m</jvmArg>
|
||||||
|
<jvmArg>-Xmx1024m</jvmArg>
|
||||||
|
</jvmArgs>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
|
<plugin>
|
||||||
|
<artifactId>maven-surefire-plugin</artifactId>
|
||||||
|
<configuration>
|
||||||
|
<forkMode>once</forkMode>
|
||||||
|
<useFile>false</useFile>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
|
<plugin>
|
||||||
|
<artifactId>maven-dependency-plugin</artifactId>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<phase>package</phase>
|
||||||
|
<goals>
|
||||||
|
<goal>copy-dependencies</goal>
|
||||||
|
</goals>
|
||||||
|
<configuration>
|
||||||
|
<outputDirectory>${project.build.directory}/lib</outputDirectory>
|
||||||
|
</configuration>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.mortbay.jetty</groupId>
|
||||||
|
<artifactId>jetty-maven-plugin</artifactId>
|
||||||
|
<version>${jetty-version}</version>
|
||||||
|
<configuration>
|
||||||
|
<webAppConfig>
|
||||||
|
<contextPath>/</contextPath>
|
||||||
|
</webAppConfig>
|
||||||
|
<connectors>
|
||||||
|
<connector implementation="org.eclipse.jetty.server.nio.SelectChannelConnector">
|
||||||
|
<port>8000</port>
|
||||||
|
<maxIdleTime>60000</maxIdleTime>
|
||||||
|
<confidentialPort>8443</confidentialPort>
|
||||||
|
</connector>
|
||||||
|
</connectors>
|
||||||
|
</configuration>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>start-jetty</id>
|
||||||
|
<phase>pre-integration-test</phase>
|
||||||
|
<goals>
|
||||||
|
<goal>run</goal>
|
||||||
|
</goals>
|
||||||
|
<configuration>
|
||||||
|
<scanIntervalSeconds>0</scanIntervalSeconds>
|
||||||
|
<daemon>true</daemon>
|
||||||
|
</configuration>
|
||||||
|
</execution>
|
||||||
|
<execution>
|
||||||
|
<id>stop-jetty</id>
|
||||||
|
<phase>post-integration-test</phase>
|
||||||
|
<goals>
|
||||||
|
<goal>stop</goal>
|
||||||
|
</goals>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
|
</plugins>
|
||||||
|
</build>
|
||||||
|
<repositories>
|
||||||
|
<repository>
|
||||||
|
<id>sonatype-snapshots</id>
|
||||||
|
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
|
||||||
|
</repository>
|
||||||
|
<repository>
|
||||||
|
<id>sonatype-releases</id>
|
||||||
|
<url>https://oss.sonatype.org/content/repositories/releases</url>
|
||||||
|
</repository>
|
||||||
|
</repositories>
|
||||||
|
<dependencies>
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.wordnik</groupId>
|
||||||
|
<artifactId>swagger-codegen_2.9.1</artifactId>
|
||||||
|
<version>${swagger-codegen-version}</version>
|
||||||
|
<scope>compile</scope>
|
||||||
|
</dependency>
|
||||||
|
</dependencies>
|
||||||
|
<properties>
|
||||||
|
<swagger-codegen-version>2.0.2-SNAPSHOT</swagger-codegen-version>
|
||||||
|
<maven-plugin.version>3.1.0</maven-plugin.version>
|
||||||
|
<jetty-version>7.6.0.v20120127</jetty-version>
|
||||||
|
</properties>
|
||||||
|
</project>
|
||||||
@ -1,135 +0,0 @@
|
|||||||
.line-numbers {
|
|
||||||
margin-right: 1.0em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.content {
|
|
||||||
padding-bottom: 100px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.column_header_name {
|
|
||||||
width: 150px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.column_header_path {
|
|
||||||
width: 350px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.column_header_name .column_header_param_type .column_header_data_type .column_header_return_type {
|
|
||||||
width: 200px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.expandable {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.main_content {
|
|
||||||
margin-top: 80px;
|
|
||||||
margin-left: 25px;
|
|
||||||
margin-right: 25px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.header {
|
|
||||||
position: fixed;
|
|
||||||
text-align: left;
|
|
||||||
background-color: black;
|
|
||||||
float: left;
|
|
||||||
top: 0;
|
|
||||||
width: 100%;
|
|
||||||
height: 70px auto;
|
|
||||||
padding-bottom: 20px;
|
|
||||||
box-shadow: rgba(0, 0, 0, 0.2) 0 2px 8px 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar h1 a {
|
|
||||||
width: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar h1#logo a {
|
|
||||||
width: auto;
|
|
||||||
display: block;
|
|
||||||
clear: none;
|
|
||||||
float: left;
|
|
||||||
background-position: left;;
|
|
||||||
color: white;
|
|
||||||
text-decoration: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar ul li {
|
|
||||||
list-style: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar h1#logo span {
|
|
||||||
display: block;
|
|
||||||
clear: none;
|
|
||||||
float: left;
|
|
||||||
padding-top: 10px;
|
|
||||||
padding-left: 10px;
|
|
||||||
margin: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar h1#logo a span.light {
|
|
||||||
color: #ffc97a;
|
|
||||||
color: #666666;
|
|
||||||
padding-left: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar ul#nav {
|
|
||||||
float: none;
|
|
||||||
clear: both;
|
|
||||||
overflow: hidden;
|
|
||||||
margin: 0;
|
|
||||||
padding: 0;
|
|
||||||
display: block;
|
|
||||||
float: right;
|
|
||||||
clear: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar ul#nav li {
|
|
||||||
float: left;
|
|
||||||
clear: none;
|
|
||||||
margin: 0;
|
|
||||||
padding: 2px 10px;
|
|
||||||
border-right: 1px solid #dddddd;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar ul#nav li:first-child, .top-bar ul#nav li.first {
|
|
||||||
padding-left: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar ul#nav li:last-child, .top-bar ul#nav li.last {
|
|
||||||
padding-right: 0;
|
|
||||||
border-right: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar ul#nav li {
|
|
||||||
border: none;
|
|
||||||
padding: 0 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar ul#nav li a {
|
|
||||||
display: block;
|
|
||||||
padding: 8px 10px 8px 10px;
|
|
||||||
color: #999999;
|
|
||||||
text-decoration: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar ul#nav li a.strong {
|
|
||||||
color: white;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar ul#nav li a:active, .top-bar ul#nav li a.active, .top-bar ul#nav li a:hover {
|
|
||||||
-moz-border-radius: 4px;
|
|
||||||
-webkit-border-radius: 4px;
|
|
||||||
-o-border-radius: 4px;
|
|
||||||
-ms-border-radius: 4px;
|
|
||||||
-khtml-border-radius: 4px;
|
|
||||||
border-radius: 4px;
|
|
||||||
background-image: -webkit-gradient(linear, 0% 100%, 0% 0%, color-stop(0%, #ff5401), color-stop(100%, #ffa014));
|
|
||||||
background-image: -moz-linear-gradient(bottom, #ff5401 0%, #ffa014 100%);
|
|
||||||
background-image: linear-gradient(bottom, #ff5401 0%, #ffa014 100%);
|
|
||||||
color: white;
|
|
||||||
}
|
|
||||||
|
|
||||||
.top-bar ul#nav:hover li {
|
|
||||||
border-color: #222222;
|
|
||||||
}
|
|
||||||
@ -1,126 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
||||||
|
|
||||||
<link rel="stylesheet" type="text/css" href="assets/css/bootstrap.css" media="screen">
|
|
||||||
<link rel="stylesheet" type="text/css" href="assets/css/bootstrap-responsive.css" media="screen">
|
|
||||||
<link rel="stylesheet" type="text/css" href="assets/css/style.css">
|
|
||||||
|
|
||||||
<title>REST API v1.1 Resources | Twitter Developers</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="header">
|
|
||||||
<div class="top-bar">
|
|
||||||
<h1 id="logo"><a class="logo" href="/"><span>Swagger</span><span class="light">API Docs</span></a></h1>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="main_content">
|
|
||||||
<h1>API Documentation</h1>
|
|
||||||
<h2>UserApi</h2>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">Name</th>
|
|
||||||
<th class="column_header_path">Resource</th>
|
|
||||||
<th class="column_header_notes">Notes</th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/UserApi.html#createUsersWithArrayInput">createUsersWithArrayInput</a></td>
|
|
||||||
<td>/user.{format}/createWithArray</td>
|
|
||||||
<td>Creates list of users with given input array<div id="UserApi_createUsersWithArrayInput" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/UserApi.html#createUser">createUser</a></td>
|
|
||||||
<td>/user.{format}</td>
|
|
||||||
<td>Create user<div id="UserApi_createUser" class="operation expandable">This can only be done by the logged in user.</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/UserApi.html#createUsersWithListInput">createUsersWithListInput</a></td>
|
|
||||||
<td>/user.{format}/createWithList</td>
|
|
||||||
<td>Creates list of users with given list input<div id="UserApi_createUsersWithListInput" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/UserApi.html#updateUser">updateUser</a></td>
|
|
||||||
<td>/user.{format}/{username}</td>
|
|
||||||
<td>Updated user<div id="UserApi_updateUser" class="operation expandable">This can only be done by the logged in user.</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/UserApi.html#deleteUser">deleteUser</a></td>
|
|
||||||
<td>/user.{format}/{username}</td>
|
|
||||||
<td>Delete user<div id="UserApi_deleteUser" class="operation expandable">This can only be done by the logged in user.</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/UserApi.html#getUserByName">getUserByName</a></td>
|
|
||||||
<td>/user.{format}/{username}</td>
|
|
||||||
<td>Get user by user name<div id="UserApi_getUserByName" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/UserApi.html#loginUser">loginUser</a></td>
|
|
||||||
<td>/user.{format}/login</td>
|
|
||||||
<td>Logs user into the system<div id="UserApi_loginUser" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/UserApi.html#logoutUser">logoutUser</a></td>
|
|
||||||
<td>/user.{format}/logout</td>
|
|
||||||
<td>Logs out current logged in user session<div id="UserApi_logoutUser" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<h2>PetApi</h2>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">Name</th>
|
|
||||||
<th class="column_header_path">Resource</th>
|
|
||||||
<th class="column_header_notes">Notes</th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/PetApi.html#getPetById">getPetById</a></td>
|
|
||||||
<td>/pet.{format}/{petId}</td>
|
|
||||||
<td>Find pet by ID<div id="PetApi_getPetById" class="operation expandable">Returns a pet based on ID</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/PetApi.html#addPet">addPet</a></td>
|
|
||||||
<td>/pet.{format}</td>
|
|
||||||
<td>Add a new pet to the store<div id="PetApi_addPet" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/PetApi.html#updatePet">updatePet</a></td>
|
|
||||||
<td>/pet.{format}</td>
|
|
||||||
<td>Update an existing pet<div id="PetApi_updatePet" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/PetApi.html#findPetsByStatus">findPetsByStatus</a></td>
|
|
||||||
<td>/pet.{format}/findByStatus</td>
|
|
||||||
<td>Finds Pets by status<div id="PetApi_findPetsByStatus" class="operation expandable">Multiple status values can be provided with comma seperated strings</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/PetApi.html#findPetsByTags">findPetsByTags</a></td>
|
|
||||||
<td>/pet.{format}/findByTags</td>
|
|
||||||
<td>Finds Pets by tags<div id="PetApi_findPetsByTags" class="operation expandable">Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.</div></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<h2>StoreApi</h2>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">Name</th>
|
|
||||||
<th class="column_header_path">Resource</th>
|
|
||||||
<th class="column_header_notes">Notes</th>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/StoreApi.html#getOrderById">getOrderById</a></td>
|
|
||||||
<td>/store.{format}/order/{orderId}</td>
|
|
||||||
<td>Find purchase order by ID<div id="StoreApi_getOrderById" class="operation expandable">For valid response try integer IDs with value <= 5. Anything above 5 or nonintegers will generate API errors</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/StoreApi.html#deleteOrder">deleteOrder</a></td>
|
|
||||||
<td>/store.{format}/order/{orderId}</td>
|
|
||||||
<td>Delete purchase order by ID<div id="StoreApi_deleteOrder" class="operation expandable">For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors</div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="operations/StoreApi.html#placeOrder">placeOrder</a></td>
|
|
||||||
<td>/store.{format}/order</td>
|
|
||||||
<td>Place an order for a pet<div id="StoreApi_placeOrder" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,139 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
||||||
|
|
||||||
<link rel="stylesheet" type="text/css" href="../assets/css/bootstrap.css" media="screen">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../assets/css/bootstrap-responsive.css" media="screen">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../assets/css/style.css">
|
|
||||||
|
|
||||||
<title>REST API v1.1 Resources | Twitter Developers</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="header">
|
|
||||||
<div class="top-bar">
|
|
||||||
<h1 id="logo"><a class="logo" href="/"><span>Swagger</span><span class="light">API Docs</span></a></h1>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="main_content">
|
|
||||||
<h1>PetApi</h1>
|
|
||||||
<a name="getPetById"></a>
|
|
||||||
<h2>getPetById</h2>
|
|
||||||
<h3>GET: /pet.{format}/{petId}</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<!-- path params -->
|
|
||||||
<tr>
|
|
||||||
<td>petId<br/>required</td>
|
|
||||||
<td>path</td>
|
|
||||||
<td>string*</td>
|
|
||||||
<td>Pet</td>
|
|
||||||
<td>ID of pet that needs to be fetched<br/><div id="PetApi_getPetById" class="operation expandable">Returns a pet based on ID</div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="addPet"></a>
|
|
||||||
<h2>addPet</h2>
|
|
||||||
<h3>POST: /pet.{format}</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<tr>
|
|
||||||
<td>body<br/>required</td>
|
|
||||||
<td>body</td>
|
|
||||||
<td>Pet*</td>
|
|
||||||
<td>-</td>
|
|
||||||
<td>Pet object that needs to be added to the store<br/><div id="PetApi_addPet" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- path params -->
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="updatePet"></a>
|
|
||||||
<h2>updatePet</h2>
|
|
||||||
<h3>PUT: /pet.{format}</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<tr>
|
|
||||||
<td>body<br/>required</td>
|
|
||||||
<td>body</td>
|
|
||||||
<td>Pet*</td>
|
|
||||||
<td>-</td>
|
|
||||||
<td>Pet object that needs to be updated in the store<br/><div id="PetApi_updatePet" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- path params -->
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="findPetsByStatus"></a>
|
|
||||||
<h2>findPetsByStatus</h2>
|
|
||||||
<h3>GET: /pet.{format}/findByStatus</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<!-- path params -->
|
|
||||||
<!-- query params -->
|
|
||||||
<tr>
|
|
||||||
<td>status<br/>required</td>
|
|
||||||
<td>query</td>
|
|
||||||
<td>string*</td>
|
|
||||||
<td>List[Pet]</td>
|
|
||||||
<td>Status values that need to be considered for filter<br/><div id="PetApi_findPetsByStatus" class="operation expandable">Multiple status values can be provided with comma seperated strings</div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="findPetsByTags"></a>
|
|
||||||
<h2>findPetsByTags</h2>
|
|
||||||
<h3>GET: /pet.{format}/findByTags</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<!-- path params -->
|
|
||||||
<!-- query params -->
|
|
||||||
<tr>
|
|
||||||
<td>tags<br/>required</td>
|
|
||||||
<td>query</td>
|
|
||||||
<td>string*</td>
|
|
||||||
<td>List[Pet]</td>
|
|
||||||
<td>Tags to filter by<br/><div id="PetApi_findPetsByTags" class="operation expandable">Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.</div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
||||||
@ -1,93 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
||||||
|
|
||||||
<link rel="stylesheet" type="text/css" href="../assets/css/bootstrap.css" media="screen">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../assets/css/bootstrap-responsive.css" media="screen">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../assets/css/style.css">
|
|
||||||
|
|
||||||
<title>REST API v1.1 Resources | Twitter Developers</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="header">
|
|
||||||
<div class="top-bar">
|
|
||||||
<h1 id="logo"><a class="logo" href="/"><span>Swagger</span><span class="light">API Docs</span></a></h1>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="main_content">
|
|
||||||
<h1>StoreApi</h1>
|
|
||||||
<a name="getOrderById"></a>
|
|
||||||
<h2>getOrderById</h2>
|
|
||||||
<h3>GET: /store.{format}/order/{orderId}</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<!-- path params -->
|
|
||||||
<tr>
|
|
||||||
<td>orderId<br/>required</td>
|
|
||||||
<td>path</td>
|
|
||||||
<td>string*</td>
|
|
||||||
<td>Order</td>
|
|
||||||
<td>ID of pet that needs to be fetched<br/><div id="StoreApi_getOrderById" class="operation expandable">For valid response try integer IDs with value <= 5. Anything above 5 or nonintegers will generate API errors</div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="deleteOrder"></a>
|
|
||||||
<h2>deleteOrder</h2>
|
|
||||||
<h3>DELETE: /store.{format}/order/{orderId}</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<!-- path params -->
|
|
||||||
<tr>
|
|
||||||
<td>orderId<br/>required</td>
|
|
||||||
<td>path</td>
|
|
||||||
<td>string*</td>
|
|
||||||
<td>-</td>
|
|
||||||
<td>ID of the order that needs to be deleted<br/><div id="StoreApi_deleteOrder" class="operation expandable">For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors</div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="placeOrder"></a>
|
|
||||||
<h2>placeOrder</h2>
|
|
||||||
<h3>POST: /store.{format}/order</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<tr>
|
|
||||||
<td>body<br/>required</td>
|
|
||||||
<td>body</td>
|
|
||||||
<td>Order*</td>
|
|
||||||
<td>-</td>
|
|
||||||
<td>order placed for purchasing the pet<br/><div id="StoreApi_placeOrder" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- path params -->
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
||||||
@ -1,215 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
||||||
|
|
||||||
<link rel="stylesheet" type="text/css" href="../assets/css/bootstrap.css" media="screen">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../assets/css/bootstrap-responsive.css" media="screen">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../assets/css/style.css">
|
|
||||||
|
|
||||||
<title>REST API v1.1 Resources | Twitter Developers</title>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="header">
|
|
||||||
<div class="top-bar">
|
|
||||||
<h1 id="logo"><a class="logo" href="/"><span>Swagger</span><span class="light">API Docs</span></a></h1>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="main_content">
|
|
||||||
<h1>UserApi</h1>
|
|
||||||
<a name="createUsersWithArrayInput"></a>
|
|
||||||
<h2>createUsersWithArrayInput</h2>
|
|
||||||
<h3>POST: /user.{format}/createWithArray</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<tr>
|
|
||||||
<td>body<br/>required</td>
|
|
||||||
<td>body</td>
|
|
||||||
<td>Array[User]*</td>
|
|
||||||
<td>-</td>
|
|
||||||
<td>List of user object<br/><div id="UserApi_createUsersWithArrayInput" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- path params -->
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="createUser"></a>
|
|
||||||
<h2>createUser</h2>
|
|
||||||
<h3>POST: /user.{format}</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<tr>
|
|
||||||
<td>body<br/>required</td>
|
|
||||||
<td>body</td>
|
|
||||||
<td>User*</td>
|
|
||||||
<td>-</td>
|
|
||||||
<td>Created user object<br/><div id="UserApi_createUser" class="operation expandable">This can only be done by the logged in user.</div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- path params -->
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="createUsersWithListInput"></a>
|
|
||||||
<h2>createUsersWithListInput</h2>
|
|
||||||
<h3>POST: /user.{format}/createWithList</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<tr>
|
|
||||||
<td>body<br/>required</td>
|
|
||||||
<td>body</td>
|
|
||||||
<td>List[User]*</td>
|
|
||||||
<td>-</td>
|
|
||||||
<td>List of user object<br/><div id="UserApi_createUsersWithListInput" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- path params -->
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="updateUser"></a>
|
|
||||||
<h2>updateUser</h2>
|
|
||||||
<h3>PUT: /user.{format}/{username}</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<tr>
|
|
||||||
<td>body<br/>required</td>
|
|
||||||
<td>body</td>
|
|
||||||
<td>User*</td>
|
|
||||||
<td>-</td>
|
|
||||||
<td>Updated user object<br/><div id="UserApi_updateUser" class="operation expandable">This can only be done by the logged in user.</div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- path params -->
|
|
||||||
<tr>
|
|
||||||
<td>username<br/>required</td>
|
|
||||||
<td>path</td>
|
|
||||||
<td>string*</td>
|
|
||||||
<td>-</td>
|
|
||||||
<td>name that need to be deleted<br/><div id="UserApi_updateUser" class="operation expandable">This can only be done by the logged in user.</div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="deleteUser"></a>
|
|
||||||
<h2>deleteUser</h2>
|
|
||||||
<h3>DELETE: /user.{format}/{username}</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<!-- path params -->
|
|
||||||
<tr>
|
|
||||||
<td>username<br/>required</td>
|
|
||||||
<td>path</td>
|
|
||||||
<td>string*</td>
|
|
||||||
<td>-</td>
|
|
||||||
<td>The name that needs to be deleted<br/><div id="UserApi_deleteUser" class="operation expandable">This can only be done by the logged in user.</div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="getUserByName"></a>
|
|
||||||
<h2>getUserByName</h2>
|
|
||||||
<h3>GET: /user.{format}/{username}</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<!-- path params -->
|
|
||||||
<tr>
|
|
||||||
<td>username<br/>required</td>
|
|
||||||
<td>path</td>
|
|
||||||
<td>string*</td>
|
|
||||||
<td>User</td>
|
|
||||||
<td>The name that needs to be fetched. Use user1 for testing.<br/><div id="UserApi_getUserByName" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="loginUser"></a>
|
|
||||||
<h2>loginUser</h2>
|
|
||||||
<h3>GET: /user.{format}/login</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<!-- path params -->
|
|
||||||
<!-- query params -->
|
|
||||||
<tr>
|
|
||||||
<td>username<br/>required</td>
|
|
||||||
<td>query</td>
|
|
||||||
<td>string*</td>
|
|
||||||
<td>string</td>
|
|
||||||
<td>The user name for login<br/><div id="UserApi_loginUser" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>password<br/>required</td>
|
|
||||||
<td>query</td>
|
|
||||||
<td>string*</td>
|
|
||||||
<td>string</td>
|
|
||||||
<td>The password for login in clear text<br/><div id="UserApi_loginUser" class="operation expandable"></div></td>
|
|
||||||
</tr>
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
<a name="logoutUser"></a>
|
|
||||||
<h2>logoutUser</h2>
|
|
||||||
<h3>GET: /user.{format}/logout</h3>
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<th class="column_header_name">parameter</th>
|
|
||||||
<th class="column_header_param_type">param type</th>
|
|
||||||
<th class="column_header_data_type">data type</th>
|
|
||||||
<th class="column_header_return_type">response type</th>
|
|
||||||
<th class="column_header_notes">Description</th>
|
|
||||||
</tr>
|
|
||||||
<!-- body params -->
|
|
||||||
<!-- path params -->
|
|
||||||
<!-- query params -->
|
|
||||||
<!-- header params -->
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
||||||
@ -0,0 +1,6 @@
|
|||||||
|
package .
|
||||||
|
|
||||||
|
case class Category (
|
||||||
|
id: long,
|
||||||
|
name: string)
|
||||||
|
|
||||||
11
samples/docs/swagger-static-docs/src/main/webapp/Order.html
Normal file
11
samples/docs/swagger-static-docs/src/main/webapp/Order.html
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
package .
|
||||||
|
|
||||||
|
import ..Date
|
||||||
|
case class Order (
|
||||||
|
id: long,
|
||||||
|
petId: long,
|
||||||
|
/* Order Status */
|
||||||
|
status: string,
|
||||||
|
quantity: int,
|
||||||
|
shipDate: Date)
|
||||||
|
|
||||||
13
samples/docs/swagger-static-docs/src/main/webapp/Pet.html
Normal file
13
samples/docs/swagger-static-docs/src/main/webapp/Pet.html
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
package .
|
||||||
|
|
||||||
|
import ..Category
|
||||||
|
import ..Tag
|
||||||
|
case class Pet (
|
||||||
|
tags: Array,
|
||||||
|
id: long,
|
||||||
|
category: Category,
|
||||||
|
/* pet status in the store */
|
||||||
|
status: string,
|
||||||
|
name: string,
|
||||||
|
photoUrls: Array)
|
||||||
|
|
||||||
@ -0,0 +1,6 @@
|
|||||||
|
package .
|
||||||
|
|
||||||
|
case class Tag (
|
||||||
|
id: long,
|
||||||
|
name: string)
|
||||||
|
|
||||||
13
samples/docs/swagger-static-docs/src/main/webapp/User.html
Normal file
13
samples/docs/swagger-static-docs/src/main/webapp/User.html
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
package .
|
||||||
|
|
||||||
|
case class User (
|
||||||
|
id: long,
|
||||||
|
lastName: string,
|
||||||
|
phone: string,
|
||||||
|
username: string,
|
||||||
|
email: string,
|
||||||
|
/* User Status */
|
||||||
|
userStatus: int,
|
||||||
|
firstName: string,
|
||||||
|
password: string)
|
||||||
|
|
||||||
@ -0,0 +1,292 @@
|
|||||||
|
.line-numbers {
|
||||||
|
margin-right: 1.0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.content {
|
||||||
|
padding-bottom: 100px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.column_header_name {
|
||||||
|
width: 150px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.column_header_path {
|
||||||
|
width: 350px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.column_header_name .column_header_param_type .column_header_data_type .column_header_return_type {
|
||||||
|
width: 200px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.expandable {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.main_content {
|
||||||
|
margin-top: 80px;
|
||||||
|
margin-left: 25px;
|
||||||
|
margin-right: 25px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.model {
|
||||||
|
float: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.model-container {
|
||||||
|
float: left;
|
||||||
|
width: 500px;
|
||||||
|
padding: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.model-detail-container {
|
||||||
|
clear: left;
|
||||||
|
float: left;
|
||||||
|
width: 500px;
|
||||||
|
margin-left: 40px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.model-detail-popup {
|
||||||
|
box-shadow: rgba(0, 0, 0, 0.2) 0 2px 8px 5px;
|
||||||
|
border-style: solid;
|
||||||
|
border-width: 1px;
|
||||||
|
border-color: black;
|
||||||
|
padding-left: 10px;
|
||||||
|
padding-right: 10px;
|
||||||
|
padding-top: 10px;
|
||||||
|
padding-bottom: 10px;
|
||||||
|
background-color: white;
|
||||||
|
opacity: 0.99;
|
||||||
|
z-index: 1;
|
||||||
|
overflow: scroll;
|
||||||
|
width: 400px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.model-detail-popup .code {
|
||||||
|
background-color: #E4F5FF;
|
||||||
|
font-family: monospace;
|
||||||
|
white-space: pre;
|
||||||
|
margin: 10px;
|
||||||
|
overflow: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.model-detail-popup h2 {
|
||||||
|
margin-top: 0px;
|
||||||
|
padding-top: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.model-detail-popup li {
|
||||||
|
padding-bottom: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.model-detail-popup .param-reqiured-true {
|
||||||
|
font-family: monospace;
|
||||||
|
font-weight: bold;
|
||||||
|
clear: left;
|
||||||
|
display: block;
|
||||||
|
float: left;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.model-detail-popup .param-required-false {
|
||||||
|
font-family: monospace;
|
||||||
|
clear: left;
|
||||||
|
display: block;
|
||||||
|
float: left;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.model-detail-popup .param-description {
|
||||||
|
margin-left: 50px;
|
||||||
|
float: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.section-header {
|
||||||
|
border-bottom: 2px;
|
||||||
|
font-weight: bold;
|
||||||
|
font-size: 15px;
|
||||||
|
padding: 6px 0;
|
||||||
|
color: rgb(57,57,57);
|
||||||
|
}
|
||||||
|
|
||||||
|
.content {
|
||||||
|
padding-top: 100px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.content h1 {
|
||||||
|
font-size: 43px;
|
||||||
|
text-align: center;
|
||||||
|
margin-top: 40px;
|
||||||
|
margin-bottom: 40px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sidebar {
|
||||||
|
box-sizing: border-box;
|
||||||
|
float: left;
|
||||||
|
display: block;
|
||||||
|
width: 240px;
|
||||||
|
overflow: scroll;
|
||||||
|
position: fixed;
|
||||||
|
}
|
||||||
|
|
||||||
|
.section-box {
|
||||||
|
border-bottom-style: solid;
|
||||||
|
border-bottom: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.section-box ul li {
|
||||||
|
list-style: none;
|
||||||
|
margin-left: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.non-sidebar {
|
||||||
|
box-sizing: border-box;
|
||||||
|
display: block;
|
||||||
|
margin-left: 240px;
|
||||||
|
margin-right: 0px;
|
||||||
|
width: 638px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.non-sidebar h2 {
|
||||||
|
clear: left;
|
||||||
|
padding-top: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param {
|
||||||
|
display: block;
|
||||||
|
float: left;
|
||||||
|
width: 220px;
|
||||||
|
clear: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param-description {
|
||||||
|
float: left;
|
||||||
|
font-family: 'Helvetica Neue', Arial, 'Liberation Sans', FreeSans, sans-serif;
|
||||||
|
}
|
||||||
|
|
||||||
|
.param-optional-flag {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.section {
|
||||||
|
font-weight: normal;
|
||||||
|
clear: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.section a {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.code {
|
||||||
|
background-color: #E4F5FF;
|
||||||
|
font-family: monospace;
|
||||||
|
white-space: pre;
|
||||||
|
margin: 10px;
|
||||||
|
overflow: auto;
|
||||||
|
width: 600px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.header {
|
||||||
|
position: fixed;
|
||||||
|
text-align: left;
|
||||||
|
background-color: black;
|
||||||
|
float: left;
|
||||||
|
top: 0;
|
||||||
|
width: 100%;
|
||||||
|
height: 70px auto;
|
||||||
|
padding-bottom: 20px;
|
||||||
|
box-shadow: rgba(0, 0, 0, 0.2) 0 2px 8px 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar h1 a {
|
||||||
|
width: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar h1#logo a {
|
||||||
|
width: auto;
|
||||||
|
display: block;
|
||||||
|
clear: none;
|
||||||
|
float: left;
|
||||||
|
background-position: left;;
|
||||||
|
color: white;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar ul li {
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar h1#logo span {
|
||||||
|
display: block;
|
||||||
|
clear: none;
|
||||||
|
float: left;
|
||||||
|
padding-top: 10px;
|
||||||
|
padding-left: 10px;
|
||||||
|
margin: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar h1#logo a span.light {
|
||||||
|
color: #ffc97a;
|
||||||
|
color: #666666;
|
||||||
|
padding-left: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar ul#nav {
|
||||||
|
float: none;
|
||||||
|
clear: both;
|
||||||
|
overflow: hidden;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
display: block;
|
||||||
|
float: right;
|
||||||
|
clear: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar ul#nav li {
|
||||||
|
float: left;
|
||||||
|
clear: none;
|
||||||
|
margin: 0;
|
||||||
|
padding: 2px 10px;
|
||||||
|
border-right: 1px solid #dddddd;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar ul#nav li:first-child, .top-bar ul#nav li.first {
|
||||||
|
padding-left: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar ul#nav li:last-child, .top-bar ul#nav li.last {
|
||||||
|
padding-right: 0;
|
||||||
|
border-right: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar ul#nav li {
|
||||||
|
border: none;
|
||||||
|
padding: 0 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar ul#nav li a {
|
||||||
|
display: block;
|
||||||
|
padding: 8px 10px 8px 10px;
|
||||||
|
color: #999999;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar ul#nav li a.strong {
|
||||||
|
color: white;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar ul#nav li a:active, .top-bar ul#nav li a.active, .top-bar ul#nav li a:hover {
|
||||||
|
-moz-border-radius: 4px;
|
||||||
|
-webkit-border-radius: 4px;
|
||||||
|
-o-border-radius: 4px;
|
||||||
|
-ms-border-radius: 4px;
|
||||||
|
-khtml-border-radius: 4px;
|
||||||
|
border-radius: 4px;
|
||||||
|
background-image: -webkit-gradient(linear, 0% 100%, 0% 0%, color-stop(0%, #ff5401), color-stop(100%, #ffa014));
|
||||||
|
background-image: -moz-linear-gradient(bottom, #ff5401 0%, #ffa014 100%);
|
||||||
|
background-image: linear-gradient(bottom, #ff5401 0%, #ffa014 100%);
|
||||||
|
color: white;
|
||||||
|
}
|
||||||
|
|
||||||
|
.top-bar ul#nav:hover li {
|
||||||
|
border-color: #222222;
|
||||||
|
}
|
||||||
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
@ -0,0 +1,63 @@
|
|||||||
|
function main() {}
|
||||||
|
|
||||||
|
window.onhashchange = function() {
|
||||||
|
choose(window.location.href.toString());
|
||||||
|
}
|
||||||
|
|
||||||
|
var url = 'http://motyar.blogspot.com/search?q={term}', selectionImage;
|
||||||
|
|
||||||
|
function showModel(e, model) {
|
||||||
|
}
|
||||||
|
|
||||||
|
function choose(url) {
|
||||||
|
var f = url.split("/").slice(-1)[0].split("?")[0];
|
||||||
|
if(f.match(/#/g) && f.match(/#/g).length > 0) {
|
||||||
|
f = f.split("#")[0];
|
||||||
|
}
|
||||||
|
$('div.non-sidebar').empty();
|
||||||
|
$('div.non-sidebar').load("operations/" + f + ".html", function(){
|
||||||
|
goToAnchor();
|
||||||
|
// rebind the models
|
||||||
|
$(".model a").on("click", function(e){
|
||||||
|
e.preventDefault();
|
||||||
|
var model = $(this).parent().attr("id")
|
||||||
|
var parentOffset = $(this).parent().offset();
|
||||||
|
var encodedWord = encodeURI(model);
|
||||||
|
|
||||||
|
if(!selectionImage) {
|
||||||
|
selectionImage = $('<div>').attr({
|
||||||
|
title: 'Model detail',
|
||||||
|
target: '_blank',
|
||||||
|
class: 'model-detail-popup'
|
||||||
|
}).hide();
|
||||||
|
$('div.model-container').append(selectionImage);
|
||||||
|
}
|
||||||
|
|
||||||
|
selectionImage.load("/models/" + encodedWord + ".html")
|
||||||
|
selectionImage.attr('href',url.replace('{term}',encodeURI(model))).css({
|
||||||
|
left: e.pageX + 20,
|
||||||
|
top: e.pageY - 10,
|
||||||
|
position: "absolute"
|
||||||
|
}).fadeIn();
|
||||||
|
})
|
||||||
|
});
|
||||||
|
|
||||||
|
$("body").on("click",function(e) {
|
||||||
|
var target = $(e.target);
|
||||||
|
if (target.parents(".model-detail-popup").length == 0 && target.parents('.model').length != 1) {
|
||||||
|
if(document.querySelector('.model-detail-popup')) {
|
||||||
|
document.querySelector('.model-detail-popup').style.display = 'none';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function goToAnchor() {
|
||||||
|
var doARead = $($('a')[0]).offset();
|
||||||
|
var anchorArr = window.location.href.toString().split("#");
|
||||||
|
if(anchorArr.length > 2) {
|
||||||
|
var anchor = anchorArr[anchorArr.length-1];
|
||||||
|
window.scrollTo(0,$('a[name='+anchor+']').offset().top - 80);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
106
samples/docs/swagger-static-docs/src/main/webapp/index.html
Normal file
106
samples/docs/swagger-static-docs/src/main/webapp/index.html
Normal file
@ -0,0 +1,106 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
|
||||||
|
<link rel="stylesheet" type="text/css" href="assets/css/bootstrap.css" media="screen">
|
||||||
|
<link rel="stylesheet" type="text/css" href="assets/css/bootstrap-responsive.css" media="screen">
|
||||||
|
<link rel="stylesheet" type="text/css" href="assets/css/style.css">
|
||||||
|
<script src="assets/js/jquery-1.8.3.min.js" type="text/javascript"></script>
|
||||||
|
<script src="assets/js/main.js" type="text/javascript"></script>
|
||||||
|
|
||||||
|
<title>REST API Resources</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div class="header">
|
||||||
|
<div class="top-bar">
|
||||||
|
<h1 id="logo"><a class="logo" href="/"><span>Swagger</span><span class="light">API Docs</span></a></h1>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="model-container"></div>
|
||||||
|
<div class="content">
|
||||||
|
<div class="box clearfix">
|
||||||
|
<div class="sidebar">
|
||||||
|
<div class="section-box">
|
||||||
|
<div class="section-header">
|
||||||
|
Overview
|
||||||
|
</div>
|
||||||
|
<ul>
|
||||||
|
<li>Getting Started</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section-box">
|
||||||
|
<div class="section-header">
|
||||||
|
<a href="/#!/WordListsApi">WordListsApi</a>
|
||||||
|
</div>
|
||||||
|
<ul>
|
||||||
|
<li><a href="/#!/WordListsApi#createWordList">createWordList</a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section-box">
|
||||||
|
<div class="section-header">
|
||||||
|
<a href="/#!/WordsApi">WordsApi</a>
|
||||||
|
</div>
|
||||||
|
<ul>
|
||||||
|
<li><a href="/#!/WordsApi#searchWords">searchWords</a></li>
|
||||||
|
<li><a href="/#!/WordsApi#getWordOfTheDay">getWordOfTheDay</a></li>
|
||||||
|
<li><a href="/#!/WordsApi#reverseDictionary">reverseDictionary</a></li>
|
||||||
|
<li><a href="/#!/WordsApi#getRandomWords">getRandomWords</a></li>
|
||||||
|
<li><a href="/#!/WordsApi#getRandomWord">getRandomWord</a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section-box">
|
||||||
|
<div class="section-header">
|
||||||
|
<a href="/#!/AccountApi">AccountApi</a>
|
||||||
|
</div>
|
||||||
|
<ul>
|
||||||
|
<li><a href="/#!/AccountApi#authenticate">authenticate</a></li>
|
||||||
|
<li><a href="/#!/AccountApi#authenticatePost">authenticatePost</a></li>
|
||||||
|
<li><a href="/#!/AccountApi#getWordListsForLoggedInUser">getWordListsForLoggedInUser</a></li>
|
||||||
|
<li><a href="/#!/AccountApi#getApiTokenStatus">getApiTokenStatus</a></li>
|
||||||
|
<li><a href="/#!/AccountApi#getLoggedInUser">getLoggedInUser</a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section-box">
|
||||||
|
<div class="section-header">
|
||||||
|
<a href="/#!/WordListApi">WordListApi</a>
|
||||||
|
</div>
|
||||||
|
<ul>
|
||||||
|
<li><a href="/#!/WordListApi#updateWordList">updateWordList</a></li>
|
||||||
|
<li><a href="/#!/WordListApi#deleteWordList">deleteWordList</a></li>
|
||||||
|
<li><a href="/#!/WordListApi#getWordListByPermalink">getWordListByPermalink</a></li>
|
||||||
|
<li><a href="/#!/WordListApi#addWordsToWordList">addWordsToWordList</a></li>
|
||||||
|
<li><a href="/#!/WordListApi#getWordListWords">getWordListWords</a></li>
|
||||||
|
<li><a href="/#!/WordListApi#deleteWordsFromWordList">deleteWordsFromWordList</a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section-box">
|
||||||
|
<div class="section-header">
|
||||||
|
<a href="/#!/WordApi">WordApi</a>
|
||||||
|
</div>
|
||||||
|
<ul>
|
||||||
|
<li><a href="/#!/WordApi#getExamples">getExamples</a></li>
|
||||||
|
<li><a href="/#!/WordApi#getWord">getWord</a></li>
|
||||||
|
<li><a href="/#!/WordApi#getDefinitions">getDefinitions</a></li>
|
||||||
|
<li><a href="/#!/WordApi#getTopExample">getTopExample</a></li>
|
||||||
|
<li><a href="/#!/WordApi#getRelatedWords">getRelatedWords</a></li>
|
||||||
|
<li><a href="/#!/WordApi#getTextPronunciations">getTextPronunciations</a></li>
|
||||||
|
<li><a href="/#!/WordApi#getHyphenation">getHyphenation</a></li>
|
||||||
|
<li><a href="/#!/WordApi#getWordFrequency">getWordFrequency</a></li>
|
||||||
|
<li><a href="/#!/WordApi#getPhrases">getPhrases</a></li>
|
||||||
|
<li><a href="/#!/WordApi#getEtymologies">getEtymologies</a></li>
|
||||||
|
<li><a href="/#!/WordApi#getAudio">getAudio</a></li>
|
||||||
|
<li><a href="/#!/WordApi#getScrabbleScore">getScrabbleScore</a></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="non-sidebar">
|
||||||
|
<div class="main-content">
|
||||||
|
<h2>Getting Started</h2>
|
||||||
|
<p>To begin using your fancy HTTP API, follow the steps below.</p>
|
||||||
|
<p>You can add some helpful tips, here</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@ -0,0 +1,32 @@
|
|||||||
|
<h2>ApiTokenStatus</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">valid : boolean
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">token : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">resetsInMillis : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">remainingCalls : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">expiresInMillis : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">totalRequests : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,72 @@
|
|||||||
|
<h2>AudioFile</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">attributionUrl : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">commentCount : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">voteCount : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">fileUrl : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">audioType : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-true">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">duration : double
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">attributionText : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">createdBy : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">description : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">createdAt : Date
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">voteWeightedAverage : float
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">voteAverage : float
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">word : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,17 @@
|
|||||||
|
<h2>AuthenticationToken</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">token : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">userId : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">userSignature : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,27 @@
|
|||||||
|
<h2>Bigram</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">count : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">gram2 : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">gram1 : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">wlmi : double
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">mi : double
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
<h2>Category</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">name : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
<h2>Citation</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">cite : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">source : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
<h2>ContentProvider</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">id : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">name : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,82 @@
|
|||||||
|
<h2>Definition</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">extendedText : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">text : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">sourceDictionary : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">citations : List[Citation]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">labels : List[Label]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">score : float
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">exampleUses : List[ExampleUsage]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">attributionUrl : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">seqString : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">attributionText : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">relatedWords : List[Related]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">sequence : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">word : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">notes : List[Note]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">textProns : List[TextPron]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">partOfSpeech : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
<h2>DefinitionSearchResults</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">results : List[Definition]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">totalResults : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,62 @@
|
|||||||
|
<h2>Example</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">exampleId : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">title : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">text : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">score : ScoredWord
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">sentence : Sentence
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">word : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">provider : ContentProvider
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">year : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">rating : float
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">documentId : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">url : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
<h2>ExampleSearchResults</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">facets : List[Facet]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">examples : List[Example]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,7 @@
|
|||||||
|
<h2>ExampleUsage</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">text : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
<h2>Facet</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">facetValues : List[FacetValue]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">name : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
<h2>FacetValue</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">count : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">value : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
<h2>Frequency</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">count : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">year : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,27 @@
|
|||||||
|
<h2>FrequencySummary</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">unknownYearCount : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">totalCount : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">frequencyString : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">word : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">frequency : List[Frequency]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
<h2>Label</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">text : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">type : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,22 @@
|
|||||||
|
<h2>Note</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">noteType : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">appliesTo : List[string]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">value : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">pos : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,27 @@
|
|||||||
|
<h2>Order</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">petId : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">status : string
|
||||||
|
<div class="param-description">Order Status</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">quantity : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">shipDate : Date
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,32 @@
|
|||||||
|
<h2>Pet</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-true">tags : List[Tag]
|
||||||
|
<div class="param-description">Tags are arbitrary, unique strings. Each pet can have a number of tags on them.</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">category : Category
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">status : string
|
||||||
|
<div class="param-description">pet status in the store</div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">name : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">photoUrls : List[string]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,37 @@
|
|||||||
|
<h2>Related</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">label1 : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">relationshipType : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">label2 : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">label3 : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">words : List[string]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">gram : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">label4 : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,57 @@
|
|||||||
|
<h2>ScoredWord</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">position : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">docTermCount : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">lemma : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">wordType : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">score : float
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">sentenceId : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">word : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">stopword : boolean
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">baseWordScore : double
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">partOfSpeech : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,7 @@
|
|||||||
|
<h2>ScrabbleScoreResult</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">value : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,32 @@
|
|||||||
|
<h2>Sentence</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">hasScoredWords : boolean
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">scoredWords : List[ScoredWord]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">display : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">rating : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">documentMetadataId : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,22 @@
|
|||||||
|
<h2>SimpleDefinition</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">text : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">source : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">note : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">partOfSpeech : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,22 @@
|
|||||||
|
<h2>SimpleExample</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">title : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">text : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">url : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,7 @@
|
|||||||
|
<h2>StringValue</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">word : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,17 @@
|
|||||||
|
<h2>Syllable</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">text : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">seq : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">type : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
<h2>Tag</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">name : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,17 @@
|
|||||||
|
<h2>TextPron</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">raw : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">seq : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">rawType : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,42 @@
|
|||||||
|
<h2>User</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">username : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">email : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">status : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">faceBookId : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">userName : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">displayName : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">password : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,57 @@
|
|||||||
|
<h2>WordList</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">permalink : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">name : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">createdAt : Date
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">updatedAt : Date
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">lastActivityAt : Date
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">username : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">userId : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">description : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">numberWordsInList : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">type : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,37 @@
|
|||||||
|
<h2>WordListWord</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-true">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">word : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">username : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">userId : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">createdAt : Date
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">numberCommentsOnWord : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">numberLists : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,32 @@
|
|||||||
|
<h2>WordObject</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-true">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">word : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">originalWord : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">suggestions : List[string]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">canonicalForm : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">vulgar : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,62 @@
|
|||||||
|
<h2>WordOfTheDay</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-true">id : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">parentId : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">category : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">createdBy : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">createdAt : Date
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">contentProvider : ContentProvider
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">htmlExtra : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">word : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">definitions : List[SimpleDefinition]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">examples : List[SimpleExample]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">note : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">publishDate : Date
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,17 @@
|
|||||||
|
<h2>WordSearchResult</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">count : long
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">lexicality : double
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">word : string
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
<h2>WordSearchResults</h2>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">searchResults : List[WordSearchResult]
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<ul class="parameter">
|
||||||
|
<li class="param-required-false">totalResults : int
|
||||||
|
<div class="param-description"></div>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
@ -0,0 +1,119 @@
|
|||||||
|
<div class="main-content">
|
||||||
|
<h2><a name="AccountApi"></a>AccountApi</h2>
|
||||||
|
<p>This is the AccountApi API</p>
|
||||||
|
|
||||||
|
<h2><a name="authenticate"></a>authenticate</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/account.{format}/authenticate/{username}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="AuthenticationToken"><a href="#">AuthenticationToken</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">username : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">A confirmed Wordnik username</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">password : string (query)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The user's password</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="authenticatePost"></a>authenticatePost</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/account.{format}/authenticate/{username}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>POST</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="AuthenticationToken"><a href="#">AuthenticationToken</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">username : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">A confirmed Wordnik username</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">body : string (body)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The user's password</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getWordListsForLoggedInUser"></a>getWordListsForLoggedInUser</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/account.{format}/wordLists</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="WordList"><a href="#">List[WordList]</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">auth_token : string (header)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">auth_token of logged-in user</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">skip : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Results to skip</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">limit : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum number of results to return</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getApiTokenStatus"></a>getApiTokenStatus</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/account.{format}/apiTokenStatus</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="ApiTokenStatus"><a href="#">ApiTokenStatus</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">api_key : string (header)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Wordnik authentication token</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getLoggedInUser"></a>getLoggedInUser</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p>Requires a valid auth_token to be set.</p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/account.{format}/user</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="User"><a href="#">User</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">auth_token : string (header)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
@ -0,0 +1,95 @@
|
|||||||
|
<div class="main-content">
|
||||||
|
<h2><a name="PetApi"></a>PetApi</h2>
|
||||||
|
<p>This is the PetApi API</p>
|
||||||
|
|
||||||
|
<h2><a name="getPetById"></a>getPetById</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p>Returns a pet based on ID</p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/pet.{format}/{petId}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="Pet"><a href="#">Pet</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">petId : string(path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">ID of pet that needs to be fetched</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="addPet"></a>addPet</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/pet.{format}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>POST</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">body : <div class="model" id="Pet"><a href="#">Pet</a>(body)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Pet object that needs to be added to the store</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="updatePet"></a>updatePet</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/pet.{format}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>PUT</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">body : <div class="model" id="Pet"><a href="#">Pet</a>(body)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Pet object that needs to be updated in the store</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="findPetsByStatus"></a>findPetsByStatus</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p>Multiple status values can be provided with comma seperated strings</p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/pet.{format}/findByStatus</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="Pet"><a href="#">List[Pet]</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">status : string(query)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Status values that need to be considered for filter</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="findPetsByTags"></a>findPetsByTags</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p>Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.</p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/pet.{format}/findByTags</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="Pet"><a href="#">List[Pet]</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">tags : string(query)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Tags to filter by</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
@ -0,0 +1,59 @@
|
|||||||
|
<div class="main-content">
|
||||||
|
<h2><a name="StoreApi"></a>StoreApi</h2>
|
||||||
|
<p>This is the StoreApi API</p>
|
||||||
|
|
||||||
|
<h2><a name="getOrderById"></a>getOrderById</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p>For valid response try integer IDs with value <= 5. Anything above 5 or nonintegers will generate API errors</p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/store.{format}/order/{orderId}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="Order"><a href="#">Order</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">orderId : string(path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">ID of pet that needs to be fetched</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="deleteOrder"></a>deleteOrder</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p>For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors</p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/store.{format}/order/{orderId}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>DELETE</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">orderId : string(path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">ID of the order that needs to be deleted</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="placeOrder"></a>placeOrder</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/store.{format}/order</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>POST</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">body : <div class="model" id="Order"><a href="#">Order</a>(body)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">order placed for purchasing the pet</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
@ -0,0 +1,155 @@
|
|||||||
|
<div class="main-content">
|
||||||
|
<h2><a name="UserApi"></a>UserApi</h2>
|
||||||
|
<p>This is the UserApi API</p>
|
||||||
|
|
||||||
|
<h2><a name="createUsersWithArrayInput"></a>createUsersWithArrayInput</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/user.{format}/createWithArray</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>POST</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">body : <div class="model" id="User"><a href="#">Array[User]</a>(body)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">List of user object</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="createUser"></a>createUser</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p>This can only be done by the logged in user.</p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/user.{format}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>POST</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">body : <div class="model" id="User"><a href="#">User</a>(body)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Created user object</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="createUsersWithListInput"></a>createUsersWithListInput</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/user.{format}/createWithList</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>POST</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">body : <div class="model" id="User"><a href="#">List[User]</a>(body)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">List of user object</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="updateUser"></a>updateUser</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p>This can only be done by the logged in user.</p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/user.{format}/{username}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>PUT</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">username : string(path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">name that need to be deleted</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">body : <div class="model" id="User"><a href="#">User</a>(body)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Updated user object</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="deleteUser"></a>deleteUser</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p>This can only be done by the logged in user.</p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/user.{format}/{username}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>DELETE</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">username : string(path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The name that needs to be deleted</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getUserByName"></a>getUserByName</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/user.{format}/{username}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="User"><a href="#">User</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">username : string(path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The name that needs to be fetched. Use user1 for testing.</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="loginUser"></a>loginUser</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/user.{format}/login</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="string"><a href="#">string</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">username : string(query)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The user name for login</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">password : string(query)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The password for login in clear text</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="logoutUser"></a>logoutUser</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://petstore.swagger.wordnik.com/api/user.{format}/logout</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
@ -0,0 +1,413 @@
|
|||||||
|
<div class="main-content">
|
||||||
|
<h2><a name="WordApi"></a>WordApi</h2>
|
||||||
|
<p>This is the WordApi API</p>
|
||||||
|
|
||||||
|
<h2><a name="getExamples"></a>getExamples</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/word.{format}/{word}/examples</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="ExampleSearchResults"><a href="#">ExampleSearchResults</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">word : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Word to return examples for</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">includeDuplicates : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Show duplicate examples from different sources</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">useCanonical : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">skip : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Results to skip</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">limit : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum number of results to return</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getWord"></a>getWord</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/word.{format}/{word}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="WordObject"><a href="#">WordObject</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">word : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">String value of WordObject to return</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">useCanonical : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">includeSuggestions : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Return suggestions (for correct spelling, case variants, etc.)</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getDefinitions"></a>getDefinitions</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/word.{format}/{word}/definitions</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="Definition"><a href="#">List[Definition]</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">word : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Word to return definitions for</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">partOfSpeech : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">CSV list of part-of-speech types</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">sourceDictionaries : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Source dictionary to return definitions from. If 'all' is received, results are returned from all sources. If multiple values are received (e.g. 'century,wiktionary'), results are returned from the first specified dictionary that has definitions. If left blank, results are returned from the first dictionary that has definitions. By default, dictionaries are searched in this order: ahd, wiktionary, webster, century, wordnet</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">limit : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum number of results to return</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">includeRelated : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Return related words with definitions</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">useCanonical : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">includeTags : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Return a closed set of XML tags in response</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getTopExample"></a>getTopExample</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/word.{format}/{word}/topExample</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="Example"><a href="#">Example</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">word : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Word to fetch examples for</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">useCanonical : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getRelatedWords"></a>getRelatedWords</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/word.{format}/{word}/relatedWords</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="Related"><a href="#">List[Related]</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">word : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Word to fetch relationships for</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">relationshipTypes : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Limits the total results per type of relationship type</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">useCanonical : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">limitPerRelationshipType : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Restrict to the supplied relatinship types</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getTextPronunciations"></a>getTextPronunciations</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/word.{format}/{word}/pronunciations</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="TextPron"><a href="#">List[TextPron]</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">word : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Word to get pronunciations for</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">sourceDictionary : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Get from a single dictionary</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">typeFormat : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Text pronunciation type</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">useCanonical : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">limit : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum number of results to return</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getHyphenation"></a>getHyphenation</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/word.{format}/{word}/hyphenation</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="Syllable"><a href="#">List[Syllable]</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">word : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Word to get syllables for</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">sourceDictionary : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">useCanonical : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">limit : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum number of results to return</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getWordFrequency"></a>getWordFrequency</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/word.{format}/{word}/frequency</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="FrequencySummary"><a href="#">FrequencySummary</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">word : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Word to return</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">useCanonical : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">startYear : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Starting Year</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">endYear : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Ending Year</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getPhrases"></a>getPhrases</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/word.{format}/{word}/phrases</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="Bigram"><a href="#">List[Bigram]</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">word : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Word to fetch phrases for</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">limit : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum number of results to return</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">wlmi : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Minimum WLMI for the phrase</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">useCanonical : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getEtymologies"></a>getEtymologies</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/word.{format}/{word}/etymologies</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="string"><a href="#">List[string]</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">word : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Word to return</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">useCanonical : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getAudio"></a>getAudio</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p>The metadata includes a time-expiring fileUrl which allows reading the audio file directly from the API. Currently only audio pronunciations from the American Heritage Dictionary in mp3 format are supported.</p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/word.{format}/{word}/audio</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="AudioFile"><a href="#">List[AudioFile]</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">word : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Word to get audio for.</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">useCanonical : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Use the canonical form of the word</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">limit : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum number of results to return</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getScrabbleScore"></a>getScrabbleScore</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/word.{format}/{word}/scrabbleScore</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="ScrabbleScoreResult"><a href="#">ScrabbleScoreResult</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">word : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Word to get scrabble score for.</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
@ -0,0 +1,191 @@
|
|||||||
|
<div class="main-content">
|
||||||
|
<h2><a name="WordListApi"></a>WordListApi</h2>
|
||||||
|
<p>This is the WordListApi API</p>
|
||||||
|
|
||||||
|
<h2><a name="updateWordList"></a>updateWordList</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/wordList.{format}/{permalink}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>PUT</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">permalink : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">permalink of WordList to update</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">body : <div class="model" id="WordList"><a href="#">WordList</a> (body)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Updated WordList</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">auth_token : string (header)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="deleteWordList"></a>deleteWordList</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/wordList.{format}/{permalink}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>DELETE</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">permalink : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">ID of WordList to delete</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">auth_token : string (header)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getWordListByPermalink"></a>getWordListByPermalink</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/wordList.{format}/{permalink}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="WordList"><a href="#">WordList</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">permalink : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">permalink of WordList to fetch</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">auth_token : string (header)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="addWordsToWordList"></a>addWordsToWordList</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/wordList.{format}/{permalink}/words</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>POST</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">permalink : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">permalink of WordList to user</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">body : <div class="model" id="StringValue"><a href="#">Array[StringValue]</a> (body)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Array of words to add to WordList</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">auth_token : string (header)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getWordListWords"></a>getWordListWords</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/wordList.{format}/{permalink}/words</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="WordListWord"><a href="#">List[WordListWord]</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">permalink : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">ID of WordList to use</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">auth_token : string (header)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">sortBy : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Field to sort by</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">sortOrder : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Direction to sort</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">skip : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Results to skip</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">limit : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum number of results to return</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="deleteWordsFromWordList"></a>deleteWordsFromWordList</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/wordList.{format}/{permalink}/deleteWords</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>POST</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="void"><a href="#"></a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">permalink : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">permalink of WordList to use</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">body : <div class="model" id="StringValue"><a href="#">Array[StringValue]</a> (body)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Words to remove from WordList</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">auth_token : string (header)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
@ -0,0 +1,29 @@
|
|||||||
|
<div class="main-content">
|
||||||
|
<h2><a name="WordListsApi"></a>WordListsApi</h2>
|
||||||
|
<p>This is the WordListsApi API</p>
|
||||||
|
|
||||||
|
<h2><a name="createWordList"></a>createWordList</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/wordLists.{format}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>POST</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="WordList"><a href="#">WordList</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">body : <div class="model" id="WordList"><a href="#">WordList</a> (body)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">WordList to create</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">auth_token : string (header)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
@ -0,0 +1,365 @@
|
|||||||
|
<div class="main-content">
|
||||||
|
<h2><a name="WordsApi"></a>WordsApi</h2>
|
||||||
|
<p>This is the WordsApi API</p>
|
||||||
|
|
||||||
|
<h2><a name="searchWords"></a>searchWords</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/words.{format}/search/{query}</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="WordSearchResults"><a href="#">WordSearchResults</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">query : string (path)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Search query</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">includePartOfSpeech : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Only include these comma-delimited parts of speech</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">excludePartOfSpeech : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Exclude these comma-delimited parts of speech</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">caseSensitive : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Search case sensitive</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">minCorpusCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Minimum corpus frequency for terms</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">maxCorpusCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum corpus frequency for terms</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">minDictionaryCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Minimum number of dictionary entries for words returned</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">maxDictionaryCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum dictionary definition count</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">minLength : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Minimum word length</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">maxLength : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum word length</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">skip : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Results to skip</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">limit : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum number of results to return</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getWordOfTheDay"></a>getWordOfTheDay</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/words.{format}/wordOfTheDay</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="WordOfTheDay"><a href="#">WordOfTheDay</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">date : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Fetches by date in yyyy-MM-dd</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="reverseDictionary"></a>reverseDictionary</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/words.{format}/reverseDictionary</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="DefinitionSearchResults"><a href="#">DefinitionSearchResults</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">query : string (query)</div>
|
||||||
|
<span></span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Search term</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">findSenseForWord : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Restricts words and finds closest sense</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">includeSourceDictionaries : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Only include these comma-delimited source dictionaries</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">excludeSourceDictionaries : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Exclude these comma-delimited source dictionaries</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">includePartOfSpeech : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Only include these comma-delimited parts of speech</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">excludePartOfSpeech : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Exclude these comma-delimited parts of speech</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">expandTerms : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Expand terms</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">sortBy : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Attribute to sort by</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">sortOrder : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Sort direction</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">minCorpusCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Minimum corpus frequency for terms</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">maxCorpusCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum corpus frequency for terms</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">minLength : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Minimum word length</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">maxLength : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum word length</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">includeTags : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Return a closed set of XML tags in response</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">skip : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Results to skip</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">limit : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum number of results to return</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getRandomWords"></a>getRandomWords</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/words.{format}/randomWords</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="WordObject"><a href="#">List[WordObject]</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">includePartOfSpeech : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">CSV part-of-speech values to include</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">excludePartOfSpeech : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">CSV part-of-speech values to exclude</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">sortBy : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Attribute to sort by</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">sortOrder : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Sort direction</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">hasDictionaryDef : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Only return words with dictionary definitions</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">minCorpusCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Minimum corpus frequency for terms</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">maxCorpusCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum corpus frequency for terms</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">minDictionaryCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Minimum dictionary count</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">maxDictionaryCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum dictionary count</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">minLength : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Minimum word length</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">maxLength : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum word length</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">limit : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum number of results to return</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
<h2><a name="getRandomWord"></a>getRandomWord</h2>
|
||||||
|
<hr>
|
||||||
|
<p></p>
|
||||||
|
<p></p><h3 class="section">URL</h3>
|
||||||
|
<code>http://api.wordnik.com/v4/words.{format}/randomWord</code>
|
||||||
|
<h3 class="section">HTTP Method</h3>
|
||||||
|
<code>GET</code>
|
||||||
|
<h3 class="section">Response Type</h3>
|
||||||
|
<div class="model" id="WordObject"><a href="#">WordObject</a></div>
|
||||||
|
<h3 class="section">Parameters</h3>
|
||||||
|
<ul>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">includePartOfSpeech : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">CSV part-of-speech values to include</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">excludePartOfSpeech : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">CSV part-of-speech values to exclude</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">hasDictionaryDef : string (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Only return words with dictionary definitions</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">minCorpusCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Minimum corpus frequency for terms</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">maxCorpusCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum corpus frequency for terms</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">minDictionaryCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Minimum dictionary count</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">maxDictionaryCount : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum dictionary count</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">minLength : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Minimum word length</p>
|
||||||
|
</div>
|
||||||
|
<div class="parameter">
|
||||||
|
<div class="param">maxLength : int (query)</div>
|
||||||
|
<span>optional</span>
|
||||||
|
</div>
|
||||||
|
<p class="param-description">Maximum word length</p>
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
Loading…
x
Reference in New Issue
Block a user