tsuru/rpaas-operator

OpenAPI spec for RPaaS endpoints

Open

#39 opened on Sep 30, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (29 forks)auto 404
good first issuehacktoberfest

Repository metrics

Stars
 (38 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Study the existing OpenAPI spec at docs/openapi.yaml and the route definitions in api/api.go. Identify which routes are not yet documented and add them following the existing patterns.
Tech stack
go
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitOpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65