Skip to content

Commit

Permalink
Swagger updates to fix search in swaggerui
Browse files Browse the repository at this point in the history
  • Loading branch information
bradtaylor committed May 8, 2015
1 parent 7bf1b6a commit d4f9419
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 24 deletions.
2 changes: 1 addition & 1 deletion src/main/resources/reference.conf
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ swagger {
info = "Agora Methods Repository"
license = "BSD"
licenseUrl = "http://opensource.org/licenses/BSD-3-Clause"
swaggerVersion = "1.2"
swaggerVersion = "1.3"
termsOfServiceUrl = "http://www.github.com/broadinstitute/agora"
}
30 changes: 15 additions & 15 deletions src/main/scala/org/broadinstitute/dsde/agora/server/model/AgoraEntity.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,38 +49,38 @@ object AgoraAddRequest {
}

@ApiModel(value = "Agora Method")
case class AgoraEntity(@(ApiModelProperty@field)(required = true, value = "The namespace to which the method belongs")
case class AgoraEntity(@(ApiModelProperty@field)(required = false, value = "The namespace to which the method belongs")
namespace: Option[String] = None,
@(ApiModelProperty@field)(required = true, value = "The method name ")
@(ApiModelProperty@field)(required = false, value = "The method name ")
name: Option[String] = None,
@(ApiModelProperty@field)(required = true, value = "The method id")
@(ApiModelProperty@field)(required = false, value = "The method id")
var id: Option[Int] = None,
@(ApiModelProperty@field)(required = true, value = "A short description of the method")
@(ApiModelProperty@field)(required = false, value = "A short description of the method")
synopsis: Option[String] = None,
@(ApiModelProperty@field)(required = true, value = "Method documentation")
@(ApiModelProperty@field)(required = false, value = "Method documentation")
documentation: Option[String] = None,
@(ApiModelProperty@field)(required = true, value = "User who owns this method in the methods repo")
@(ApiModelProperty@field)(required = false, value = "User who owns this method in the methods repo")
owner: Option[String] = None,
@(ApiModelProperty@field)(required = true, value = "The date the method was inserted in the methods repo")
@(ApiModelProperty@field)(required = false, value = "The date the method was inserted in the methods repo")
createDate: Option[Date] = None,
@(ApiModelProperty@field)(required = true, value = "The method payload")
@(ApiModelProperty@field)(required = false, value = "The method payload")
payload: Option[String] = None
)

@ApiModel(value = "Agora Search")
case class AgoraSearch(@(ApiModelProperty@field)(required = true, value = "The namespace to which the method belongs")
case class AgoraSearch(@(ApiModelProperty@field)(required = false, value = "The namespace to which the method belongs")
namespace: Option[String] = None,
@(ApiModelProperty@field)(required = true, value = "The method name ")
@(ApiModelProperty@field)(required = false, value = "The method name ")
name: Option[String] = None,
@(ApiModelProperty@field)(required = true, value = "The method id")
@(ApiModelProperty@field)(required = false, value = "The method id")
var id: Option[Int] = None,
@(ApiModelProperty@field)(required = true, value = "User who owns this method in the methods repo")
@(ApiModelProperty@field)(required = false, value = "User who owns this method in the methods repo")
owner: Option[String] = None,
@(ApiModelProperty@field)(required = true, value = "A short description of the method")
@(ApiModelProperty@field)(required = false, value = "A short description of the method")
synopsis: Option[String] = None,
@(ApiModelProperty@field)(required = true, value = "Method documentation")
@(ApiModelProperty@field)(required = false, value = "Method documentation")
documentation: Option[String] = None,
@(ApiModelProperty@field)(required = true, value = "The method payload")
@(ApiModelProperty@field)(required = false, value = "The method payload")
payload: Option[String] = None
)

Expand Down
17 changes: 9 additions & 8 deletions src/main/scala/org/broadinstitute/dsde/agora/server/webservice/methods/MethodsService.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,17 @@ trait MethodsService extends HttpService with PerRequestCreator {
nickname = "methods",
httpMethod = "GET",
produces = "application/json",
response = classOf[Seq[AgoraEntity]],
response = classOf[AgoraEntity],
responseContainer="Seq",
notes = "API is rapidly changing.")
@ApiImplicitParams(Array(
new ApiImplicitParam(name = "namespace", required = true, dataType = "string", paramType = "path", value = "Namespace"),
new ApiImplicitParam(name = "name", required = true, dataType = "string", paramType = "path", value = "Name"),
new ApiImplicitParam(name = "id", required = true, dataType = "string", paramType = "path", value = "Id"),
new ApiImplicitParam(name = "synopsis", required = true, dataType = "string", paramType = "path", value = "Synopsis"),
new ApiImplicitParam(name = "documentation", required = true, dataType = "string", paramType = "path", value = "Documentation"),
new ApiImplicitParam(name = "owner", required = true, dataType = "string", paramType = "path", value = "Owner"),
new ApiImplicitParam(name = "payload", required = true, dataType = "string", paramType = "path", value = "Payload")
new ApiImplicitParam(name = "namespace", required = false, dataType = "string", paramType = "query", value = "Namespace"),
new ApiImplicitParam(name = "name", required = false, dataType = "string", paramType = "query", value = "Name"),
new ApiImplicitParam(name = "id", required = false, dataType = "string", paramType = "query", value = "Id"),
new ApiImplicitParam(name = "synopsis", required = false, dataType = "string", paramType = "query", value = "Synopsis"),
new ApiImplicitParam(name = "documentation", required = false, dataType = "string", paramType = "query", value = "Documentation"),
new ApiImplicitParam(name = "owner", required = false, dataType = "string", paramType = "query", value = "Owner"),
new ApiImplicitParam(name = "payload", required = false, dataType = "string", paramType = "query", value = "Payload")
))
@ApiResponses(Array(
new ApiResponse(code = 200, message = "Successful Request"),
Expand Down

0 comments on commit d4f9419

Please sign in to comment.