Sample API

Sample api representing an user resource

Default request content-types: application/json

Default response content-types: application/json

Schemes:

Summary

Path	Operation	Description
/users/	GET	Returns a list of users
/users/	POST	Create a new user
/users/{id}	DELETE	Delete an user
	GET	Returns a specific user
	PUT	Update an user

Paths

Returns a list of users

GET /users/

Uses default content-types: application/json

200 OK: Success

User

Create a new user

POST /users/

Uses default content-types: application/json

User

Uses default content-types: application/json

201 Created: Created

User
400 Bad Request: Input error

Delete an user

DELETE /users/{id}


id		path	integer

Uses default content-types: application/json

204 No Content: Success
404 Not Found: User not found

Returns a specific user

GET /users/{id}


id		path	integer

Uses default content-types: application/json

200 OK: Success

User
404 Not Found: User not found

Update an user

PUT /users/{id}

Uses default content-types: application/json

User


id		path	integer

Uses default content-types: application/json

200 OK: Success

User
400 Bad Request: Input error
404 Not Found: User not found

Schema definitions

User: object

id: integer (int64)

name: string

Must be unique

email: string (email)

"me@example.com"

dateJoined: string (date)

permissions: string[]

[
    "READ",
    "CREATE"
]

string , x ∈ { READ , WRITE , CREATE , DELETE }