82 lines
2.4 KiB
YAML
82 lines
2.4 KiB
YAML
---
|
|
|
|
endpoints:
|
|
- path: "/mappings"
|
|
entrypoint: mappings
|
|
title: Index mappings
|
|
apis:
|
|
- name: list
|
|
method: GET
|
|
title: List of all
|
|
path: "/"
|
|
|
|
|
|
- path: "/resources"
|
|
entrypoint: resources
|
|
title: Resources
|
|
parameters:
|
|
get:
|
|
- { name: limit, type: "uint", title: "Limit" }
|
|
- { name: pageCursor, type: "string", title: "Page cursor" }
|
|
apis:
|
|
- name: systemUsers
|
|
method: GET
|
|
title: Resource
|
|
path: "/system/users"
|
|
parameters:
|
|
get:
|
|
- { name: userID, type: uint64, title: User ID }
|
|
- { name: deleted, type: uint, title: Exclude (0, default), include (1) or return only (2) deleted users }
|
|
|
|
- name: composeNamespaces
|
|
method: GET
|
|
title: Resource
|
|
path: "/compose/namespaces"
|
|
parameters:
|
|
get:
|
|
- { name: namespaceID, type: uint64, title: Namespace ID }
|
|
- { name: deleted, type: uint, title: Exclude (0, default), include (1) or return only (2) deleted namespaces }
|
|
|
|
- name: composeModules
|
|
method: GET
|
|
title: Resource
|
|
path: "/compose/namespaces/{namespaceID}/modules"
|
|
parameters:
|
|
path:
|
|
- { name: namespaceID, type: uint64, title: Namespace ID }
|
|
get:
|
|
- { name: moduleID, type: uint64, title: Module ID }
|
|
- { name: deleted, type: uint, title: Exclude (0, default), include (1) or return only (2) deleted modules }
|
|
|
|
- name: composeRecords
|
|
method: GET
|
|
title: Resource
|
|
path: "/compose/namespaces/{namespaceID}/modules/{moduleID}/records"
|
|
parameters:
|
|
path:
|
|
- { name: namespaceID, type: uint64, title: Namespace ID }
|
|
- { name: moduleID, type: uint64, title: Module ID }
|
|
get:
|
|
- { name: recordID, type: uint64, title: Record ID }
|
|
- { name: deleted, type: uint, title: Exclude (0, default), include (1) or return only (2) deleted records }
|
|
|
|
- path: "/feed"
|
|
entrypoint: feed
|
|
title: Change feed
|
|
imports:
|
|
- time
|
|
parameters:
|
|
get:
|
|
- { name: limit, type: "uint", title: "Limit" }
|
|
- { name: pageCursor, type: "string", title: "Page cursor" }
|
|
|
|
apis:
|
|
- name: changes
|
|
method: GET
|
|
title: List of resource changes that should be indexed
|
|
path: "/"
|
|
parameters:
|
|
get:
|
|
- { name: from, type: "*time.Time", title: "From timestamp" }
|
|
- { name: to, type: "*time.Time", title: "To timestamp" }
|