Rework the API endpoints to be more restful

traefik / mesh

Traefik Mesh - Simpler Service Mesh

https://traefik.io/traefik-mesh

Apache License 2.0

2.02k stars 141 forks source link

Rework the API endpoints to be more restful #749

Closed kevinpollet closed 3 years ago

kevinpollet commented 3 years ago

Feature Request

Proposal

The API is currently debug oriented and some endpoints path are not Restful:

/api/configuration/current ⇒ /api/configuration
/api/topology/current ⇒ /api/topology
/api/status/nodes ⇒ /api/nodes

Some REST endpoints should be removed or intentionally not documented.

jspdown commented 3 years ago

@kevinpollet I'm not sure we want to document /api/nodes. This really debug oriented.

kevinpollet commented 3 years ago

@jspdown I agree and I’m not sure that we should keep it.

SantoDE commented 3 years ago

did we ever need it really? :P

jspdown commented 3 years ago

@SantoDE The API was used mostly for a debugging purpose. The only 2 endpoints that provide meaningful data are the one for getting the dynamic configuration and the topology.