Type Alias: ApiResource
ApiResource =
object
Defined in: core/resources.ts:23
A REST resource read from the spec: the operations of one tag, each given its role by HTTP method and path shape, the way an admin UI needs them.
Properties
actions
actions:
ResourceAction[]
Defined in: core/resources.ts:51
Every other write (POST/PUT/PATCH/DELETE) of the tag.
create?
optionalcreate?:ResolvedOperation
Defined in: core/resources.ts:45
POST on the collection path.
delete?
optionaldelete?:ResolvedOperation
Defined in: core/resources.ts:49
DELETE on the item path.
get?
optionalget?:ResolvedOperation
Defined in: core/resources.ts:43
GET on the item path.
idParam?
optionalidParam?:string
Defined in: core/resources.ts:33
The path param naming one record (client_id).
key
key:
string
Defined in: core/resources.ts:25
URL-safe identifier, used in locations (clients).
label
label:
string
Defined in: core/resources.ts:29
Display name (Clients).
list?
optionallist?:ResolvedOperation
Defined in: core/resources.ts:41
GET on the collection path.
scopeParams
scopeParams:
string[]
Defined in: core/resources.ts:39
Path params the resource's paths need besides idParam: a nested
resource (/agents/{agent_id}/versions) can only be listed with its
parent's id, given through params.
segment?
optionalsegment?:string
Defined in: core/resources.ts:31
Last static segment of the collection path (clients); x-ref targets it.
tag
tag:
string
Defined in: core/resources.ts:27
The tag the operations share, or the path segment of untagged ones.
update?
optionalupdate?:ResolvedOperation
Defined in: core/resources.ts:47
PATCH (preferred) or PUT on the item path.