From 3f30b8bb855f416c58a3371b8eb400a223284fb0 Mon Sep 17 00:00:00 2001
From: kgaikwad <kavitagaikwad103@gmail.com>
Date: Mon, 13 Jan 2025 15:49:45 +0530
Subject: [PATCH] update readme to remove stale information

---
 README.md | 58 ++++---------------------------------------------------
 1 file changed, 4 insertions(+), 54 deletions(-)

diff --git a/README.md b/README.md
index 5b0205e0..4f0bc5eb 100644
--- a/README.md
+++ b/README.md
@@ -95,59 +95,9 @@ make configure-xjoin
 ```
 Note - Before running the above commands make sure kafka and db-host-inventory containers are up and running.
 
-## Available v1 API endpoints
+## Available API endpoints
 
-### Request
-`GET /api/ros/v1/status` Shows the status of the server
+Our REST API documentation can be found at /api/ros. You may access the raw OpenAPI definition [here](https://raw.githubusercontent.com/RedHatInsights/ros-backend/refs/heads/main/ros/openapi/openapi.json).
+On a local instance it can be accessed on http://localhost:8000/api/ros/v1/openapi.json.
 
-    curl -v -H "Content-Type: application/json" https://cloud.redhat.com/api/ros/v1/status
-
-### Response
-
-    HTTP/1.1 200 OK
-    Date: Thu, 24 Feb 2011 12:36:30 GMT
-    Status: 200 OK
-    Connection: close
-    Content-Type: application/json
-    Content-Length: 2
-
-    {"status": "Application is running!"}
-
-
-
-### Request
-`GET /api/ros/v1/systems` Shows list of all systems from Host Inventory having a Performance Profile
-
-    curl -v -H "Content-Type: application/json" https://cloud.redhat.com/api/ros/v1/systems -u rhn-username:redhat
-
-### Response
-
-    HTTP/1.1 200 OK
-    Date: Thu, 24 Feb 2011 12:36:30 GMT
-    Status: 200 OK
-    Connection: close
-    Content-Type: application/json
-    Content-Length: 2
-
-    [{
-      "fqdn": "string",
-      "display_name": "string",
-      "inventory_id": "string",
-      "account": "string",
-      "org_id": "string",
-      "number_of_suggestions": 0,
-      "state": "string",
-      "performance_utilization": {
-        "memory": 0,
-        "cpu": 0,
-        "io": 0
-      },
-      "cloud_provider": "string",
-      "instance_type": "string",
-      "idling_time": 0,
-      "os": "string",
-      "report_date": "string"
-    }]
-
-
-For local dev setup, please remember to use the x-rh-identity header encoded from your account number and org_id, the one used while running `make insights-upload-data` and `make ros-upload-data` commands.
+For local dev setup, please remember to use the x-rh-identity header encoded from your account number and org_id, the one used while running `make insights-upload-data` command.