diff --git a/samples/docs/swagger-static-docs/pom.xml b/samples/docs/swagger-static-docs/pom.xml new file mode 100644 index 00000000000..0a0d06c4052 --- /dev/null +++ b/samples/docs/swagger-static-docs/pom.xml @@ -0,0 +1,119 @@ + + 4.0.0 + com.wordnik + wordnik-swagger-demo + jar + wordnik-swagger-demo + 1.0.0-SNAPSHOT + + 2.2.0 + + + + src/main/scala + src/test/scala + + + net.alchim31.maven + scala-maven-plugin + ${maven-plugin.version} + + + + compile + testCompile + + + + + + -Xms64m + -Xmx1024m + + + + + maven-surefire-plugin + + once + false + + + + maven-dependency-plugin + + + package + + copy-dependencies + + + ${project.build.directory}/lib + + + + + + org.mortbay.jetty + jetty-maven-plugin + ${jetty-version} + + + / + + + + 8000 + 60000 + 8443 + + + + + + start-jetty + pre-integration-test + + run + + + 0 + true + + + + stop-jetty + post-integration-test + + stop + + + + + + + + + sonatype-snapshots + https://oss.sonatype.org/content/repositories/snapshots + + + sonatype-releases + https://oss.sonatype.org/content/repositories/releases + + + + + com.wordnik + swagger-codegen_2.9.1 + ${swagger-codegen-version} + compile + + + + 2.0.2-SNAPSHOT + 3.1.0 + 7.6.0.v20120127 + + diff --git a/samples/docs/swagger-static-docs/sd/assets/css/style.css b/samples/docs/swagger-static-docs/sd/assets/css/style.css deleted file mode 100644 index 5b6a6c19893..00000000000 --- a/samples/docs/swagger-static-docs/sd/assets/css/style.css +++ /dev/null @@ -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; -} \ No newline at end of file diff --git a/samples/docs/swagger-static-docs/sd/index.html b/samples/docs/swagger-static-docs/sd/index.html deleted file mode 100644 index ec27bf4b8a8..00000000000 --- a/samples/docs/swagger-static-docs/sd/index.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - - - - REST API v1.1 Resources | Twitter Developers - - -
-
-

-
-
-
-

API Documentation

-

UserApi

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameResourceNotes
createUsersWithArrayInput/user.{format}/createWithArrayCreates list of users with given input array
createUser/user.{format}Create user
createUsersWithListInput/user.{format}/createWithListCreates list of users with given list input
updateUser/user.{format}/{username}Updated user
deleteUser/user.{format}/{username}Delete user
getUserByName/user.{format}/{username}Get user by user name
loginUser/user.{format}/loginLogs user into the system
logoutUser/user.{format}/logoutLogs out current logged in user session
-

PetApi

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameResourceNotes
getPetById/pet.{format}/{petId}Find pet by ID
addPet/pet.{format}Add a new pet to the store
updatePet/pet.{format}Update an existing pet
findPetsByStatus/pet.{format}/findByStatusFinds Pets by status
findPetsByTags/pet.{format}/findByTagsFinds Pets by tags
-

StoreApi

- - - - - - - - - - - - - - - - - - - - - -
NameResourceNotes
getOrderById/store.{format}/order/{orderId}Find purchase order by ID
deleteOrder/store.{format}/order/{orderId}Delete purchase order by ID
placeOrder/store.{format}/orderPlace an order for a pet
-
- - diff --git a/samples/docs/swagger-static-docs/sd/operations/PetApi.html b/samples/docs/swagger-static-docs/sd/operations/PetApi.html deleted file mode 100644 index ac5505201b3..00000000000 --- a/samples/docs/swagger-static-docs/sd/operations/PetApi.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - - - - REST API v1.1 Resources | Twitter Developers - - -
-
-

-
-
- -
-

PetApi

- -

getPetById

-

GET: /pet.{format}/{petId}

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
petId
required
pathstring*PetID of pet that needs to be fetched
- -

addPet

-

POST: /pet.{format}

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
body
required
bodyPet*-Pet object that needs to be added to the store
- -

updatePet

-

PUT: /pet.{format}

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
body
required
bodyPet*-Pet object that needs to be updated in the store
- -

findPetsByStatus

-

