Package: service@1.0.0

Packages

Services

MyService

HUGE Example Service

GET /v1/foo

Search for a list of foos.

POST /v1/foo

Create a new foo.

DELETE /v1/foo/{id}

Delete the foo with the given ID.

GET /v1/foo/{id}

Get the foo with the current ID.

DELETE /v1/foo/åberg <>

Specifically delete this last name.

MyService service

HUGE Example Service

This is a test to see if the documentation makes any sense.

GET /v1/foo

Search for a list of foos.

This uses method GET because it is good.

Returns

404 text/plain any

resource not found

Something else?
500 application/json ErrorMessage

returned on internal server errors
501 application/json ErrorMessage

other, interesting stuff

POST /v1/foo

Create a new foo.

Accepts

application/json any

Only acceptable when I'm ~drunk~ Sober!

Returns

404 text/plain any

resource not found

Something else?
500 application/json ErrorMessage

returned on internal server errors
501 application/json ErrorMessage

other, interesting stuff

DELETE /v1/foo/{id}

Delete the foo with the given ID.

Returns

302 application/json any

Redirect stuff.
404 text/plain any

resource not found

Something else?
500 application/json ErrorMessage

returned on internal server errors
501 application/json ErrorMessage

other, interesting stuff

GET /v1/foo/{id}

Get the foo with the current ID.

These things cannot do shit.

foo: 1234

Returns

404 text/plain any

resource not found

Something else?
500 application/json ErrorMessage

returned on internal server errors
501 application/json ErrorMessage

other, interesting stuff

DELETE /v1/foo/åberg <>

Specifically delete this last name.

Returns

302 application/json any
404 text/plain any

resource not found

Something else?
500 application/json ErrorMessage

returned on internal server errors
501 application/json ErrorMessage

other, interesting stuff