chetan1q/api-discovery-rag
0
1{2 "swagger": "2.0",3 "info": {4 "version": "1.0",5 "title": "Upload Document API",6 "description": "The Document Management API provides programmatic access to our document repository, enabling applications to manage documents with increased efficiency, improved information control, and reduced cost."7 },8 "basePath": "/documents/v1.0",9 "paths": {10 "/upload": {11 "post": {12 "tags": [13 "Document Management"14 ],15 "summary": "Store a new document",16 "description": "Store a new document in the repository. A JSON map containing all agreed metadata must be provided. Supported metadata items are agreed as part of the onboarding process.",17 "operationId": "uploadUsingPOST",18 "consumes": [19 "multipart/form-data"20 ],21 "produces": [22 "application/json"23 ],24 "parameters": [25 {26 "name": "Authorization",27 "in": "header",28 "description": "JWT Bearer Token",29 "required": true,30 "type": "string"31 },32 {33 "in": "formData",34 "name": "MetaData",35 "description": "A JSON map containing key/value pairs for all agreed metadata items.",36 "required": true,37 "type": "string",38 "default": "{ \"ArrangementID\": \"IL01003006\", \"BankingCustomerIdentifier\": \"9999888938\", \"BusinessProcess\": \"tyl\", \"Description\": \"Sample.doc\", \"DocumentReferenceID\": \"DATA7 GMT\", \"DocumentSource\": \"tyl\", \"DocumentTitle\": \"test doc\", \"filename\": \"Sample.doc\", \"IsCustomerVisibleDocument\": \"true\", \"DeletedFlag\": \"false\", \"Language\": \"ENG\", \"mimeType\": \"application/msword\", \"Name\": \"CDT-27888.doc\", \"PartyID\": \"9999888938\", \"RBSClassification\": \"Confidential\", \"RBSCompany\": \"NWG\", \"RBSHighRiskRecord\": \"High Risk\", \"RBSJurisdiction\": \"GB\", \"RBSPersonalInfo\": \"true\", \"RecordClassCode\": \"RM1100\", \"RecordType\": \"targeted_due_dil\", \"AccountNumber\": \"123\", \"CustomerReferenceID\": \"123\", \"LegalEntityID\": \"123\", \"LastUsedID\": \"y\", \"SortCode\": \"123\", \"ReasonForDeletion\": \"y\", \"rmCreationDate\": \"2021-04-14T12:39:43.221\" }"39 },40 {41 "name": "file",42 "in": "formData",43 "description": "The file to be uploaded to the repository.",44 "required": true,45 "type": "file"46 }47 ],48 "responses": {49 "201": {50 "description": "Created",51 "schema": {52 "$ref": "#/definitions/UploadResponseObject"53 }54 },55 "401": {56 "description": "Unauthorized"57 },58 "403": {59 "description": "Forbidden"60 },61 "404": {62 "description": "Not Found"63 }64 },65 "deprecated": false66 }67 }68 },69 "definitions": {70 "UploadResponseObject": {71 "type": "object",72 "properties": {73 "code": {74 "type": "integer",75 "format": "int32",76 "example": 201,77 "description": "HTTP style response code"78 },79 "message": {80 "type": "string",81 "description": "Status message from the API",82 "example": "Success response"83 },84 "objectId": {85 "type": "string",86 "example": "e86411ad-579d-48b8-b4b8-9f14b1e8bcdd",87 "description": "ID of the object created within the repository"88 },89 "status": {90 "type": "string",91 "example": "CREATED",92 "description": "HTTP style response message"93 }94 },95 "title": "UploadResponseObject"96 }97 }98}