Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
#%RAML 1.0
title: Users
version: v1
baseUri: http://github.com/org/folio/mod-users
documentation:
- title: mod-users API
content: This documents the API calls that can be made to query and manage users of the system
types:
user: !include userdata.json
userdataCollection: !include userdataCollection.json
errors: !include raml-util/schemas/errors.schema
traits:
orderable: !include raml-util/traits/orderable.raml
pageable: !include raml-util/traits/pageable.raml
searchable: !include raml-util/traits/searchable.raml
language: !include raml-util/traits/language.raml
validate: !include raml-util/traits/validation.raml
facets: !include raml-util/traits/facets.raml
resourceTypes:
collection: !include raml-util/rtypes/collection.raml
collection-item: !include raml-util/rtypes/item-collection.raml
get-only: !include raml-util/rtypes/get-only.raml
post-empty-body: !include raml-util/rtypes/post-empty-body.raml
/users:
type:
collection:
exampleCollection: !include examples/user_collection.sample
exampleItem: !include examples/user.sample
schemaCollection: userdataCollection
schemaItem: user
get:
is: [
searchable: {description: "", example: "active=true sortBy username"},
orderable: {fieldsList: "field A, field B"},
pageable,
facets
]
description: Return a list of users
post:
is: [validate]
description: Create a user
/{userId}:
type:
collection-item:
exampleItem: !include examples/user.sample
schema: user
get:
description: Get a single user
/expire/timer:
post:
description: Expire timer (timer event)
responses:
204:
description: Expired ok
400:
description: User Error
body:
text/plain:
500:
description: Internal error
body:
text/plain: