Regaez / grav-plugin-api

A REST API plugin for GravCMS
MIT License
27 stars 6 forks source link

fix: plugins return non-standard response #24

Closed Regaez closed 5 years ago

Regaez commented 5 years ago

The GET /plugins endpoint currently returns a non-standard response when compared to the /users or /pages endpoint.

It should be changed to return:

{
  "items": [], // an array containing PluginResource objects
  "meta": {
    "count": 7
  }
}

And a PluginResource should also be shaped in such a way:

{
  "type": "plugin",
  "id": "api",
  "attributes": {
    "enabled": true,
    // other plugin config settings
  },
  "links": {
    "related": {
      "self": "http://localhost:8080/api/plugins/api"
    }
}