-
Notifications
You must be signed in to change notification settings - Fork 7
API planning
In the long run DiMe should perhaps follow Principles of good RESTful API Design, for example using PUT
and PATCH
for updating existing objects instead of POST
'ing with the id given. But for now we'll stick with the old way in order to be consistent with the rest of the DiMe API.
Also API versioning should be introduced at some point, e.g. /api/v1
, /api/v2
and so on.
register model (register name, get ID?)
Get list of n most common tags.
GET /api/tag/most_common
[{
id: 38093,
name: "reknow",
eventsCount: 30,
elementsCount: 28,
actors: ["KEA 1.0", "lucene"],
lastAdded: timestamp,
},
]
Get events for tag with given id
GET /api/tag/events/38093
GET /api/tag/informationelements/38093
POST /api/requestPasswordReset
curl -X POST \
-u username:password \
-d '{"email":"[email protected]"}' \
http://<SERVER_HOST>/api/requestPasswordReset
Status: 200 (OK)
{}
Also, backwards compatibility is an issue, since people have not supplied emails earlier
DiMe event count DiMe document count DiMe status, active loggers, API activity (log)