6195 lines
152 KiB
JSON
6195 lines
152 KiB
JSON
{
|
|
"swagger": "2.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"
|
|
},
|
|
"host": "localhost:3000",
|
|
"basePath": "/api/v1",
|
|
"tags": [
|
|
{
|
|
"name": "customer"
|
|
},
|
|
{
|
|
"name": "notary"
|
|
},
|
|
{
|
|
"name": "admin"
|
|
},
|
|
{
|
|
"name": "super-admin"
|
|
}
|
|
],
|
|
"schemes": ["http", "https"],
|
|
"paths": {
|
|
"notary/customers": {
|
|
"get": {
|
|
"tags": ["notary"],
|
|
"summary": "Get all customers",
|
|
"description": "",
|
|
"operationId": "getCustomers",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["notary"],
|
|
"summary": "Add a new customer",
|
|
"description": "",
|
|
"operationId": "addCustomer",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Customer object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of customer to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": ["notary"],
|
|
"summary": "Update an existing customer",
|
|
"description": "Returns a single customer updated",
|
|
"operationId": "updateCustomer",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of customer to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Customer object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": ["notary"],
|
|
"summary": "Delete an existing customer",
|
|
"description": "Returns a single customer deleted",
|
|
"operationId": "deleteCustomer",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of customer to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"notary/deeds": {
|
|
"get": {
|
|
"tags": ["notary"],
|
|
"summary": "Get all deeds",
|
|
"description": "",
|
|
"operationId": "getDeeds",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["notary"],
|
|
"summary": "Add a new deed",
|
|
"description": "",
|
|
"operationId": "addDeed",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Deed object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": ["notary"],
|
|
"summary": "Update an existing deed",
|
|
"description": "Returns a single deed updated",
|
|
"operationId": "updateDeed",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Deed object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": ["notary"],
|
|
"summary": "Delete an existing deed",
|
|
"description": "Returns a single deed deleted",
|
|
"operationId": "deleteDeed",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Deed object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"notary/deed-types": {
|
|
"get": {
|
|
"tags": ["notary"],
|
|
"summary": "Get all deed types",
|
|
"description": "",
|
|
"operationId": "getDeedTypes",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeedType"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["notary"],
|
|
"summary": "Add a new deed type",
|
|
"description": "",
|
|
"operationId": "addDeedType",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "DeedType object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DeedType"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "DeedType object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DeedType"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeedType"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"notary/documents": {
|
|
"get": {
|
|
"tags": ["notary"],
|
|
"summary": "Get all documents",
|
|
"description": "",
|
|
"operationId": "getDocuments",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["notary"],
|
|
"summary": "Add a new document",
|
|
"description": "",
|
|
"operationId": "addDocument",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Document object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": ["notary"],
|
|
"summary": "Update an existing document",
|
|
"description": "Returns a single document updated",
|
|
"operationId": "updateDocument",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Document object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": ["notary"],
|
|
"summary": "Delete an existing document",
|
|
"description": "Returns a single document deleted",
|
|
"operationId": "deleteDocument",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Document object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"notary/document-types": {
|
|
"get": {
|
|
"tags": ["notary"],
|
|
"summary": "Get all document types",
|
|
"description": "",
|
|
"operationId": "getDocumentTypes",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/DocumentType"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["notary"],
|
|
"summary": "Add a new document type",
|
|
"description": "",
|
|
"operationId": "addDocumentType",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "DocumentType object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DocumentType"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "DocumentType object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DocumentType"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/DocumentType"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"notary/files": {
|
|
"get": {
|
|
"tags": ["notary"],
|
|
"summary": "Get all files",
|
|
"description": "",
|
|
"operationId": "getFiles",
|
|
"produces": ["application/json"],
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of file to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of file to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of file to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of anchor to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of anchor to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Anchor object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of anchor to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["notary"],
|
|
"summary": "Add a new folder",
|
|
"description": "",
|
|
"operationId": "addFolder",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Folder object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of folder to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Folder object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of folder to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of folder to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Folder"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"notary/office-roles": {
|
|
"get": {
|
|
"tags": ["notary"],
|
|
"summary": "Get all office roles",
|
|
"description": "",
|
|
"operationId": "getOfficeRoles",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of office role to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/OfficeRole"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"notary/offices": {
|
|
"get": {
|
|
"tags": ["notary"],
|
|
"summary": "Get all offices",
|
|
"description": "",
|
|
"operationId": "getOffices",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of office to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Office"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"notary/roles": {
|
|
"get": {
|
|
"tags": ["notary"],
|
|
"summary": "Get all roles",
|
|
"description": "",
|
|
"operationId": "getRoles",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of role to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Role"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"notary/notifications": {
|
|
"get": {
|
|
"tags": ["notary"],
|
|
"summary": "Get all notifications",
|
|
"description": "",
|
|
"operationId": "getNotifications",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of notification to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Notification object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of notification to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Notification"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"notary/users": {
|
|
"get": {
|
|
"tags": ["notary"],
|
|
"summary": "Get all users",
|
|
"description": "",
|
|
"operationId": "getUsers",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/User"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"notary/users/{uid}": {
|
|
"get": {
|
|
"tags": ["notary"],
|
|
"summary": "Find user by ID",
|
|
"description": "",
|
|
"operationId": "getUserById",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of user to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/User"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"customers/documents": {
|
|
"get": {
|
|
"tags": ["customer"],
|
|
"summary": "Get all documents",
|
|
"description": "",
|
|
"operationId": "getDocuments",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["customer"],
|
|
"summary": "Add a new document",
|
|
"description": "",
|
|
"operationId": "addDocument",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Document object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"customers/documents/{uid}": {
|
|
"get": {
|
|
"tags": ["customer"],
|
|
"summary": "Find document by ID",
|
|
"description": "Returns a single document",
|
|
"operationId": "getDocumentById",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"customers/files": {
|
|
"get": {
|
|
"tags": ["customer"],
|
|
"summary": "Get all files",
|
|
"description": "",
|
|
"operationId": "getFiles",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["customer"],
|
|
"summary": "Add a new file",
|
|
"description": "",
|
|
"operationId": "addFile",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "File object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/File"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"customers/files/{uid}": {
|
|
"get": {
|
|
"tags": ["customer"],
|
|
"summary": "Find file by ID",
|
|
"description": "Returns a single file",
|
|
"operationId": "getFileById",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of file to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of file to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "File object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of file to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"customers/folders": {
|
|
"get": {
|
|
"tags": ["customer"],
|
|
"summary": "Get all folders",
|
|
"description": "",
|
|
"operationId": "getFolders",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Folder"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"customers/folders/{uid}": {
|
|
"get": {
|
|
"tags": ["customer"],
|
|
"summary": "Find folder by ID",
|
|
"description": "Returns a single folder",
|
|
"operationId": "getFolderById",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of folder to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["admin"],
|
|
"summary": "Add a new customer",
|
|
"description": "",
|
|
"operationId": "addCustomer",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Customer object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of customer to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": ["admin"],
|
|
"summary": "Update an existing customer",
|
|
"description": "Returns a single customer updated",
|
|
"operationId": "updateCustomer",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of customer to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Customer object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": ["admin"],
|
|
"summary": "Delete an existing customer",
|
|
"description": "Returns a single customer deleted",
|
|
"operationId": "deleteCustomer",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of customer to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"admin/deeds": {
|
|
"get": {
|
|
"tags": ["admin"],
|
|
"summary": "Get all deeds",
|
|
"description": "",
|
|
"operationId": "getDeeds",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["admin"],
|
|
"summary": "Add a new deed",
|
|
"description": "",
|
|
"operationId": "addDeed",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Deed object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": ["admin"],
|
|
"summary": "Update an existing deed",
|
|
"description": "Returns a single deed updated",
|
|
"operationId": "updateDeed",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Deed object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": ["admin"],
|
|
"summary": "Delete an existing deed",
|
|
"description": "Returns a single deed deleted",
|
|
"operationId": "deleteDeed",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Deed object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"admin/deed-types": {
|
|
"get": {
|
|
"tags": ["admin"],
|
|
"summary": "Get all deed types",
|
|
"description": "",
|
|
"operationId": "getDeedTypes",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeedType"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["admin"],
|
|
"summary": "Add a new deed type",
|
|
"description": "",
|
|
"operationId": "addDeedType",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "DeedType object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DeedType"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "DeedType object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DeedType"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeedType"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"admin/documents": {
|
|
"get": {
|
|
"tags": ["admin"],
|
|
"summary": "Get all documents",
|
|
"description": "",
|
|
"operationId": "getDocuments",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["admin"],
|
|
"summary": "Add a new document",
|
|
"description": "",
|
|
"operationId": "addDocument",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Document object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": ["admin"],
|
|
"summary": "Update an existing document",
|
|
"description": "Returns a single document updated",
|
|
"operationId": "updateDocument",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Document object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"delete": {
|
|
"tags": ["admin"],
|
|
"summary": "Delete an existing document",
|
|
"description": "Returns a single document deleted",
|
|
"operationId": "deleteDocument",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Document object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"admin/document-types": {
|
|
"get": {
|
|
"tags": ["admin"],
|
|
"summary": "Get all document types",
|
|
"description": "",
|
|
"operationId": "getDocumentTypes",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/DocumentType"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["admin"],
|
|
"summary": "Add a new document type",
|
|
"description": "",
|
|
"operationId": "addDocumentType",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "DocumentType object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DocumentType"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "DocumentType object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DocumentType"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/DocumentType"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"admin/files": {
|
|
"get": {
|
|
"tags": ["admin"],
|
|
"summary": "Get all files",
|
|
"description": "",
|
|
"operationId": "getFiles",
|
|
"produces": ["application/json"],
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of file to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of file to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of file to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of anchor to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of anchor to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Anchor object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of anchor to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["admin"],
|
|
"summary": "Add a new folder",
|
|
"description": "",
|
|
"operationId": "addFolder",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Folder object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of folder to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Folder object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of folder to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of folder to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Folder"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"admin/office-roles": {
|
|
"get": {
|
|
"tags": ["admin"],
|
|
"summary": "Get all office roles",
|
|
"description": "",
|
|
"operationId": "getOfficeRoles",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/OfficeRole"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["admin"],
|
|
"summary": "Add a new office role",
|
|
"description": "",
|
|
"operationId": "addOfficeRole",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "OfficeRole object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/OfficeRole"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of office role to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of office role to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "OfficeRole object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/OfficeRole"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/OfficeRole"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"admin/offices": {
|
|
"get": {
|
|
"tags": ["admin"],
|
|
"summary": "Get all offices",
|
|
"description": "",
|
|
"operationId": "getOffices",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of office to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Office"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"admin/roles": {
|
|
"get": {
|
|
"tags": ["admin"],
|
|
"summary": "Get all roles",
|
|
"description": "",
|
|
"operationId": "getRoles",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of role to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Role"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"admin/notifications": {
|
|
"get": {
|
|
"tags": ["admin"],
|
|
"summary": "Get all notifications",
|
|
"description": "",
|
|
"operationId": "getNotifications",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of notification to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Notification object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of notification to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Notification"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"admin/users": {
|
|
"get": {
|
|
"tags": ["admin"],
|
|
"summary": "Get all users",
|
|
"description": "",
|
|
"operationId": "getUsers",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/User"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"admin/users/{uid}": {
|
|
"get": {
|
|
"tags": ["admin"],
|
|
"summary": "Find user by ID",
|
|
"description": "",
|
|
"operationId": "getUserById",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of user to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/User"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": ["admin"],
|
|
"summary": "Update an existing user",
|
|
"description": "",
|
|
"operationId": "updateUser",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of user to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "User object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Add a new customer",
|
|
"description": "",
|
|
"operationId": "addCustomer",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Customer object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of customer to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of customer to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Customer object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of customer to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Customer"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"super-admin/deeds": {
|
|
"get": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Get all deeds",
|
|
"description": "",
|
|
"operationId": "getDeeds",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Add a new deed",
|
|
"description": "",
|
|
"operationId": "addDeed",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Deed object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Deed object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Deed object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Deed"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"super-admin/deed-types": {
|
|
"get": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Get all deed types",
|
|
"description": "",
|
|
"operationId": "getDeedTypes",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeedType"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Add a new deed type",
|
|
"description": "",
|
|
"operationId": "addDeedType",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "DeedType object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DeedType"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of deed type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "DeedType object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DeedType"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/DeedType"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"super-admin/documents": {
|
|
"get": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Get all documents",
|
|
"description": "",
|
|
"operationId": "getDocuments",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Add a new document",
|
|
"description": "",
|
|
"operationId": "addDocument",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Document object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Document object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Document object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Document"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"super-admin/document-types": {
|
|
"get": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Get all document types",
|
|
"description": "",
|
|
"operationId": "getDocumentTypes",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/DocumentType"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Add a new document type",
|
|
"description": "",
|
|
"operationId": "addDocumentType",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "DocumentType object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DocumentType"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "DocumentType object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/DocumentType"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of document type to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/DocumentType"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"super-admin/files": {
|
|
"get": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Get all files",
|
|
"description": "",
|
|
"operationId": "getFiles",
|
|
"produces": ["application/json"],
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of file to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of file to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of file to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of anchor to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of anchor to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Anchor object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of anchor to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Add a new folder",
|
|
"description": "",
|
|
"operationId": "addFolder",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Folder object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of folder to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Folder object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of folder to return",
|
|
"required": true,
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of folder to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Folder"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"super-admin/office-roles": {
|
|
"get": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Get all office roles",
|
|
"description": "",
|
|
"operationId": "getOfficeRoles",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/OfficeRole"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Add a new office role",
|
|
"description": "",
|
|
"operationId": "addOfficeRole",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "OfficeRole object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/OfficeRole"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of office role to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of office role to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "OfficeRole object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/OfficeRole"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/OfficeRole"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"super-admin/offices": {
|
|
"get": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Get all offices",
|
|
"description": "",
|
|
"operationId": "getOffices",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Office"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Add a new office",
|
|
"description": "",
|
|
"operationId": "addOffice",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Office object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Office"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of office to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of office to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Office object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Office"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Office"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"super-admin/roles": {
|
|
"get": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Get all roles",
|
|
"description": "",
|
|
"operationId": "getRoles",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Role"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"post": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Add a new role",
|
|
"description": "",
|
|
"operationId": "addRole",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Role object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Role"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of role to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of role to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Role object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Role"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"$ref": "#/definitions/Role"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"super-admin/notifications": {
|
|
"get": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Get all notifications",
|
|
"description": "",
|
|
"operationId": "getNotifications",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of notification to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "Notification object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of notification to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/Notification"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"super-admin/users": {
|
|
"get": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Get all users",
|
|
"description": "",
|
|
"operationId": "getUsers",
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/User"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"super-admin/users/{uid}": {
|
|
"get": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Find user by ID",
|
|
"description": "",
|
|
"operationId": "getUserById",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of user to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/User"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
},
|
|
"put": {
|
|
"tags": ["super-admin"],
|
|
"summary": "Update an existing user",
|
|
"description": "",
|
|
"operationId": "updateUser",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "query",
|
|
"description": "ID of user to return",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "User object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"in": "body",
|
|
"name": "body",
|
|
"description": "LiveVote object that needs to be added to the store",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/Vote"
|
|
}
|
|
}
|
|
],
|
|
"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",
|
|
"produces": ["application/json"],
|
|
"parameters": [
|
|
{
|
|
"name": "uid",
|
|
"in": "path",
|
|
"description": "ID of live vote to return",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid status value"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"securityDefinitions": {
|
|
"bearerAuth": {
|
|
"type": "http",
|
|
"scheme": "bearer",
|
|
"bearerFormat": "JWT"
|
|
}
|
|
},
|
|
"responses": {
|
|
"UnauthorizedError": {
|
|
"description": "Authentication information is missing or invalid",
|
|
"headers": {
|
|
"WWW_Authenticate": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"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": {
|
|
"types": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uid": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"office_role": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uid": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"rules": {
|
|
"types": "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": {
|
|
"types": "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": {
|
|
"types": "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"
|
|
}
|
|
}
|