{ "components": { "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" } } }, "info": { "title": "User service reference", "version": "1.0.0" }, "openapi": "3.0.3", "paths": { "/api/v1/users": { "get": { "operationId": "user_ListUsers", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int64", "maximum": 1000000, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "pageSize", "required": false, "schema": { "default": 20, "format": "int64", "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "data": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "email": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "email", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "pageSize": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "items", "total", "page", "pageSize" ], "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "413": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "415": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "500": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" } }, "summary": "", "x-omni-middleware": [ "Auth" ] }, "post": { "operationId": "user_CreateUser", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "email": { "format": "email", "maxLength": 254, "minLength": 1, "type": "string" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "name", "email" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "data": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "email": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "email", "createdAt", "updatedAt" ], "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "413": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "415": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "500": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" } }, "summary": "", "x-omni-middleware": [ "Auth" ] } }, "/api/v1/users/{id}": { "delete": { "operationId": "user_DeleteUser", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } } ], "responses": { "204": { "description": "Success" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "413": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "415": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "500": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" } }, "summary": "", "x-omni-middleware": [ "Auth" ] }, "get": { "operationId": "user_GetUser", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "data": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "email": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "email", "createdAt", "updatedAt" ], "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "413": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "415": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "500": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" } }, "summary": "", "x-omni-middleware": [ "Auth" ] }, "put": { "operationId": "user_UpdateUser", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "email": { "format": "email", "maxLength": 254, "minLength": 1, "type": "string" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "name", "email" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "data": { "additionalProperties": false, "properties": { "createdAt": { "type": "string" }, "email": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "email", "createdAt", "updatedAt" ], "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "413": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "415": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "500": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" } }, "summary": "", "x-omni-middleware": [ "Auth" ] } }, "/api/v1/users/{id}/export": { "post": { "operationId": "user_ExportUser", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "maximum": 9007199254740991, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "data": { "additionalProperties": false, "properties": { "downloadUrl": { "type": "string" } }, "required": [ "downloadUrl" ], "type": "object" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "413": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "415": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "500": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" }, "501": { "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } } }, "description": "Error" } }, "summary": "Export one user as a private text object with a short-lived download link", "x-omni-middleware": [ "Auth" ] } } } }