GET: /pet.{format}/findByStatus

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
status
required
querystring*List[Pet]Status values that need to be considered for filter
- -

findPetsByTags

-

GET: /pet.{format}/findByTags

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
tags
required
querystring*List[Pet]Tags to filter by
-
- - - diff --git a/samples/docs/swagger-static-docs/sd/operations/StoreApi.html b/samples/docs/swagger-static-docs/sd/operations/StoreApi.html deleted file mode 100644 index 88e9a0a3abd..00000000000 --- a/samples/docs/swagger-static-docs/sd/operations/StoreApi.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - - - REST API v1.1 Resources | Twitter Developers - - -
-
-

-
-
- -
-

StoreApi

- -

getOrderById

-

GET: /store.{format}/order/{orderId}

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
orderId
required
pathstring*OrderID of pet that needs to be fetched
- -

deleteOrder

-

DELETE: /store.{format}/order/{orderId}

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
orderId
required
pathstring*-ID of the order that needs to be deleted
- -

placeOrder

-

POST: /store.{format}/order

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
body
required
bodyOrder*-order placed for purchasing the pet
-
- - - diff --git a/samples/docs/swagger-static-docs/sd/operations/UserApi.html b/samples/docs/swagger-static-docs/sd/operations/UserApi.html deleted file mode 100644 index 57f82e233cf..00000000000 --- a/samples/docs/swagger-static-docs/sd/operations/UserApi.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - - - - - - - REST API v1.1 Resources | Twitter Developers - - -
-
-

-
-
- -
-

UserApi

- -

createUsersWithArrayInput

-

POST: /user.{format}/createWithArray

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
body
required
bodyArray[User]*-List of user object
- -

createUser

-

POST: /user.{format}

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
body
required
bodyUser*-Created user object
- -

createUsersWithListInput

-

POST: /user.{format}/createWithList

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
body
required
bodyList[User]*-List of user object
- -

updateUser

-

PUT: /user.{format}/{username}

- - - - - - - - - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
body
required
bodyUser*-Updated user object
username
required
pathstring*-name that need to be deleted
- -

deleteUser

-

DELETE: /user.{format}/{username}

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
username
required
pathstring*-The name that needs to be deleted
- -

getUserByName

-

GET: /user.{format}/{username}

- - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
username
required
pathstring*UserThe name that needs to be fetched. Use user1 for testing.
- -

loginUser

-

GET: /user.{format}/login

- - - - - - - - - - - - - - - - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
username
required
querystring*stringThe user name for login
password
required
querystring*stringThe password for login in clear text
- -

logoutUser

-

GET: /user.{format}/logout

