petstore

Type Members

case class Category(id: Option[Long], name: String) extends Product with Serializable

Represents a Category object for pets.
Represents a Category object for pets. This is the type of animal a pet is.
id
The unique, autogenerated ID of this Category.
name
The name of this Category.
trait ErrorHandling extends AnyRef

Tells the API how to respond when certain exceptions are thrown.
case class InvalidInput(message: String) extends PetstoreError with Product with Serializable

Thrown when the object given is invalid (i.e.
Thrown when the object given is invalid (i.e. A new User or Pet contains an ID)
message
An error message
case class Inventory(available: Int, pending: Int, adopted: Int) extends Product with Serializable

Represents the current state of the Petstore and how many pets are currently of which Status.
case class MissingIdentifier(message: String) extends PetstoreError with Product with Serializable

Thrown when the given object is missing a unique ID.
Thrown when the given object is missing a unique ID.
message
An error message
case class MissingPet(message: String) extends PetstoreError with Product with Serializable

Thrown when a given Pet does not exist in the database.
Thrown when a given Pet does not exist in the database.
message
An error message
case class MissingUser(message: String) extends PetstoreError with Product with Serializable

Thrown when the User given does not exist in the database.
Thrown when the User given does not exist in the database.
message
An error message
case class Order(id: Option[Long], petId: Option[Long], quantity: Option[Long], shipDate: Option[String], status: Option[OrderStatus], complete: Option[Boolean]) extends Product with Serializable

Represents an order to the petstore.
Represents an order to the petstore.
id
The unique, autogenerated ID of the order. The user should never give an ID during Order creation.
petId
The ID of the pet being ordered.
quantity
The number of pets being ordered.
shipDate
The date the order will be shipped by.
status
The status of the order.
complete
Whether the order has been fulfilled.
case class OrderNotFound(message: String) extends PetstoreError with Product with Serializable

Thrown when the given Order does not exist in the database.
Thrown when the given Order does not exist in the database.
message
An error message
sealed trait OrderStatus extends AnyRef

Represents the status of a particular order for pets.
Represents the status of a particular order for pets. Can be "placed," "approved," or "delivered."
case class Pet(id: Option[Long], name: String, photoUrls: Seq[String], category: Option[Category], tags: Option[Seq[Tag]], status: Option[Status]) extends Product with Serializable

Represents Pets in the Petstore.
Represents Pets in the Petstore. Each Pet has a unique ID that should not be known by the user at the time of its creation.
id
The pet's auto-generated, unique ID.
name
(Required) The pet's name.
photoUrls
(Required) A sequence of URLs that lead to uploaded photos of the pet.
category
The type of pet (cat, dragon, fish, etc.)
tags
Tags that describe this pet.
status
(Available, Pending, or Adopted)
class PetstoreApp extends AnyRef

PetstoreApp runs the PetstoreAPI service.
PetstoreApp runs the PetstoreAPI service. It is the hub where all the endpoints that give users access to API methods are connected to the service itself, which is launched on port :8080.
class PetstoreDb extends AnyRef

Provides a great majority of the service methods that allow Users to interact with the Pets in the store and to get information about them.
sealed abstract class PetstoreError extends Exception

The parent error from which most PetstoreAPI errors extend.
The parent error from which most PetstoreAPI errors extend. Thrown whenever something in the api goes wrong.
case class RedundantUsername(message: String) extends PetstoreError with Product with Serializable

Thrown when a new User has the same username as an existing User.
Thrown when a new User has the same username as an existing User. (Usernames must be unique.)
message
An error message
sealed trait Status extends AnyRef

Represents the general status of a Pet.
Represents the general status of a Pet. This should either be Available, Pending, or Adopted.
case class Tag(id: Option[Long], name: String) extends Product with Serializable

Represents a Tag for pets.
Represents a Tag for pets. Tags cannot be passed with user-made, IDs.
id
The unique, autogenerated ID of this Tag.
name
The name of this Tag.
case class User(id: Option[Long], username: String, firstName: Option[String], lastName: Option[String], email: Option[String], password: String, phone: Option[String]) extends Product with Serializable

Represents a User in the system, who can interact with the petstore and purchase available Pet objects.
Represents a User in the system, who can interact with the petstore and purchase available Pet objects.
id
Unique, autogenerated ID of the User
username
(Required)
password
(Required)

Value Members

object Adopted extends Status with Product with Serializable

The status of a Pet when it has been adopted.
object Approved extends OrderStatus with Product with Serializable

The status of an order after it has been approved by the store.
object Available extends Status with Product with Serializable

The status of a Pet when it is available for adoption.
object Category extends Serializable

Provides encoding and decoding methods for Category objects.
object Delivered extends OrderStatus with Product with Serializable

The status of an order after it has been delivered and completed.
object Inventory extends Serializable

Provides a codec for encoding and decoding Inventory objects.
object Order extends Serializable

Provides a codec for encoding and decoding Order objects.
object OrderStatus

Provides encode and decode methods for OrderStatus objects.
Provides encode and decode methods for OrderStatus objects. If asked to decode a string other than "placed," "approved," or "delivered" the system will fail.
object Pending extends Status with Product with Serializable

The status of a Pet when it is pending for adoption, and currently unavailable for purchase.
object Pet extends Serializable

Provides a codec for decoding and encoding Pet objects.
object PetstoreApp extends PetstoreApp with App

Launches the PetstoreAPI service when the system is ready.
object Placed extends OrderStatus with Product with Serializable

The status of an order after it has been placed.
object Status

Provides encoding and decoding methods for Status objects.
Provides encoding and decoding methods for Status objects. When given a string other than "available," "pending," or "adopted," it fails to decode the string to a Status object.
object Tag extends Serializable

Represents a Tag object for pets.
object User extends Serializable

Companion object to the User class.
object endpoint extends ErrorHandling

Provides the paths and endpoints for all the API's public service methods.
object reader

Represents a reader object that helps extract parameters from query params and bodies.

package petstore

Type Members

case class Category(id: Option[Long], name: String) extends Product with Serializable

trait ErrorHandling extends AnyRef

case class InvalidInput(message: String) extends PetstoreError with Product with Serializable

case class Inventory(available: Int, pending: Int, adopted: Int) extends Product with Serializable

case class MissingIdentifier(message: String) extends PetstoreError with Product with Serializable

case class MissingPet(message: String) extends PetstoreError with Product with Serializable

case class MissingUser(message: String) extends PetstoreError with Product with Serializable

case class Order(id: Option[Long], petId: Option[Long], quantity: Option[Long], shipDate: Option[String], status: Option[OrderStatus], complete: Option[Boolean]) extends Product with Serializable

case class OrderNotFound(message: String) extends PetstoreError with Product with Serializable

sealed trait OrderStatus extends AnyRef

case class Pet(id: Option[Long], name: String, photoUrls: Seq[String], category: Option[Category], tags: Option[Seq[Tag]], status: Option[Status]) extends Product with Serializable

class PetstoreApp extends AnyRef

class PetstoreDb extends AnyRef

sealed abstract class PetstoreError extends Exception

case class RedundantUsername(message: String) extends PetstoreError with Product with Serializable

sealed trait Status extends AnyRef

case class Tag(id: Option[Long], name: String) extends Product with Serializable

case class User(id: Option[Long], username: String, firstName: Option[String], lastName: Option[String], email: Option[String], password: String, phone: Option[String]) extends Product with Serializable

Value Members

object Adopted extends Status with Product with Serializable

object Approved extends OrderStatus with Product with Serializable

object Available extends Status with Product with Serializable

object Category extends Serializable

object Delivered extends OrderStatus with Product with Serializable

object Inventory extends Serializable

object Order extends Serializable

object OrderStatus

object Pending extends Status with Product with Serializable

object Pet extends Serializable

object PetstoreApp extends PetstoreApp with App

object Placed extends OrderStatus with Product with Serializable

object Status

object Tag extends Serializable

object User extends Serializable

object endpoint extends ErrorHandling

object reader

Ungrouped