io.finch

petstore

package petstore

Visibility
  1. Public
  2. All

Type Members

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

    Represents a Category object for pets.

  2. trait ErrorHandling extends AnyRef

    Tells the API how to respond when certain exceptions are thrown.

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

    Thrown when the object given is invalid (i.

  4. 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.

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

    Thrown when the given object is missing a unique ID.

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

    Thrown when a given Pet does not exist in the database.

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

    Thrown when the User given does not exist in the database.

  8. 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.

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

    Thrown when the given Order does not exist in the database.

  10. sealed trait OrderStatus extends AnyRef

    Represents the status of a particular order for pets.

  11. 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.

  12. class PetstoreApp extends AnyRef

    PetstoreApp runs the PetstoreAPI service.

  13. 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.

  14. sealed abstract class PetstoreError extends Exception

    The parent error from which most PetstoreAPI errors extend.

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

    Thrown when a new User has the same username as an existing User.

  16. sealed trait Status extends AnyRef

    Represents the general status of a Pet.

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

    Represents a Tag for pets.

  18. 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.

Value Members

  1. object Adopted extends Status with Product with Serializable

    The status of a Pet when it has been adopted.

  2. object Approved extends OrderStatus with Product with Serializable

    The status of an order after it has been approved by the store.

  3. object Available extends Status with Product with Serializable

    The status of a Pet when it is available for adoption.

  4. object Category extends Serializable

    Provides encoding and decoding methods for Category objects.

  5. object Delivered extends OrderStatus with Product with Serializable

    The status of an order after it has been delivered and completed.

  6. object Inventory extends Serializable

    Provides a codec for encoding and decoding Inventory objects.

  7. object Order extends Serializable

    Provides a codec for encoding and decoding Order objects.

  8. object OrderStatus

    Provides encode and decode methods for OrderStatus objects.

  9. object Pending extends Status with Product with Serializable

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

  10. object Pet extends Serializable

    Provides a codec for decoding and encoding Pet objects.

  11. object PetstoreApp extends PetstoreApp with App

    Launches the PetstoreAPI service when the system is ready.

  12. object Placed extends OrderStatus with Product with Serializable

    The status of an order after it has been placed.

  13. object Status

    Provides encoding and decoding methods for Status objects.

  14. object Tag extends Serializable

    Represents a Tag object for pets.

  15. object User extends Serializable

    Companion object to the User class.

  16. object endpoint extends ErrorHandling

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

  17. object reader

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

Ungrouped