- - - - - - - - - - - - -
parameterparam typedata typeresponse typeDescription
-
- - - diff --git a/samples/docs/swagger-static-docs/src/main/webapp/Category.html b/samples/docs/swagger-static-docs/src/main/webapp/Category.html new file mode 100644 index 00000000000..be8e8dd0f30 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/Category.html @@ -0,0 +1,6 @@ +package . + +case class Category ( + id: long, + name: string) + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/Order.html b/samples/docs/swagger-static-docs/src/main/webapp/Order.html new file mode 100644 index 00000000000..bbce3d811f9 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/Order.html @@ -0,0 +1,11 @@ +package . + +import ..Date +case class Order ( + id: long, + petId: long, + /* Order Status */ + status: string, + quantity: int, + shipDate: Date) + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/Pet.html b/samples/docs/swagger-static-docs/src/main/webapp/Pet.html new file mode 100644 index 00000000000..d855a15af70 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/Pet.html @@ -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) + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/Tag.html b/samples/docs/swagger-static-docs/src/main/webapp/Tag.html new file mode 100644 index 00000000000..fbdd332a4c1 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/Tag.html @@ -0,0 +1,6 @@ +package . + +case class Tag ( + id: long, + name: string) + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/User.html b/samples/docs/swagger-static-docs/src/main/webapp/User.html new file mode 100644 index 00000000000..f5b92dfe647 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/User.html @@ -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) + diff --git a/samples/docs/swagger-static-docs/sd/assets/css/bootstrap-responsive.css b/samples/docs/swagger-static-docs/src/main/webapp/assets/css/bootstrap-responsive.css similarity index 100% rename from samples/docs/swagger-static-docs/sd/assets/css/bootstrap-responsive.css rename to samples/docs/swagger-static-docs/src/main/webapp/assets/css/bootstrap-responsive.css diff --git a/samples/docs/swagger-static-docs/sd/assets/css/bootstrap.css b/samples/docs/swagger-static-docs/src/main/webapp/assets/css/bootstrap.css similarity index 100% rename from samples/docs/swagger-static-docs/sd/assets/css/bootstrap.css rename to samples/docs/swagger-static-docs/src/main/webapp/assets/css/bootstrap.css diff --git a/samples/docs/swagger-static-docs/src/main/webapp/assets/css/style.css b/samples/docs/swagger-static-docs/src/main/webapp/assets/css/style.css new file mode 100644 index 00000000000..b26d2ef13ca --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/assets/css/style.css @@ -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; +} \ No newline at end of file diff --git a/samples/docs/swagger-static-docs/sd/assets/images/logo.png b/samples/docs/swagger-static-docs/src/main/webapp/assets/images/logo.png similarity index 100% rename from samples/docs/swagger-static-docs/sd/assets/images/logo.png rename to samples/docs/swagger-static-docs/src/main/webapp/assets/images/logo.png diff --git a/samples/docs/swagger-static-docs/sd/assets/js/bootstrap.js b/samples/docs/swagger-static-docs/src/main/webapp/assets/js/bootstrap.js similarity index 100% rename from samples/docs/swagger-static-docs/sd/assets/js/bootstrap.js rename to samples/docs/swagger-static-docs/src/main/webapp/assets/js/bootstrap.js diff --git a/samples/docs/swagger-static-docs/sd/assets/js/jquery-1.8.3.min.js b/samples/docs/swagger-static-docs/src/main/webapp/assets/js/jquery-1.8.3.min.js similarity index 100% rename from samples/docs/swagger-static-docs/sd/assets/js/jquery-1.8.3.min.js rename to samples/docs/swagger-static-docs/src/main/webapp/assets/js/jquery-1.8.3.min.js diff --git a/samples/docs/swagger-static-docs/src/main/webapp/assets/js/main.js b/samples/docs/swagger-static-docs/src/main/webapp/assets/js/main.js new file mode 100644 index 00000000000..d80666acad2 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/assets/js/main.js @@ -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 = $('
').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); + } +} + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/index.html b/samples/docs/swagger-static-docs/src/main/webapp/index.html new file mode 100644 index 00000000000..556b297b5d3 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/index.html @@ -0,0 +1,106 @@ + + + + + + + + + + + + REST API Resources + + +
+ +
+
+
+
+ +
+
+

Getting Started

+

To begin using your fancy HTTP API, follow the steps below.

+

You can add some helpful tips, here

+
+
+
+ + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/ApiTokenStatus.html b/samples/docs/swagger-static-docs/src/main/webapp/models/ApiTokenStatus.html new file mode 100644 index 00000000000..b4a95172d34 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/ApiTokenStatus.html @@ -0,0 +1,32 @@ +

ApiTokenStatus

+ + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/AudioFile.html b/samples/docs/swagger-static-docs/src/main/webapp/models/AudioFile.html new file mode 100644 index 00000000000..c1a690fe023 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/AudioFile.html @@ -0,0 +1,72 @@ +

AudioFile

+ + + + + + + + + + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/AuthenticationToken.html b/samples/docs/swagger-static-docs/src/main/webapp/models/AuthenticationToken.html new file mode 100644 index 00000000000..8e196cc9090 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/AuthenticationToken.html @@ -0,0 +1,17 @@ +

AuthenticationToken

+ + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Bigram.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Bigram.html new file mode 100644 index 00000000000..73b29fda58b --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Bigram.html @@ -0,0 +1,27 @@ +

Bigram

+ + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Category.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Category.html new file mode 100644 index 00000000000..06219f8a695 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Category.html @@ -0,0 +1,12 @@ +

Category

+ + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Citation.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Citation.html new file mode 100644 index 00000000000..0d0db9cd063 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Citation.html @@ -0,0 +1,12 @@ +

Citation

+ + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/ContentProvider.html b/samples/docs/swagger-static-docs/src/main/webapp/models/ContentProvider.html new file mode 100644 index 00000000000..64a6ebbf313 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/ContentProvider.html @@ -0,0 +1,12 @@ +

ContentProvider

+ + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Definition.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Definition.html new file mode 100644 index 00000000000..b59e5d06467 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Definition.html @@ -0,0 +1,82 @@ +

Definition

+ + + + + + + + + + + + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/DefinitionSearchResults.html b/samples/docs/swagger-static-docs/src/main/webapp/models/DefinitionSearchResults.html new file mode 100644 index 00000000000..ea9c6961a86 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/DefinitionSearchResults.html @@ -0,0 +1,12 @@ +

DefinitionSearchResults

+ + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Example.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Example.html new file mode 100644 index 00000000000..59ab5d8ebb2 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Example.html @@ -0,0 +1,62 @@ +

Example

+ + + + + + + + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/ExampleSearchResults.html b/samples/docs/swagger-static-docs/src/main/webapp/models/ExampleSearchResults.html new file mode 100644 index 00000000000..852ad634255 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/ExampleSearchResults.html @@ -0,0 +1,12 @@ +

ExampleSearchResults

+ + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/ExampleUsage.html b/samples/docs/swagger-static-docs/src/main/webapp/models/ExampleUsage.html new file mode 100644 index 00000000000..86ff72aa6b8 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/ExampleUsage.html @@ -0,0 +1,7 @@ +

ExampleUsage

+ + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Facet.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Facet.html new file mode 100644 index 00000000000..ab7bf33de96 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Facet.html @@ -0,0 +1,12 @@ +

Facet

+ + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/FacetValue.html b/samples/docs/swagger-static-docs/src/main/webapp/models/FacetValue.html new file mode 100644 index 00000000000..98fb091327b --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/FacetValue.html @@ -0,0 +1,12 @@ +

FacetValue

+ + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Frequency.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Frequency.html new file mode 100644 index 00000000000..c987902b73b --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Frequency.html @@ -0,0 +1,12 @@ +

Frequency

+ + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/FrequencySummary.html b/samples/docs/swagger-static-docs/src/main/webapp/models/FrequencySummary.html new file mode 100644 index 00000000000..10b3aee5a51 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/FrequencySummary.html @@ -0,0 +1,27 @@ +

FrequencySummary

+ + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Label.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Label.html new file mode 100644 index 00000000000..4aec69d3aab --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Label.html @@ -0,0 +1,12 @@ +

Label

+ + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Note.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Note.html new file mode 100644 index 00000000000..50250763db7 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Note.html @@ -0,0 +1,22 @@ +

Note

+ + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Order.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Order.html new file mode 100644 index 00000000000..087c85c8374 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Order.html @@ -0,0 +1,27 @@ +

Order

+ + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Pet.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Pet.html new file mode 100644 index 00000000000..9cfcee481f6 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Pet.html @@ -0,0 +1,32 @@ +

Pet

+ + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Related.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Related.html new file mode 100644 index 00000000000..506fae62732 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Related.html @@ -0,0 +1,37 @@ +

Related

+ + + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/ScoredWord.html b/samples/docs/swagger-static-docs/src/main/webapp/models/ScoredWord.html new file mode 100644 index 00000000000..ba573de2b46 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/ScoredWord.html @@ -0,0 +1,57 @@ +

ScoredWord

+ + + + + + + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/ScrabbleScoreResult.html b/samples/docs/swagger-static-docs/src/main/webapp/models/ScrabbleScoreResult.html new file mode 100644 index 00000000000..c64e8d6b43a --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/ScrabbleScoreResult.html @@ -0,0 +1,7 @@ +

ScrabbleScoreResult

+ + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Sentence.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Sentence.html new file mode 100644 index 00000000000..029f07fccc3 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Sentence.html @@ -0,0 +1,32 @@ +

Sentence

+ + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/SimpleDefinition.html b/samples/docs/swagger-static-docs/src/main/webapp/models/SimpleDefinition.html new file mode 100644 index 00000000000..40507c65bc9 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/SimpleDefinition.html @@ -0,0 +1,22 @@ +

SimpleDefinition

+ + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/SimpleExample.html b/samples/docs/swagger-static-docs/src/main/webapp/models/SimpleExample.html new file mode 100644 index 00000000000..0f84a12b72d --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/SimpleExample.html @@ -0,0 +1,22 @@ +

SimpleExample

+ + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/StringValue.html b/samples/docs/swagger-static-docs/src/main/webapp/models/StringValue.html new file mode 100644 index 00000000000..8bdf3cd6638 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/StringValue.html @@ -0,0 +1,7 @@ +

StringValue

+ + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Syllable.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Syllable.html new file mode 100644 index 00000000000..873a5acab28 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Syllable.html @@ -0,0 +1,17 @@ +

Syllable

+ + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/Tag.html b/samples/docs/swagger-static-docs/src/main/webapp/models/Tag.html new file mode 100644 index 00000000000..3857894cf5a --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/Tag.html @@ -0,0 +1,12 @@ +

Tag

+ + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/TextPron.html b/samples/docs/swagger-static-docs/src/main/webapp/models/TextPron.html new file mode 100644 index 00000000000..2bbe48da208 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/TextPron.html @@ -0,0 +1,17 @@ +

TextPron

+ + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/User.html b/samples/docs/swagger-static-docs/src/main/webapp/models/User.html new file mode 100644 index 00000000000..abadf4eb671 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/User.html @@ -0,0 +1,42 @@ +

User

+ + + + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/WordList.html b/samples/docs/swagger-static-docs/src/main/webapp/models/WordList.html new file mode 100644 index 00000000000..eb4b36d2adf --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/WordList.html @@ -0,0 +1,57 @@ +

WordList

+ + + + + + + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/WordListWord.html b/samples/docs/swagger-static-docs/src/main/webapp/models/WordListWord.html new file mode 100644 index 00000000000..e26a788adc1 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/WordListWord.html @@ -0,0 +1,37 @@ +

WordListWord

+ + + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/WordObject.html b/samples/docs/swagger-static-docs/src/main/webapp/models/WordObject.html new file mode 100644 index 00000000000..680e45b0ab8 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/WordObject.html @@ -0,0 +1,32 @@ +

WordObject

+ + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/WordOfTheDay.html b/samples/docs/swagger-static-docs/src/main/webapp/models/WordOfTheDay.html new file mode 100644 index 00000000000..094aae75419 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/WordOfTheDay.html @@ -0,0 +1,62 @@ +

WordOfTheDay

+ + + + + + + + + + + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/WordSearchResult.html b/samples/docs/swagger-static-docs/src/main/webapp/models/WordSearchResult.html new file mode 100644 index 00000000000..14a5e376be8 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/WordSearchResult.html @@ -0,0 +1,17 @@ +

WordSearchResult

+ + + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/models/WordSearchResults.html b/samples/docs/swagger-static-docs/src/main/webapp/models/WordSearchResults.html new file mode 100644 index 00000000000..14e7fe44ce6 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/models/WordSearchResults.html @@ -0,0 +1,12 @@ +

WordSearchResults

+ + + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/operations/AccountApi.html b/samples/docs/swagger-static-docs/src/main/webapp/operations/AccountApi.html new file mode 100644 index 00000000000..115d36279c7 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/operations/AccountApi.html @@ -0,0 +1,119 @@ +
+

AccountApi

+

This is the AccountApi API

+ +

authenticate

+
+

+

URL

+ http://api.wordnik.com/v4/account.{format}/authenticate/{username} +

HTTP Method

+ GET +

Response Type

+ +

Parameters

+
    +
    +
    username : string (path)
    + +
    +

    A confirmed Wordnik username

    +
+
+
password : string (query)
+ +
+

The user's password

+
+ +

authenticatePost

+
+

+

URL

+ http://api.wordnik.com/v4/account.{format}/authenticate/{username} +

HTTP Method

+ POST +

Response Type

+
AuthenticationToken
+

Parameters

+
+
+
body : string (body)
+ +
+

The user's password

+ + +

getWordListsForLoggedInUser

+
+

+

URL

+ http://api.wordnik.com/v4/account.{format}/wordLists +

HTTP Method

+ GET +

Response Type

+
List[WordList]
+

Parameters

+ +

getApiTokenStatus

+
+

+

URL

+ http://api.wordnik.com/v4/account.{format}/apiTokenStatus +

HTTP Method

+ GET +

Response Type

+
ApiTokenStatus
+

Parameters

+ +

getLoggedInUser

+
+

+

Requires a valid auth_token to be set.

URL

+ http://api.wordnik.com/v4/account.{format}/user +

HTTP Method

+ GET +

Response Type

+
User
+

Parameters

+ + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/operations/PetApi.html b/samples/docs/swagger-static-docs/src/main/webapp/operations/PetApi.html new file mode 100644 index 00000000000..f7fd1f1fe01 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/operations/PetApi.html @@ -0,0 +1,95 @@ +
+

PetApi

+

This is the PetApi API

+ +

getPetById

+
+

+

Returns a pet based on ID

URL

+ http://petstore.swagger.wordnik.com/api/pet.{format}/{petId} +

HTTP Method

+ GET +

Response Type

+
Pet
+

Parameters

+
+ +

addPet

+
+

+

URL

+ http://petstore.swagger.wordnik.com/api/pet.{format} +

HTTP Method

+ POST +

Response Type

+
+

Parameters

+ +

updatePet

+
+

+

URL

+ http://petstore.swagger.wordnik.com/api/pet.{format} +

HTTP Method

+ PUT +

Response Type

+
+

Parameters

+ +

findPetsByStatus

+
+

+

Multiple status values can be provided with comma seperated strings

URL

+ http://petstore.swagger.wordnik.com/api/pet.{format}/findByStatus +

HTTP Method

+ GET +

Response Type

+
List[Pet]
+

Parameters

+ +

findPetsByTags

+
+

+

Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.

URL

+ http://petstore.swagger.wordnik.com/api/pet.{format}/findByTags +

HTTP Method

+ GET +

Response Type

+
List[Pet]
+

Parameters

+ + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/operations/StoreApi.html b/samples/docs/swagger-static-docs/src/main/webapp/operations/StoreApi.html new file mode 100644 index 00000000000..b9ed2bb331e --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/operations/StoreApi.html @@ -0,0 +1,59 @@ +
+

StoreApi

+

This is the StoreApi API

+ +

getOrderById

+
+

+

For valid response try integer IDs with value <= 5. Anything above 5 or nonintegers will generate API errors

URL

+ http://petstore.swagger.wordnik.com/api/store.{format}/order/{orderId} +

HTTP Method

+ GET +

Response Type

+
Order
+

Parameters

+
+ +

deleteOrder

+
+

+

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

URL

+ http://petstore.swagger.wordnik.com/api/store.{format}/order/{orderId} +

HTTP Method

+ DELETE +

Response Type

+
+

Parameters

+ +

placeOrder

+
+

+

URL

+ http://petstore.swagger.wordnik.com/api/store.{format}/order +

HTTP Method

+ POST +

Response Type

+
+

Parameters

+ + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/operations/UserApi.html b/samples/docs/swagger-static-docs/src/main/webapp/operations/UserApi.html new file mode 100644 index 00000000000..12c87561a83 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/operations/UserApi.html @@ -0,0 +1,155 @@ +
+

UserApi

+

This is the UserApi API

+ +

createUsersWithArrayInput

+
+

+

URL

+ http://petstore.swagger.wordnik.com/api/user.{format}/createWithArray +

HTTP Method

+ POST +

Response Type

+
+

Parameters

+ +

createUser

+
+

+

This can only be done by the logged in user.

URL

+ http://petstore.swagger.wordnik.com/api/user.{format} +

HTTP Method

+ POST +

Response Type

+
+

Parameters

+ +

createUsersWithListInput

+
+

+

URL

+ http://petstore.swagger.wordnik.com/api/user.{format}/createWithList +

HTTP Method

+ POST +

Response Type

+
+

Parameters

+ +

updateUser

+
+

+

This can only be done by the logged in user.

URL

+ http://petstore.swagger.wordnik.com/api/user.{format}/{username} +

HTTP Method

+ PUT +

Response Type

+
+

Parameters

+
+
+
body :  
User(body)
+ +
+

Updated user object

+
+ +

deleteUser

+
+

+

This can only be done by the logged in user.

URL

+ http://petstore.swagger.wordnik.com/api/user.{format}/{username} +

HTTP Method

+ DELETE +

Response Type

+
+

Parameters

+ +

getUserByName

+
+

+

URL

+ http://petstore.swagger.wordnik.com/api/user.{format}/{username} +

HTTP Method

+ GET +

Response Type

+
User
+

Parameters

+ +

loginUser

+
+

+

URL

+ http://petstore.swagger.wordnik.com/api/user.{format}/login +

HTTP Method

+ GET +

Response Type

+
string
+

Parameters

+ +

logoutUser

+
+

+

URL

+ http://petstore.swagger.wordnik.com/api/user.{format}/logout +

HTTP Method

+ GET +

Response Type

+
+

Parameters

+ + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/operations/WordApi.html b/samples/docs/swagger-static-docs/src/main/webapp/operations/WordApi.html new file mode 100644 index 00000000000..df5116b2702 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/operations/WordApi.html @@ -0,0 +1,413 @@ +
+

WordApi

+

This is the WordApi API

+ +

getExamples

+
+

+

URL

+ http://api.wordnik.com/v4/word.{format}/{word}/examples +

HTTP Method

+ GET +

Response Type

+
ExampleSearchResults
+

Parameters

+
+
+
includeDuplicates : string (query)
+ optional +
+

Show duplicate examples from different sources

+ +
+
useCanonical : string (query)
+ optional +
+

If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.

+ +
+
skip : int (query)
+ optional +
+

Results to skip

+ +
+
limit : int (query)
+ optional +
+

Maximum number of results to return

+ + +

getWord

+
+

+

URL

+ http://api.wordnik.com/v4/word.{format}/{word} +

HTTP Method

+ GET +

Response Type

+
WordObject
+

Parameters

+ +

getDefinitions

+
+

+

URL

+ http://api.wordnik.com/v4/word.{format}/{word}/definitions +

HTTP Method

+ GET +

Response Type

+
List[Definition]
+

Parameters

+ +

getTopExample

+
+

+

URL

+ http://api.wordnik.com/v4/word.{format}/{word}/topExample +

HTTP Method

+ GET +

Response Type

+
Example
+

Parameters

+ +

getRelatedWords

+
+

+

URL

+ http://api.wordnik.com/v4/word.{format}/{word}/relatedWords +

HTTP Method

+ GET +

Response Type

+ +

Parameters

+ +

getTextPronunciations

+
+

+

URL

+ http://api.wordnik.com/v4/word.{format}/{word}/pronunciations +

HTTP Method

+ GET +

Response Type

+
List[TextPron]
+

Parameters

+ +

getHyphenation

+
+

+

URL

+ http://api.wordnik.com/v4/word.{format}/{word}/hyphenation +

HTTP Method

+ GET +

Response Type

+
List[Syllable]
+

Parameters

+ +

getWordFrequency

+
+

+

URL

+ http://api.wordnik.com/v4/word.{format}/{word}/frequency +

HTTP Method

+ GET +

Response Type

+
FrequencySummary
+

Parameters

+ +

getPhrases

+
+

+

URL

+ http://api.wordnik.com/v4/word.{format}/{word}/phrases +

HTTP Method

+ GET +

Response Type

+
List[Bigram]
+

Parameters

+ +

getEtymologies

+
+

+

URL

+ http://api.wordnik.com/v4/word.{format}/{word}/etymologies +

HTTP Method

+ GET +

Response Type

+
List[string]
+

Parameters

+ +

getAudio

+
+

+

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.

URL

+ http://api.wordnik.com/v4/word.{format}/{word}/audio +

HTTP Method

+ GET +

Response Type

+
List[AudioFile]
+

Parameters

+ +

getScrabbleScore

+
+

+

URL

+ http://api.wordnik.com/v4/word.{format}/{word}/scrabbleScore +

HTTP Method

+ GET +

Response Type

+
ScrabbleScoreResult
+

Parameters

+ + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/operations/WordListApi.html b/samples/docs/swagger-static-docs/src/main/webapp/operations/WordListApi.html new file mode 100644 index 00000000000..8cdd4ca5864 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/operations/WordListApi.html @@ -0,0 +1,191 @@ +
+

WordListApi

+

This is the WordListApi API

+ +

updateWordList

+
+

+

URL

+ http://api.wordnik.com/v4/wordList.{format}/{permalink} +

HTTP Method

+ PUT +

Response Type

+
+

Parameters

+
+
+
body :  
WordList (body)
+ optional +
+

Updated WordList

+
+
+
auth_token : string (header)
+ +
+

The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)

