REST API Rework
#176
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
{{ message }}
-
Let's discuss together the REST API changes proposed:
Originally this document is a result of tackling #163 and vitrivr/vitrivr-ng#58, however there are that many changes, all of them breaking to justify a new version of Cineast, and also to increment the API version.
Metadata
RENAME
/api/v1/find/metadata/of/{id}/in/{domain}/with/{key}Find metadata for specific object id in given domain with given key/api/v2/metadata/objects/by/{id}/in/{domain}/with/{key}Get metadata for a specific object id in given domain with given key, i.e. get a single metadata valueRENAME
/api/v1/find/metadata/by/id/{id}Find metadata for the given object id/api/v2/metadata/objects/by/{id}Get all metadata for the given object idRENAME
/api/v1/find/metadata/by/idFinds metadata for the given list of object ids/api/v2/metadata/objects/byGet all metadata for the given list of object idsRENAME
/api/v1/find/metadata/in/{domain}/by/id/{domain}Find metadata for specific object id in given domain/api/v2/metadata/objects/by/{id}/in/{domain}Get metadata for specific object id in given domainRENAME
/api/v1/find/metadata/in/{domain}Find metadata in the specified domain for all the given ids/api/v2/metadata/objects/in/{domain}Get metadta in specified domain for given idsRENAME
/api/v1/find/metadata/with/{key}/by/id/{id}Find metadata for a given object id with specified key/api/v2/metadata/objects/by/{id}/with/{key}Get metdata for given object id with specified keyRENAME
/api/v1/find/metadata/with/{key}Find metadata for a given object id with specified key/api/v2/metadata/objects/with/{key}Get metadata with specified key for given idsRENAME
/api/v1/find/metadata/by/segmentid/{id}Find metadata for the given segment id/api/v2/metadata/segments/by/{id}Get metadata for the given segment idRENAME and MOVE
/api/v1/find/feature/all/by/id/{id}Find features for the given idSee Insight
RENAME and MOVE
/api/v1/find/feature/text/by/{id}/{category}Find Text for the given id and retrieval categorySee Insight
RENAME and MOVE
/api/v1/find/feature/tags/by/id/{id}Find tag ids for the given idSee Insight
Insight
ADD
/api/v2/insight/features/all/by/{id}Get features for the given segment idADD
/api/v2/insight/features/{category}/{retriever}/by/{id}Get features of given segment id for category / retrieverALTERNATIVE ``/api/v2/insight/features/{category}/by/{id}` Get a map of retriever:internal representation for the given segment id
ADD
/api/v2/insight/features/tags/by/{id}Get tag ids for the given segment idObject
RENAME
/api/v1/find/objects/allFind all objects for a certain type/api/v2/objects/allList all objectsRENAME
/api/v1/find/object/by/idFind objects by id/api/v2/objects/byGet objects by object idRENAME
/api/v1/find/object/by/{attribute}/{value}Find object by specified attribute value. I.e by id, name or path/api/v2/objects/filtered/{attribute}/{value}Get objects by speicified attribute value (i.e. id, name or path)ADD
/api/v2/objects/by/{id}Get an object by its object id, convenience endpoint for/api/v1/objects/filtered/id/{id}Segment
RENAME
/api/v1/find/segments/by/idFinds segments for specified ids/api/v2/segments/byGet segments with given segment idsRENAME
/api/v1/find/segments/by/id/{id}Finds segments for specified id/api/v2/segments/by/{id}Get segment with segment idRENAME
/api/v1/find/segments/all/object/{id}Find segments by their media object's id/api/v2/segments/of/object/{id}Get all segments of a speicified media objectQuery
Category formerly known as Segments
RENAME
/api/v1/find/segments/similarFind similar segments based on the given query/api/v2/query/similarityPerform a (staged) similarity queryADD
/api/v2/query/temporalPerform a temporal similarity query // Not sure whether this is actuallyTag
RENAME
/api/v1/find/tags/allFind all tags/api/v2/tags/allList all tagsRENAME
/api/v1/tags/by/idFind all tags by ids/api/v2/tags/byGet all tags by their idsREPLACE
/api/v1/find/tags/by/{attribute}/{value}Find all tags specified by attribute valueSee below
ADD
/api/v2/tags/by/{id}Get the tag with the specified idADD
/api/v2/tags/named/{name}Get all tags with the given nameADD
/api/v2/tags/matching/{name}Get tags matching the name. For matching, case-insensitive a left and right side truncation comparison is used. The matching tags are returned in order of their expected relevance.Session
Only change here is the increment of the version
/api/v2/session/startStart new session for given credentials/api/v2/session/extract/startStart extraction session/api/v2/session/extract/newExtract new item/api/v2/session/validate/{id}Validates the session with given id/api/v2/session/extract/endEnd the active extraction session/api/v2/session/end/{id}End the session for given idDatabase
Category formerly known as Misc
RENAME
/api/v1/find/boolean/column/distinctFind all distinct elements of a given column/api/v2/database/column/distinctList all distinct elements of a given columnADD
/api/v2/database/statusGet the status of the databaseStatus
/api/v2/statusGet the status of the serverLegacy API
For comparison, below is the REST API of Cineast 3.0.2, basically a copy of the OpenAPI Specifications
Metadata
/api/v1/find/metadata/of/{id}/in/{domain}/with/{key}Find metadata for specific object id in given domain with given key/api/v1/find/metadata/by/id/{id}Find metadata for the given object id/api/v1/find/metadata/by/idFinds metadata for the given list of object ids/api/v1/find/metadata/in/{domain}/by/id/{domain}Find metadata for specific object id in given domain/api/v1/find/metadata/in/{domain}Find metadata in the specified domain for all the given ids/api/v1/find/metadata/with/{key}/by/id/{id}Find metadata for a given object id with specified key/api/v1/find/metadata/with/{key}Find metadata for a given object id with specified key/api/v1/find/metadata/by/segmentid/{id}Find metadata for the given segment id/api/v1/find/feature/all/by/id/{id}Find features for the given id/api/v1/find/feature/text/by/{id}/{category}Find Text for the given id and retrieval category/api/v1/find/feature/tags/by/id/{id}Find tag ids for the given idObject
-
/api/v1/find/objects/allFind all objects for a certain type/api/v1/find/object/by/idFind objects by id/api/v1/find/object/by/{attribute}/{value}Find object by specified attribute value. I.e by id, name or pathSegment
/api/v1/find/segments/by/idFinds segments for specified ids/api/v1/find/segments/by/id/{id}Finds segments for specified id/api/v1/find/segments/all/object/{id}Find segments by their media object's idSegments
/api/v1/find/segments/similarFind similar segments based on the given queryTag
/api/v1/find/tags/allFind all tags/api/v1/tags/by/idFind all tags by ids/api/v1/find/tags/by/{attribute}/{value}Find all tags specified by attribute valueSession
/api/v1/session/startStart new session for given credentials/api/v1/session/extract/startStart extraction session/api/v1/session/extract/newExtract new item/api/v1/session/validate/{id}Validates the session with given id/api/v1/session/extract/endEnd the active extraction session/api/v1/session/end/{id}End the session for given idMisc
/api/v1/find/boolean/column/distinctFind all distinct elements of a given columnStatus
/api/v1/statusGet the status of the serverBeta Was this translation helpful? Give feedback.
All reactions