From 8dec91c502c899fc253a92d5957d15d4db390323 Mon Sep 17 00:00:00 2001
From: Claudio Netto <nettinhorama@gmail.com>
Date: Mon, 17 Aug 2020 17:03:39 -0300
Subject: [PATCH] docs(api): describe service instance status endpoint

---
 docs/openapi.yaml | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/docs/openapi.yaml b/docs/openapi.yaml
index b25fbced1..f3e5043a9 100644
--- a/docs/openapi.yaml
+++ b/docs/openapi.yaml
@@ -160,6 +160,25 @@ paths:
             text/plain:
               example: failed to create instance on storage
 
+  /resources/{instance}/status:
+    get:
+      summary: Whether instance is running or not
+      description: This endpoint is part of Tsuru Service API.
+      tags:
+      - rpaas
+      parameters:
+      - in: path
+        name: instance
+        schema:
+          type: string
+        required: true
+        description: Instance name
+      responses:
+        '202':
+          description: Instance is pending (partially provisioned)
+        '204':
+          description: Instance is up and running
+
   /resources/{instance}/info:
     get:
       summary: Get a summary informations about an instance