+ + +

deleteWordList

+
+

+

URL

+ http://api.wordnik.com/v4/wordList.{format}/{permalink} +

HTTP Method

+ DELETE +

Response Type

+
+

Parameters

+ +

getWordListByPermalink

+
+

+

URL

+ http://api.wordnik.com/v4/wordList.{format}/{permalink} +

HTTP Method

+ GET +

Response Type

+
WordList
+

Parameters

+ +

addWordsToWordList

+
+

+

URL

+ http://api.wordnik.com/v4/wordList.{format}/{permalink}/words +

HTTP Method

+ POST +

Response Type

+
+

Parameters

+ +

getWordListWords

+
+

+

URL

+ http://api.wordnik.com/v4/wordList.{format}/{permalink}/words +

HTTP Method

+ GET +

Response Type

+
List[WordListWord]
+

Parameters

+ +

deleteWordsFromWordList

+
+

+

URL

+ http://api.wordnik.com/v4/wordList.{format}/{permalink}/deleteWords +

HTTP Method

+ POST +

Response Type

+
+

Parameters

+ + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/operations/WordListsApi.html b/samples/docs/swagger-static-docs/src/main/webapp/operations/WordListsApi.html new file mode 100644 index 00000000000..d2f0601758d --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/operations/WordListsApi.html @@ -0,0 +1,29 @@ +
+

