tsuru/rpaas-operator

OpenAPI spec for RPaaS endpoints

Aperta

#39 aperta il 30 set 2019

 (1 commento) (0 reazioni) (0 assegnatari)Go (29 fork)auto 404
good first issuehacktoberfest

Metriche repository

Star
 (38 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

It would be nice if we describe the RpaaS API using a formal specification like OpenAPI. Below is outlined all routes used today. Let's doc them! :rocket:

Tsuru Service API:

  • POST: /resources
  • GET: /resources/:instance
  • PUT: /resources/:instance
  • DELETE: /resources/:instance
  • GET: /resources/plans
  • GET: /resources/:instance/status
  • POST: /resources/:instance/bind-app
  • DELETE: /resources/:instance/bind-app
  • POST: /resources/:instance/bind
  • DELETE: /resources/:instance/bind

RPaaS API (legacy):

  • GET: /resources/:instance/plans
  • GET: /resources/flavors (deprecated)
  • GET: /resources/:instance/flavors (deprecated)
  • GET: /resources/:instance/node_status (deprecated)
  • POST: /resources/:instance/scale
  • POST: /resources/:instance/certificate
  • GET: /resources/:instance/block
  • POST: /resources/:instance/block
  • DELETE: /resources/:instance/block/:block
  • DELETE: /resources/:instance/lua (deprecated)
  • GET: /resources/:instance/lua (deprecated)
  • POST: /resources/:instance/lua (deprecated)
  • DELETE: /resources/:instance/route
  • GET: /resources/:instance/route
  • POST: /resources/:instance/route
  • POST: /resources/:instance/purge

RPaaS v2:

  • GET: /healthcheck
  • GET: /resources/:instance/info
  • GET: /resources/:instance/certificate
  • DELETE: /resources/:instance/certificate/:name
  • GET: /resources/:instance/files
  • GET: /resources/:instance/files/:name
  • POST: /resources/:instance/files
  • PUT: /resources/:instance/files
  • DELETE: /resources/:instance/files/:name
  • *: /resources/:instance/exec

NOTE: These routes can be found at api/api.go file. The current OpenAPI spec is located on docs/openapi.yaml.

Guida contributor