{ "openapi": "3.0.0", "info": { "version": "1.0.0", "title": "Compileaze API", "description": "API documentation for Compileaze" }, "servers": [ { "url": "https://complieaze1.centralindia.cloudapp.azure.com"} ], "paths": { "/references": { "post": { "summary": "Get the names of the circulars that a circular refers to.", "description": "Get the names of the circulars that a circular refers to.", "parameters": [ { "name": "context_document", "in": "body", "description": "Name of the circular that you want the references for.", "required": true } ], "operationId": "getReferences", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "context_document" ], "properties": { "context_document": { "type": "string", "example": " DoR.RET.REC.59/12.01.001/2023-24" } } } } } }, "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/changes": { "post": { "summary": "Get the changes made by a circular to any other circulars.", "description": "Get the changes made by a circular to any other circulars.", "parameters": [ { "name": "context_document", "in": "body", "description": "Name of the circular that makes the changes.", "required": true } ], "operationId": "getChanges", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "context_document" ], "properties": { "context_document": { "type": "string", "example": "A.P. (DIR Series) Circular No. 13" } } } } } }, "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/action": { "post": { "summary": "Get action items mentioned in a circular.", "description": "Get action items mentioned in a circular.", "parameters": [ { "name": "context_document", "in": "body", "description": "Name of the circular that you want the action items for.", "required": true } ], "operationId": "getAction", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "context_document" ], "properties": { "context_document": { "type": "string", "example": "Master Circular – Housing Finance" } } } } } }, "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/question": { "post": { "summary": "Get an answer to your query along with the references to the appropriate RBI circulars.", "description": "Get an answer to your query along with the references to the appropriate RBI circulars.", "parameters": [ { "name": "user_input", "in": "body", "description": "Query that you want to be resolved.", "required": true } ], "operationId": "getQuestion", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "user_input" ], "properties": { "user_input": { "type": "string", "example": "How often should IRBB guidelines be reviewed?" } } } } } }, "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } }, "/compliance": { "get": { "summary": "List all the RBI circulars with their details.", "description": "List all the RBI circulars with their details.", "operationId": "getCompliance", "responses": { "200": { "description": "Successful response" } }, "security": [ { "bearerAuth": [] } ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }