{ "openapi": "3.0.0", "info": { "description": "You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).", "version": "1.0.0", "title": "Le Coffre Api" }, "servers": [ { "url": "https://api.stg.lecoffre.smart-chain.fr" } ], "tags": [ { "name": "customer" }, { "name": "notary" }, { "name": "admin" }, { "name": "super-admin" } ], "paths": { "/notary/customers": { "get": { "tags": ["notary"], "summary": "Get all customers", "description": "", "operationId": "getCustomers", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["notary"], "summary": "Add a new customer", "description": "", "operationId": "addCustomer", "requestBody": { "description": "Customer object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/customers/{uid}": { "get": { "tags": ["notary"], "summary": "Find customer by ID", "description": "Returns a single customer", "operationId": "getCustomerById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of customer to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["notary"], "summary": "Update an existing customer", "description": "Returns a single customer updated", "operationId": "updateCustomer", "parameters": [ { "name": "uid", "in": "path", "description": "ID of customer to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Customer object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["notary"], "summary": "Delete an existing customer", "description": "Returns a single customer deleted", "operationId": "deleteCustomer", "parameters": [ { "name": "uid", "in": "path", "description": "ID of customer to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/deeds": { "get": { "tags": ["notary"], "summary": "Get all deeds", "description": "", "operationId": "getDeeds", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["notary"], "summary": "Add a new deed", "description": "", "operationId": "addDeed", "requestBody": { "description": "Deed object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/deeds/{uid}": { "get": { "tags": ["notary"], "summary": "Find deed by ID", "description": "Returns a single deed", "operationId": "getDeedById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["notary"], "summary": "Update an existing deed", "description": "Returns a single deed updated", "operationId": "updateDeed", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Deed object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["notary"], "summary": "Delete an existing deed", "description": "Returns a single deed deleted", "operationId": "deleteDeed", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Deed object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/deed-types": { "get": { "tags": ["notary"], "summary": "Get all deed types", "description": "", "operationId": "getDeedTypes", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["notary"], "summary": "Add a new deed type", "description": "", "operationId": "addDeedType", "requestBody": { "description": "DeedType object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/deed-types/{uid}": { "get": { "tags": ["notary"], "summary": "Find deed type by ID", "description": "Returns a single deed type", "operationId": "getDeedTypeById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed type to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["notary"], "summary": "Update an existing deed type", "description": "Returns a single deed type updated", "operationId": "updateDeedType", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed type to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "DeedType object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/documents": { "get": { "tags": ["notary"], "summary": "Get all documents", "description": "", "operationId": "getDocuments", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["notary"], "summary": "Add a new document", "description": "", "operationId": "addDocument", "requestBody": { "description": "Document object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/documents/{uid}": { "get": { "tags": ["notary"], "summary": "Find document by ID", "description": "Returns a single document", "operationId": "getDocumentById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["notary"], "summary": "Update an existing document", "description": "Returns a single document updated", "operationId": "updateDocument", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Document object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["notary"], "summary": "Delete an existing document", "description": "Returns a single document deleted", "operationId": "deleteDocument", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Document object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/document-types": { "get": { "tags": ["notary"], "summary": "Get all document types", "description": "", "operationId": "getDocumentTypes", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["notary"], "summary": "Add a new document type", "description": "", "operationId": "addDocumentType", "requestBody": { "description": "DocumentType object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/document-types/{uid}": { "get": { "tags": ["notary"], "summary": "Find document type by ID", "description": "Returns a single document type", "operationId": "getDocumentTypeById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document type to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["notary"], "summary": "Update an existing document type", "description": "Returns a single document type updated", "operationId": "updateDocumentType", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document type to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "DocumentType object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["notary"], "summary": "Delete an existing document type", "description": "Returns a single document type deleted", "operationId": "deleteDocumentType", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document type to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/files": { "get": { "tags": ["notary"], "summary": "Get all files", "description": "", "operationId": "getFiles", "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/files/{uid}": { "get": { "tags": ["notary"], "summary": "Find file by ID", "description": "Returns a single file", "operationId": "getFileById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of file to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["notary"], "summary": "Delete an existing file", "description": "Returns a single file deleted", "operationId": "deleteFile", "parameters": [ { "name": "uid", "in": "path", "description": "ID of file to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/files/download/{uid}": { "get": { "tags": ["notary"], "summary": "Download file by ID", "description": "Returns a single file", "operationId": "downloadFileById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of file to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/anchors": { "get": { "tags": ["notary"], "summary": "Get all anchors", "description": "", "operationId": "getAnchors", "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/anchors/{uid}": { "get": { "tags": ["notary"], "summary": "Find anchor by ID", "description": "Returns a single anchor", "operationId": "getAnchorById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of anchor to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["notary"], "summary": "Add a new anchor", "description": "", "operationId": "addAnchor", "parameters": [ { "name": "uid", "in": "path", "description": "ID of anchor to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Anchor object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Anchor" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/anchors/download/{uid}": { "get": { "tags": ["notary"], "summary": "Download anchor by ID", "description": "Returns a single anchor", "operationId": "downloadAnchorById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of anchor to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/folders": { "get": { "tags": ["notary"], "summary": "Get all folders", "description": "", "operationId": "getFolders", "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["notary"], "summary": "Add a new folder", "description": "", "operationId": "addFolder", "requestBody": { "description": "Folder object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/folders/{uid}": { "put": { "tags": ["notary"], "summary": "Update an existing folder", "description": "Returns a single folder updated", "operationId": "updateFolder", "parameters": [ { "name": "uid", "in": "path", "description": "ID of folder to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Folder object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["notary"], "summary": "Delete an existing folder", "description": "Returns a single folder deleted", "operationId": "deleteFolder", "parameters": [ { "name": "uid", "in": "path", "description": "ID of folder to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "get": { "tags": ["notary"], "summary": "Find folder by ID", "description": "Returns a single folder", "operationId": "getFolderById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of folder to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/office-roles": { "get": { "tags": ["notary"], "summary": "Get all office roles", "description": "", "operationId": "getOfficeRoles", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeRole" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/office-roles/{uid}": { "get": { "tags": ["notary"], "summary": "Find office role by ID", "description": "Returns a single office role", "operationId": "getOfficeRoleById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of office role to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeRole" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/offices": { "get": { "tags": ["notary"], "summary": "Get all offices", "description": "", "operationId": "getOffices", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Office" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/offices/{uid}": { "get": { "tags": ["notary"], "summary": "Find office by ID", "description": "Returns a single office", "operationId": "getOfficeById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of office to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Office" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/roles": { "get": { "tags": ["notary"], "summary": "Get all roles", "description": "", "operationId": "getRoles", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/roles/{uid}": { "get": { "tags": ["notary"], "summary": "Find role by ID", "description": "Returns a single role", "operationId": "getRoleById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of role to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/notifications": { "get": { "tags": ["notary"], "summary": "Get all notifications", "description": "", "operationId": "getNotifications", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/notifications/{uid}": { "put": { "tags": ["notary"], "summary": "Update an existing notification", "description": "Returns a single notification updated", "operationId": "updateNotification", "parameters": [ { "name": "uid", "in": "path", "description": "ID of notification to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Notification object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "get": { "tags": ["notary"], "summary": "Find notification by ID", "description": "Returns a single notification", "operationId": "getNotificationById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of notification to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/users": { "get": { "tags": ["notary"], "summary": "Get all users", "description": "", "operationId": "getUsers", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/notary/users/{uid}": { "get": { "tags": ["notary"], "summary": "Find user by ID", "description": "", "operationId": "getUserById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of user to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/customer/documents": { "get": { "tags": ["customer"], "summary": "Get all documents", "description": "", "operationId": "getDocuments", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["customer"], "summary": "Add a new document", "description": "", "operationId": "addDocument", "requestBody": { "description": "Document object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/customer/documents/{uid}": { "get": { "tags": ["customer"], "summary": "Find document by ID", "description": "Returns a single document", "operationId": "getDocumentById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/customer/files": { "get": { "tags": ["customer"], "summary": "Get all files", "description": "", "operationId": "getFiles", "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["customer"], "summary": "Add a new file", "description": "", "operationId": "addFile", "parameters": [ { "name": "q", "in": "path", "description": "requested document object", "required": true, "schema": { "type": "object", "properties": { "document": { "type": "object", "properties": { "uid": { "type": "string" } } } } } } ], "requestBody": { "description": "File object that needs to be added to the store", "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/customer/files/{uid}": { "get": { "tags": ["customer"], "summary": "Find file by ID", "description": "Returns a single file", "operationId": "getFileById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of file to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["customer"], "summary": "Update an existing file", "description": "Returns a single file updated", "operationId": "updateFile", "parameters": [ { "name": "uid", "in": "path", "description": "ID of file to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "File object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/File" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["customer"], "summary": "Delete an existing file", "description": "Returns a single file deleted", "operationId": "deleteFile", "parameters": [ { "name": "uid", "in": "path", "description": "ID of file to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/customer/folders": { "get": { "tags": ["customer"], "summary": "Get all folders", "description": "", "operationId": "getFolders", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/customer/folders/{uid}": { "get": { "tags": ["customer"], "summary": "Find folder by ID", "description": "Returns a single folder", "operationId": "getFolderById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of folder to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/customers": { "get": { "tags": ["admin"], "summary": "Get all customers", "description": "", "operationId": "getCustomers", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["admin"], "summary": "Add a new customer", "description": "", "operationId": "addCustomer", "requestBody": { "description": "Customer object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/customers/{uid}": { "get": { "tags": ["admin"], "summary": "Find customer by ID", "description": "Returns a single customer", "operationId": "getCustomerById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of customer to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["admin"], "summary": "Update an existing customer", "description": "Returns a single customer updated", "operationId": "updateCustomer", "parameters": [ { "name": "uid", "in": "path", "description": "ID of customer to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Customer object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["admin"], "summary": "Delete an existing customer", "description": "Returns a single customer deleted", "operationId": "deleteCustomer", "parameters": [ { "name": "uid", "in": "path", "description": "ID of customer to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/deeds": { "get": { "tags": ["admin"], "summary": "Get all deeds", "description": "", "operationId": "getDeeds", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["admin"], "summary": "Add a new deed", "description": "", "operationId": "addDeed", "requestBody": { "description": "Deed object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/deeds/{uid}": { "get": { "tags": ["admin"], "summary": "Find deed by ID", "description": "Returns a single deed", "operationId": "getDeedById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["admin"], "summary": "Update an existing deed", "description": "Returns a single deed updated", "operationId": "updateDeed", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Deed object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["admin"], "summary": "Delete an existing deed", "description": "Returns a single deed deleted", "operationId": "deleteDeed", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Deed object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/deed-types": { "get": { "tags": ["admin"], "summary": "Get all deed types", "description": "", "operationId": "getDeedTypes", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["admin"], "summary": "Add a new deed type", "description": "", "operationId": "addDeedType", "requestBody": { "description": "DeedType object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/deed-types/{uid}": { "get": { "tags": ["admin"], "summary": "Find deed type by ID", "description": "Returns a single deed type", "operationId": "getDeedTypeById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed type to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["admin"], "summary": "Update an existing deed type", "description": "Returns a single deed type updated", "operationId": "updateDeedType", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed type to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "DeedType object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/documents": { "get": { "tags": ["admin"], "summary": "Get all documents", "description": "", "operationId": "getDocuments", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["admin"], "summary": "Add a new document", "description": "", "operationId": "addDocument", "requestBody": { "description": "Document object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/documents/{uid}": { "get": { "tags": ["admin"], "summary": "Find document by ID", "description": "Returns a single document", "operationId": "getDocumentById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["admin"], "summary": "Update an existing document", "description": "Returns a single document updated", "operationId": "updateDocument", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Document object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["admin"], "summary": "Delete an existing document", "description": "Returns a single document deleted", "operationId": "deleteDocument", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Document object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/document-types": { "get": { "tags": ["admin"], "summary": "Get all document types", "description": "", "operationId": "getDocumentTypes", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["admin"], "summary": "Add a new document type", "description": "", "operationId": "addDocumentType", "requestBody": { "description": "DocumentType object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/document-types/{uid}": { "get": { "tags": ["admin"], "summary": "Find document type by ID", "description": "Returns a single document type", "operationId": "getDocumentTypeById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document type to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["admin"], "summary": "Update an existing document type", "description": "Returns a single document type updated", "operationId": "updateDocumentType", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document type to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "DocumentType object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["admin"], "summary": "Delete an existing document type", "description": "Returns a single document type deleted", "operationId": "deleteDocumentType", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document type to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/files": { "get": { "tags": ["admin"], "summary": "Get all files", "description": "", "operationId": "getFiles", "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/files/{uid}": { "get": { "tags": ["admin"], "summary": "Find file by ID", "description": "Returns a single file", "operationId": "getFileById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of file to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["admin"], "summary": "Delete an existing file", "description": "Returns a single file deleted", "operationId": "deleteFile", "parameters": [ { "name": "uid", "in": "path", "description": "ID of file to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/files/download/{uid}": { "get": { "tags": ["admin"], "summary": "Download file by ID", "description": "Returns a single file", "operationId": "downloadFileById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of file to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/anchors": { "get": { "tags": ["admin"], "summary": "Get all anchors", "description": "", "operationId": "getAnchors", "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/anchors/{uid}": { "get": { "tags": ["admin"], "summary": "Find anchor by ID", "description": "Returns a single anchor", "operationId": "getAnchorById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of anchor to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["admin"], "summary": "Add a new anchor", "description": "", "operationId": "addAnchor", "parameters": [ { "name": "uid", "in": "path", "description": "ID of anchor to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Anchor object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Anchor" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/anchors/download/{uid}": { "get": { "tags": ["admin"], "summary": "Download anchor by ID", "description": "Returns a single anchor", "operationId": "downloadAnchorById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of anchor to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/folders": { "get": { "tags": ["admin"], "summary": "Get all folders", "description": "", "operationId": "getFolders", "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["admin"], "summary": "Add a new folder", "description": "", "operationId": "addFolder", "requestBody": { "description": "Folder object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/folders/{uid}": { "put": { "tags": ["admin"], "summary": "Update an existing folder", "description": "Returns a single folder updated", "operationId": "updateFolder", "parameters": [ { "name": "uid", "in": "path", "description": "ID of folder to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Folder object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["admin"], "summary": "Delete an existing folder", "description": "Returns a single folder deleted", "operationId": "deleteFolder", "parameters": [ { "name": "uid", "in": "path", "description": "ID of folder to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "get": { "tags": ["admin"], "summary": "Find folder by ID", "description": "Returns a single folder", "operationId": "getFolderById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of folder to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/office-roles": { "get": { "tags": ["admin"], "summary": "Get all office roles", "description": "", "operationId": "getOfficeRoles", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeRole" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["admin"], "summary": "Add a new office role", "description": "", "operationId": "addOfficeRole", "requestBody": { "description": "OfficeRole object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfficeRole" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeRole" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/office-roles/{uid}": { "get": { "tags": ["admin"], "summary": "Find office role by ID", "description": "Returns a single office role", "operationId": "getOfficeRoleById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of office role to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeRole" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["admin"], "summary": "Update an existing office role", "description": "Returns a single office role updated", "operationId": "updateOfficeRole", "parameters": [ { "name": "uid", "in": "query", "description": "ID of office role to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OfficeRole object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfficeRole" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeRole" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/offices": { "get": { "tags": ["admin"], "summary": "Get all offices", "description": "", "operationId": "getOffices", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Office" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/offices/{uid}": { "get": { "tags": ["admin"], "summary": "Find office by ID", "description": "Returns a single office", "operationId": "getOfficeById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of office to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Office" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/roles": { "get": { "tags": ["admin"], "summary": "Get all roles", "description": "", "operationId": "getRoles", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/roles/{uid}": { "get": { "tags": ["admin"], "summary": "Find role by ID", "description": "Returns a single role", "operationId": "getRoleById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of role to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/notifications": { "get": { "tags": ["admin"], "summary": "Get all notifications", "description": "", "operationId": "getNotifications", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/notifications/{uid}": { "put": { "tags": ["admin"], "summary": "Update an existing notification", "description": "Returns a single notification updated", "operationId": "updateNotification", "parameters": [ { "name": "uid", "in": "path", "description": "ID of notification to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Notification object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "get": { "tags": ["admin"], "summary": "Find notification by ID", "description": "Returns a single notification", "operationId": "getNotificationById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of notification to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/users": { "get": { "tags": ["admin"], "summary": "Get all users", "description": "", "operationId": "getUsers", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/admin/users/{uid}": { "get": { "tags": ["admin"], "summary": "Find user by ID", "description": "", "operationId": "getUserById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of user to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["admin"], "summary": "Update an existing user", "description": "", "operationId": "updateUser", "parameters": [ { "name": "uid", "in": "query", "description": "ID of user to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/customers": { "get": { "tags": ["super-admin"], "summary": "Get all customers", "description": "", "operationId": "getCustomers", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["super-admin"], "summary": "Add a new customer", "description": "", "operationId": "addCustomer", "requestBody": { "description": "Customer object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/customers/{uid}": { "get": { "tags": ["super-admin"], "summary": "Find customer by ID", "description": "Returns a single customer", "operationId": "getCustomerById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of customer to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["super-admin"], "summary": "Update an existing customer", "description": "Returns a single customer updated", "operationId": "updateCustomer", "parameters": [ { "name": "uid", "in": "path", "description": "ID of customer to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Customer object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["super-admin"], "summary": "Delete an existing customer", "description": "Returns a single customer deleted", "operationId": "deleteCustomer", "parameters": [ { "name": "uid", "in": "path", "description": "ID of customer to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/deeds": { "get": { "tags": ["super-admin"], "summary": "Get all deeds", "description": "", "operationId": "getDeeds", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["super-admin"], "summary": "Add a new deed", "description": "", "operationId": "addDeed", "requestBody": { "description": "Deed object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/deeds/{uid}": { "get": { "tags": ["super-admin"], "summary": "Find deed by ID", "description": "Returns a single deed", "operationId": "getDeedById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["super-admin"], "summary": "Update an existing deed", "description": "Returns a single deed updated", "operationId": "updateDeed", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Deed object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["super-admin"], "summary": "Delete an existing deed", "description": "Returns a single deed deleted", "operationId": "deleteDeed", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Deed object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deed" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/deed-types": { "get": { "tags": ["super-admin"], "summary": "Get all deed types", "description": "", "operationId": "getDeedTypes", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["super-admin"], "summary": "Add a new deed type", "description": "", "operationId": "addDeedType", "requestBody": { "description": "DeedType object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/deed-types/{uid}": { "get": { "tags": ["super-admin"], "summary": "Find deed type by ID", "description": "Returns a single deed type", "operationId": "getDeedTypeById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed type to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["super-admin"], "summary": "Update an existing deed type", "description": "Returns a single deed type updated", "operationId": "updateDeedType", "parameters": [ { "name": "uid", "in": "path", "description": "ID of deed type to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "DeedType object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeedType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/documents": { "get": { "tags": ["super-admin"], "summary": "Get all documents", "description": "", "operationId": "getDocuments", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["super-admin"], "summary": "Add a new document", "description": "", "operationId": "addDocument", "requestBody": { "description": "Document object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/documents/{uid}": { "get": { "tags": ["super-admin"], "summary": "Find document by ID", "description": "Returns a single document", "operationId": "getDocumentById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["super-admin"], "summary": "Update an existing document", "description": "Returns a single document updated", "operationId": "updateDocument", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Document object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["super-admin"], "summary": "Delete an existing document", "description": "Returns a single document deleted", "operationId": "deleteDocument", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Document object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Document" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/document-types": { "get": { "tags": ["super-admin"], "summary": "Get all document types", "description": "", "operationId": "getDocumentTypes", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["super-admin"], "summary": "Add a new document type", "description": "", "operationId": "addDocumentType", "requestBody": { "description": "DocumentType object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/document-types/{uid}": { "get": { "tags": ["super-admin"], "summary": "Find document type by ID", "description": "Returns a single document type", "operationId": "getDocumentTypeById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document type to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["super-admin"], "summary": "Update an existing document type", "description": "Returns a single document type updated", "operationId": "updateDocumentType", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document type to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "DocumentType object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["super-admin"], "summary": "Delete an existing document type", "description": "Returns a single document type deleted", "operationId": "deleteDocumentType", "parameters": [ { "name": "uid", "in": "path", "description": "ID of document type to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/files": { "get": { "tags": ["super-admin"], "summary": "Get all files", "description": "", "operationId": "getFiles", "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/files/{uid}": { "get": { "tags": ["super-admin"], "summary": "Find file by ID", "description": "Returns a single file", "operationId": "getFileById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of file to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["super-admin"], "summary": "Delete an existing file", "description": "Returns a single file deleted", "operationId": "deleteFile", "parameters": [ { "name": "uid", "in": "path", "description": "ID of file to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/files/download/{uid}": { "get": { "tags": ["super-admin"], "summary": "Download file by ID", "description": "Returns a single file", "operationId": "downloadFileById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of file to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/anchors": { "get": { "tags": ["super-admin"], "summary": "Get all anchors", "description": "", "operationId": "getAnchors", "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/anchors/{uid}": { "get": { "tags": ["super-admin"], "summary": "Find anchor by ID", "description": "Returns a single anchor", "operationId": "getAnchorById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of anchor to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["super-admin"], "summary": "Add a new anchor", "description": "", "operationId": "addAnchor", "parameters": [ { "name": "uid", "in": "path", "description": "ID of anchor to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Anchor object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Anchor" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/anchors/download/{uid}": { "get": { "tags": ["super-admin"], "summary": "Download anchor by ID", "description": "Returns a single anchor", "operationId": "downloadAnchorById", "parameters": [ { "name": "uid", "in": "path", "description": "ID of anchor to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/folders": { "get": { "tags": ["super-admin"], "summary": "Get all folders", "description": "", "operationId": "getFolders", "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["super-admin"], "summary": "Add a new folder", "description": "", "operationId": "addFolder", "requestBody": { "description": "Folder object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/folders/{uid}": { "put": { "tags": ["super-admin"], "summary": "Update an existing folder", "description": "Returns a single folder updated", "operationId": "updateFolder", "parameters": [ { "name": "uid", "in": "path", "description": "ID of folder to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Folder object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": ["super-admin"], "summary": "Delete an existing folder", "description": "Returns a single folder deleted", "operationId": "deleteFolder", "parameters": [ { "name": "uid", "in": "path", "description": "ID of folder to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "get": { "tags": ["super-admin"], "summary": "Find folder by ID", "description": "Returns a single folder", "operationId": "getFolderById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of folder to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Folder" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/office-roles": { "get": { "tags": ["super-admin"], "summary": "Get all office roles", "description": "", "operationId": "getOfficeRoles", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeRole" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["super-admin"], "summary": "Add a new office role", "description": "", "operationId": "addOfficeRole", "requestBody": { "description": "OfficeRole object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfficeRole" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeRole" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/office-roles/{uid}": { "get": { "tags": ["super-admin"], "summary": "Find office role by ID", "description": "Returns a single office role", "operationId": "getOfficeRoleById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of office role to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeRole" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["super-admin"], "summary": "Update an existing office role", "description": "Returns a single office role updated", "operationId": "updateOfficeRole", "parameters": [ { "name": "uid", "in": "query", "description": "ID of office role to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OfficeRole object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfficeRole" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OfficeRole" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/offices": { "get": { "tags": ["super-admin"], "summary": "Get all offices", "description": "", "operationId": "getOffices", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Office" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["super-admin"], "summary": "Add a new office", "description": "", "operationId": "addOffice", "requestBody": { "description": "Office object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Office" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Office" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/offices/{uid}": { "get": { "tags": ["super-admin"], "summary": "Find office by ID", "description": "Returns a single office", "operationId": "getOfficeById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of office to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Office" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["super-admin"], "summary": "Update an existing office", "description": "Returns a single office updated", "operationId": "updateOffice", "parameters": [ { "name": "uid", "in": "query", "description": "ID of office to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Office object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Office" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Office" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/roles": { "get": { "tags": ["super-admin"], "summary": "Get all roles", "description": "", "operationId": "getRoles", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": ["super-admin"], "summary": "Add a new role", "description": "", "operationId": "addRole", "requestBody": { "description": "Role object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/roles/{uid}": { "get": { "tags": ["super-admin"], "summary": "Find role by ID", "description": "Returns a single role", "operationId": "getRoleById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of role to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["super-admin"], "summary": "Update an existing role", "description": "Returns a single role updated", "operationId": "updateRole", "parameters": [ { "name": "uid", "in": "query", "description": "ID of role to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Role object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/notifications": { "get": { "tags": ["super-admin"], "summary": "Get all notifications", "description": "", "operationId": "getNotifications", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/notifications/{uid}": { "put": { "tags": ["super-admin"], "summary": "Update an existing notification", "description": "Returns a single notification updated", "operationId": "updateNotification", "parameters": [ { "name": "uid", "in": "path", "description": "ID of notification to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Notification object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "get": { "tags": ["super-admin"], "summary": "Find notification by ID", "description": "Returns a single notification", "operationId": "getNotificationById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of notification to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/users": { "get": { "tags": ["super-admin"], "summary": "Get all users", "description": "", "operationId": "getUsers", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/users/{uid}": { "get": { "tags": ["super-admin"], "summary": "Find user by ID", "description": "", "operationId": "getUserById", "parameters": [ { "name": "uid", "in": "query", "description": "ID of user to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": ["super-admin"], "summary": "Update an existing user", "description": "", "operationId": "updateUser", "parameters": [ { "name": "uid", "in": "query", "description": "ID of user to return", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/live-votes": { "post": { "tags": ["super-admin"], "summary": "Add a new live vote", "description": "", "operationId": "addLiveVote", "requestBody": { "description": "LiveVote object that needs to be added to the store", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveVote" } } } }, "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } }, "/super-admin/live-votes/{uid}": { "delete": { "tags": ["super-admin"], "summary": "Delete an existing live vote", "description": "Returns a single live vote deleted", "operationId": "deleteLiveVote", "parameters": [ { "name": "uid", "in": "path", "description": "ID of live vote to return", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Invalid status value" } }, "security": [ { "bearerAuth": [] } ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "Customer": { "type": "object", "properties": { "uid": { "type": "string" }, "status": { "type": "string" }, "contact": { "type": "object", "properties": { "civility": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "cell_phone_number": { "type": "string" } } }, "office_folders": { "type": "array", "items": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "office": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } } } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } }, "file": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } }, "folder": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } } } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "Document": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } }, "file": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } }, "folder": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "DocumentType": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "office": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "Deed": { "type": "object", "properties": { "uid": { "type": "string" }, "deed_type": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "archived_at": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "document_types": { "type": "array", "items": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "public_description": { "type": "string" }, "private_description": { "type": "string" }, "archived_at": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } } }, "office": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } }, "folder": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "DeedType": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "archived_at": { "type": "string" }, "office": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "File": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "size": { "type": "string" }, "mime_type": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "Folder": { "type": "object", "properties": { "uid": { "type": "string" }, "deed": { "type": "object", "properties": { "uid": { "type": "string" }, "deed_type": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "archived_at": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } } } }, "office": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "User": { "type": "object", "properties": { "uid": { "type": "string" }, "idNot": { "type": "string" }, "contact": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "cell_phone_number": { "type": "string" } } }, "office_folders": { "type": "array", "items": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "office": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } } } } }, "role": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } } } } }, "office_role": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } } }, "office": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } } } } } }, "OfficeRole": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } } }, "office": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } } } }, "Role": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } } } } }, "Office": { "type": "object", "properties": { "uid": { "type": "string" }, "name": { "type": "string" } } }, "Vote": { "type": "object", "properties": { "uid": { "type": "string" }, "appointment": { "type": "object", "properties": { "uid": { "type": "string" }, "user": { "type": "object", "properties": { "uid": { "type": "string" } } }, "status": { "type": "string" }, "choice": { "type": "string" } } }, "voter": { "type": "object", "properties": { "uid": { "type": "string" } } } } }, "Appointment": { "type": "object", "properties": { "uid": { "type": "string" }, "user": { "type": "object", "properties": { "uid": { "type": "string" } } }, "status": { "type": "string" }, "choice": { "type": "string" }, "votes": { "type": "array", "items": { "type": "object", "properties": { "uid": { "type": "string" }, "voter": { "type": "object", "properties": { "uid": { "type": "string" } } } } } } } } } }, "externalDocs": { "description": "Find out more about Swagger", "url": "http://swagger.io" } }