search

Regaez / grav-plugin-api

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

fix: config returns non-standard response #25

Closed Regaez closed 5 years ago

Regaez commented 5 years ago

The GET /config endpoint should change to GET /configs to match the other endpoints format.

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

It should be changed to return:

{
  "items": [], // an array containing ConfigResource objects
  "meta": {
    "count": 4
  }
}

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

{
  "type": "config",
  "id": "api",
  "attributes": {
    // actual config settings
  },
  "links": {
    "related": {
      "self": "http://localhost:8080/api/config/site"
    }
}
Regaez commented 5 years ago

Note: the endpoint /config was changed to /configs during the refactor in PR #28