@wpkernel/core v0.12.1-beta.3

---

@wpkernel/core / ResourceRoutes

Type Alias: ResourceRoutes

type ResourceRoutes = object;

Standard CRUD routes for a resource

All routes are optional. At minimum, define the operations your resource supports.

Example

{
  list: { path: '/my-plugin/v1/things', method: 'GET' },
  get: { path: '/my-plugin/v1/things/:id', method: 'GET' },
  create: { path: '/my-plugin/v1/things', method: 'POST' },
  update: { path: '/my-plugin/v1/things/:id', method: 'PUT' },
  remove: { path: '/my-plugin/v1/things/:id', method: 'DELETE' }
}

Properties

create?

optional create: ResourceRoute;

Create a new resource

---

get?

optional get: ResourceRoute;

Fetch a single resource by identifier

---

list?

optional list: ResourceRoute;

Fetch a list/collection of resources

---

remove?

optional remove: ResourceRoute;

Delete a resource

---

update?

optional update: ResourceRoute;

Update an existing resource