View Source SwagdoxWeb.OrderController (swagdox v0.1.0)

Summary

Functions

Creates an Order.

Deletes an Order.

Returns a list of Orders

Returns an Order.

Functions

@spec create(any(), map()) :: nil

Creates an Order.

[Swagdox] API: @param order(body), object, "Order attributes", required: true

@response 201, OrderName, "Order created" @response 400, "Invalid order attributes"

@security ApiKey, [write]

@spec delete(any(), map()) :: nil

Deletes an Order.

[Swagdox] API: @param id(path), integer, "Order ID", required: true

@response 204, "Order deleted" @response 403, "Order not authorized" @response 404, "Order not found"

@security ApiKey, [write]

@spec index(any(), map()) :: nil

Returns a list of Orders

[Swagdox] API: @response 200, [OrderName], "Orders found" @response 403, "Orders not authorized"

@security ApiKey, [read]

@spec show(any(), map()) :: nil

Returns an Order.

[Swagdox] API: @param id(path), integer, "Order ID", required: true

@response 200, OrderName, "Order found" @response 403, "Order not authorized" @response 404, "Order not found"

@security ApiKey, [read]