WordListsApi

+

This is the WordListsApi API

+ +

createWordList

+
+

+

URL

+ http://api.wordnik.com/v4/wordLists.{format} +

HTTP Method

+ POST +

Response Type

+
WordList
+

Parameters

+
+ + diff --git a/samples/docs/swagger-static-docs/src/main/webapp/operations/WordsApi.html b/samples/docs/swagger-static-docs/src/main/webapp/operations/WordsApi.html new file mode 100644 index 00000000000..70ff66c20b6 --- /dev/null +++ b/samples/docs/swagger-static-docs/src/main/webapp/operations/WordsApi.html @@ -0,0 +1,365 @@ +
+

WordsApi

+

This is the WordsApi API

+ +

searchWords

+
+

+

URL

+ http://api.wordnik.com/v4/words.{format}/search/{query} +

HTTP Method

+ GET +

Response Type

+
WordSearchResults
+

Parameters

+
+
+
includePartOfSpeech : string (query)
+ optional +
+

Only include these comma-delimited parts of speech

+ +
+
excludePartOfSpeech : string (query)
+ optional +
+

Exclude these comma-delimited parts of speech

+ +
+
caseSensitive : string (query)
+ optional +
+

Search case sensitive

+ +
+
minCorpusCount : int (query)
+ optional +
+

