GET /api/bookmarks
List all bookmarks

Params

Param name Description
search
optional

filter results

Validations:

  • Must be a String

order
optional

sort results

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

number of entries per request

Validations:

  • Must be a String


GET /api/bookmarks/:id
Show a bookmark

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/bookmarks
Create a bookmark

Params

Param name Description
bookmark
required

Validations:

  • Must be a Hash

bookmark[name]
required

Validations:

  • Must be a String

bookmark[controller]
required

Validations:

  • Must be a String

bookmark[query]
required

Validations:

  • Must be a String

bookmark[public]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0


PUT /api/bookmarks/:id
Update a bookmark

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

bookmark
required

Validations:

  • Must be a Hash

bookmark[name]
optional

Validations:

  • Must be a String

bookmark[controller]
optional

Validations:

  • Must be a String

bookmark[query]
optional

Validations:

  • Must be a String

bookmark[public]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0


DELETE /api/bookmarks/:id
Delete a bookmark

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.