Minimum corpus frequency for terms

+ +
+
maxCorpusCount : int (query)
+ optional +
+

Maximum corpus frequency for terms

+ +
+
minDictionaryCount : int (query)
+ optional +
+

Minimum number of dictionary entries for words returned

+ +
+
maxDictionaryCount : int (query)
+ optional +
+

Maximum dictionary definition count

+ +
+
minLength : int (query)
+ optional +
+

Minimum word length

+ +
+
maxLength : int (query)
+ optional +
+

Maximum word length

+ +
+
skip : int (query)
+ optional +
+

Results to skip

+ +
+
limit : int (query)
+ optional +
+

Maximum number of results to return

+ + +

getWordOfTheDay

+
+

+

URL

+ http://api.wordnik.com/v4/words.{format}/wordOfTheDay +

HTTP Method

+ GET +

Response Type

+
WordOfTheDay
+

Parameters

+ +

reverseDictionary

+
+

+

URL

+ http://api.wordnik.com/v4/words.{format}/reverseDictionary +

HTTP Method

+ GET +

Response Type

+
DefinitionSearchResults
+

Parameters

+ +

getRandomWords

+
+

+

URL

+ http://api.wordnik.com/v4/words.{format}/randomWords +

HTTP Method

+ GET +

Response Type

+
List[WordObject]
+

Parameters

+ +

getRandomWord

+
+

+

URL

+ http://api.wordnik.com/v4/words.{format}/randomWord +

HTTP Method

+ GET +

Response Type

+
WordObject
+

Parameters

+ +