{ "openapi": "3.0.0", "info": { "title": "sigas-api", "version": "0.0.1", "description": "SIGAS-API", "contact": { "name": "Rennan Maia", "email": "rennanmaia@gmail.com" } }, "paths": { "/admin/deliveries/{id}/retry": { "post": { "x-controller-name": "NotificationAdminController", "x-operation-name": "retryDelivery", "tags": [ "NotificationAdminController" ], "responses": { "200": { "description": "Retried delivery instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDelivery" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NotificationAdminController.retryDelivery" } }, "/admin/deliveries": { "get": { "x-controller-name": "NotificationAdminController", "x-operation-name": "listDeliveries", "tags": [ "NotificationAdminController" ], "responses": { "200": { "description": "List of all deliveries (Admin)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDeliveryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDelivery.Filter" } } } } ], "operationId": "NotificationAdminController.listDeliveries" } }, "/admin/notification-logs": { "get": { "x-controller-name": "NotificationAdminController", "x-operation-name": "listLogs", "tags": [ "NotificationAdminController" ], "responses": { "200": { "description": "List of all notification logs (Admin)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationLogWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationLog.Filter" } } } } ], "operationId": "NotificationAdminController.listLogs" } }, "/admin/notifications/{id}/cancel": { "post": { "x-controller-name": "NotificationAdminController", "x-operation-name": "cancelNotification", "tags": [ "NotificationAdminController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Notification successfully cancelled" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NotificationAdminController.cancelNotification" } }, "/admin/notifications": { "get": { "x-controller-name": "NotificationAdminController", "x-operation-name": "listNotifications", "tags": [ "NotificationAdminController" ], "responses": { "200": { "description": "List of all notifications (Admin)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification.Filter" } } } } ], "operationId": "NotificationAdminController.listNotifications" } }, "/admin/templates/{id}": { "patch": { "x-controller-name": "NotificationAdminController", "x-operation-name": "updateTemplate", "tags": [ "NotificationAdminController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Template updated successfully" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "NotificationAdminController.updateTemplate" }, "delete": { "x-controller-name": "NotificationAdminController", "x-operation-name": "deleteTemplate", "tags": [ "NotificationAdminController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Template soft deleted successfully" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NotificationAdminController.deleteTemplate" } }, "/admin/templates": { "post": { "x-controller-name": "NotificationAdminController", "x-operation-name": "createTemplate", "tags": [ "NotificationAdminController" ], "responses": { "200": { "description": "Created notification template instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "NotificationAdminController.createTemplate" }, "get": { "x-controller-name": "NotificationAdminController", "x-operation-name": "listTemplates", "tags": [ "NotificationAdminController" ], "responses": { "200": { "description": "List of templates", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationTemplateWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate.Filter" } } } } ], "operationId": "NotificationAdminController.listTemplates" } }, "/campaigns/{id}/launch": { "post": { "x-controller-name": "NotificationCampaignController", "x-operation-name": "launch", "tags": [ "NotificationCampaignController" ], "responses": { "200": { "description": "Launched campaign instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationCampaign" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "NotificationCampaignController.launch" } }, "/campaigns/{id}/refresh": { "post": { "x-controller-name": "NotificationCampaignController", "x-operation-name": "refresh", "tags": [ "NotificationCampaignController" ], "responses": { "200": { "description": "Refreshed campaign metrics", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationCampaign" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NotificationCampaignController.refresh" } }, "/campaigns/{id}": { "get": { "x-controller-name": "NotificationCampaignController", "x-operation-name": "findById", "tags": [ "NotificationCampaignController" ], "responses": { "200": { "description": "Campaign by ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationCampaignWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NotificationCampaignController.findById" } }, "/campaigns": { "post": { "x-controller-name": "NotificationCampaignController", "x-operation-name": "create", "tags": [ "NotificationCampaignController" ], "responses": { "200": { "description": "Created campaign instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationCampaign" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "NotificationCampaignController.create" }, "get": { "x-controller-name": "NotificationCampaignController", "x-operation-name": "find", "tags": [ "NotificationCampaignController" ], "responses": { "200": { "description": "List of campaigns", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationCampaignWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationCampaign.Filter" } } } } ], "operationId": "NotificationCampaignController.find" } }, "/conversations/contacts": { "get": { "x-controller-name": "ChatController", "x-operation-name": "listContacts", "tags": [ "ChatController" ], "responses": { "200": { "description": "Array of users available to start a conversation with", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatContactDto" } } } } } }, "operationId": "ChatController.listContacts" } }, "/conversations/{id}/messages": { "get": { "x-controller-name": "ChatController", "x-operation-name": "getMessages", "tags": [ "ChatController" ], "responses": { "200": { "description": "Array of messages (newest first)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMessage" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "before", "in": "query", "schema": { "type": "string" } } ], "operationId": "ChatController.getMessages" } }, "/conversations/{id}/read": { "post": { "x-controller-name": "ChatController", "x-operation-name": "markAsRead", "tags": [ "ChatController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Messages marked as read" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ChatController.markAsRead" } }, "/conversations": { "post": { "x-controller-name": "ChatController", "x-operation-name": "createConversation", "tags": [ "ChatController" ], "responses": { "200": { "description": "Conversation created or found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConversationRequest" } } } }, "operationId": "ChatController.createConversation" }, "get": { "x-controller-name": "ChatController", "x-operation-name": "listConversations", "tags": [ "ChatController" ], "responses": { "200": { "description": "Array of conversations with metadata", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationWithMetadata" } } } } } }, "operationId": "ChatController.listConversations" } }, "/devices/register": { "post": { "x-controller-name": "UserDeviceController", "x-operation-name": "register", "tags": [ "UserDeviceController" ], "responses": { "200": { "description": "Registered device instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDevice" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterDeviceRequest" } } } }, "operationId": "UserDeviceController.register" } }, "/devices/revoke": { "post": { "x-controller-name": "UserDeviceController", "x-operation-name": "revoke", "tags": [ "UserDeviceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Device token revoked successfully" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeDeviceRequest" } } } }, "operationId": "UserDeviceController.revoke" } }, "/devices/revoke-all": { "post": { "x-controller-name": "UserDeviceController", "x-operation-name": "revokeAll", "tags": [ "UserDeviceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "All user devices revoked successfully" } } } } }, "operationId": "UserDeviceController.revokeAll" } }, "/devices": { "get": { "x-controller-name": "UserDeviceController", "x-operation-name": "list", "tags": [ "UserDeviceController" ], "responses": { "200": { "description": "Active devices registered for the current user", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserDevice" } } } } } }, "operationId": "UserDeviceController.list" } }, "/notifications/read-all": { "post": { "x-controller-name": "NotificationController", "x-operation-name": "markAllRead", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Success status of marking all notifications as read", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "operationId": "NotificationController.markAllRead" } }, "/notifications/unread-count": { "get": { "x-controller-name": "NotificationController", "x-operation-name": "unreadCount", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Number of unread notifications for the current user", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" } } } } } } }, "operationId": "NotificationController.unreadCount" } }, "/notifications/{id}/read": { "patch": { "x-controller-name": "NotificationController", "x-operation-name": "markRead", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Notification marked as read", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NotificationController.markRead" } }, "/notifications/{id}": { "delete": { "x-controller-name": "NotificationController", "x-operation-name": "delete", "tags": [ "NotificationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Notification deleted successfully" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NotificationController.delete" } }, "/notifications": { "get": { "x-controller-name": "NotificationController", "x-operation-name": "find", "tags": [ "NotificationController" ], "responses": { "200": { "description": "List of notifications for the current user", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification.Filter" } } } } ], "operationId": "NotificationController.find" } }, "/v1/admin/integrations/{id}/activate": { "patch": { "x-controller-name": "IntegrationController", "x-operation-name": "activateProvider", "tags": [ "IntegrationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Provider activated" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "IntegrationController.activateProvider" } }, "/v1/admin/integrations/{category}/active": { "get": { "x-controller-name": "IntegrationController", "x-operation-name": "getActiveConfigs", "tags": [ "IntegrationController" ], "responses": { "200": { "description": "Active provider configs", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveProviderConfigDto" } } } } } }, "parameters": [ { "name": "category", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "IntegrationController.getActiveConfigs" } }, "/v1/admin/integrations/{id}/deactivate": { "patch": { "x-controller-name": "IntegrationController", "x-operation-name": "deactivateProvider", "tags": [ "IntegrationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Provider deactivated" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "IntegrationController.deactivateProvider" } }, "/v1/admin/integrations/{category}/test": { "post": { "x-controller-name": "IntegrationController", "x-operation-name": "testProvider", "tags": [ "IntegrationController" ], "responses": { "200": { "description": "Test connection result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestConnectionResponse" } } } } }, "parameters": [ { "name": "category", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestProviderRequest" } } }, "x-parameter-index": 1 }, "operationId": "IntegrationController.testProvider" } }, "/v1/admin/integrations/{category}": { "put": { "x-controller-name": "IntegrationController", "x-operation-name": "saveConfig", "tags": [ "IntegrationController" ], "responses": { "200": { "description": "Saved integration config", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationConfig" } } } } }, "parameters": [ { "name": "category", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveConfigRequest" } } }, "x-parameter-index": 1 }, "operationId": "IntegrationController.saveConfig" } }, "/v1/admin/integrations/{id}": { "delete": { "x-controller-name": "IntegrationController", "x-operation-name": "deleteConfig", "tags": [ "IntegrationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Config deleted" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "IntegrationController.deleteConfig" } }, "/v1/admin/integrations": { "get": { "x-controller-name": "IntegrationController", "x-operation-name": "listProviders", "tags": [ "IntegrationController" ], "responses": { "200": { "description": "Provider list with config status", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderMetadataDto" } } } } } }, "parameters": [ { "name": "category", "in": "query", "schema": { "type": "string" } } ], "operationId": "IntegrationController.listProviders" } }, "/v1/audio-questions/count": { "get": { "x-controller-name": "AudioQuestionController", "x-operation-name": "count", "tags": [ "AudioQuestionController" ], "responses": { "200": { "description": "AudioQuestion model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "AudioQuestion.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "AudioQuestionController.count" } }, "/v1/audio-questions/{id}": { "patch": { "x-controller-name": "AudioQuestionController", "x-operation-name": "updateById", "tags": [ "AudioQuestionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AudioQuestion PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "AudioQuestionController.updateById" }, "get": { "x-controller-name": "AudioQuestionController", "x-operation-name": "findById", "tags": [ "AudioQuestionController" ], "responses": { "200": { "description": "AudioQuestion model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioQuestionWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AudioQuestionController.findById" }, "delete": { "x-controller-name": "AudioQuestionController", "x-operation-name": "deleteById", "tags": [ "AudioQuestionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AudioQuestion DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AudioQuestionController.deleteById" } }, "/v1/audio-questions": { "post": { "x-controller-name": "AudioQuestionController", "x-operation-name": "create", "tags": [ "AudioQuestionController" ], "responses": { "200": { "description": "AudioQuestion model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioQuestion" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AudioQuestionController.create" }, "get": { "x-controller-name": "AudioQuestionController", "x-operation-name": "find", "tags": [ "AudioQuestionController" ], "responses": { "200": { "description": "Array of AudioQuestion instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AudioQuestionWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "AudioQuestionController.find" } }, "/v1/auth/account-recovery": { "post": { "x-controller-name": "AuthController", "x-operation-name": "accountRecovery", "tags": [ "AuthController" ], "responses": { "200": { "description": "Dedicated account recovery initiation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountRecoveryRequest" } } } }, "operationId": "AuthController.accountRecovery" } }, "/v1/auth/complete-registration": { "post": { "x-controller-name": "AuthController", "x-operation-name": "completeRegistration", "tags": [ "AuthController" ], "responses": { "200": { "description": "Complete user registration using code and set password", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteRegistrationRequest" } } } }, "operationId": "AuthController.completeRegistration" } }, "/v1/auth/login": { "post": { "x-controller-name": "AuthController", "x-operation-name": "login", "tags": [ "AuthController" ], "responses": { "200": { "description": "User login", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } } }, "operationId": "AuthController.login" } }, "/v1/auth/logout": { "post": { "x-controller-name": "AuthController", "x-operation-name": "logout", "tags": [ "AuthController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Logged out successfully" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogoutRequest" } } }, "required": false }, "operationId": "AuthController.logout" } }, "/v1/auth/logout-all": { "post": { "x-controller-name": "AuthController", "x-operation-name": "logoutAll", "tags": [ "AuthController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Logged out of all devices successfully" } } } } }, "operationId": "AuthController.logoutAll" } }, "/v1/auth/me": { "get": { "x-controller-name": "AuthController", "x-operation-name": "me", "tags": [ "AuthController" ], "responses": { "200": { "description": "Current authenticated user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentUserResponse" } } } } }, "operationId": "AuthController.me" } }, "/v1/auth/mfa/challenge/{id}/resend": { "post": { "x-controller-name": "MfaController", "x-operation-name": "resendChallengeCode", "tags": [ "MfaController" ], "responses": { "200": { "description": "Resend the email code for a challenge", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MfaController.resendChallengeCode" } }, "/v1/auth/mfa/challenge/{id}/respond": { "post": { "x-controller-name": "MfaController", "x-operation-name": "respondToChallenge", "tags": [ "MfaController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Challenge response recorded" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RespondChallengeRequest" } } }, "x-parameter-index": 1 }, "operationId": "MfaController.respondToChallenge" } }, "/v1/auth/mfa/challenge/{id}": { "get": { "x-controller-name": "MfaController", "x-operation-name": "getChallengeStatus", "tags": [ "MfaController" ], "responses": { "200": { "description": "Poll a login challenge status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaChallengeStatusResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MfaController.getChallengeStatus" } }, "/v1/auth/mfa/email/confirm": { "post": { "x-controller-name": "MfaController", "x-operation-name": "confirmEmail", "tags": [ "MfaController" ], "responses": { "200": { "description": "Confirms email 2FA activation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaCodeConfirmRequest" } } } }, "operationId": "MfaController.confirmEmail" } }, "/v1/auth/mfa/email/disable": { "post": { "x-controller-name": "MfaController", "x-operation-name": "disableEmail", "tags": [ "MfaController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Email 2FA disabled" } } } } }, "operationId": "MfaController.disableEmail" } }, "/v1/auth/mfa/email/enable": { "post": { "x-controller-name": "MfaController", "x-operation-name": "enableEmail", "tags": [ "MfaController" ], "responses": { "200": { "description": "Sends an email confirmation code to enable email 2FA", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponse" } } } } }, "operationId": "MfaController.enableEmail" } }, "/v1/auth/mfa/pending-challenges": { "get": { "x-controller-name": "MfaController", "x-operation-name": "listPendingChallenges", "tags": [ "MfaController" ], "responses": { "200": { "description": "Pending login-approval requests for this account", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PendingChallengeSummary" } } } } } }, "operationId": "MfaController.listPendingChallenges" } }, "/v1/auth/mfa/status": { "get": { "x-controller-name": "MfaController", "x-operation-name": "getStatus", "tags": [ "MfaController" ], "responses": { "200": { "description": "Current MFA enrollment status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaStatusResponse" } } } } }, "parameters": [ { "name": "deviceId", "in": "query", "schema": { "type": "string" } } ], "operationId": "MfaController.getStatus" } }, "/v1/auth/mfa/totp/confirm": { "post": { "x-controller-name": "MfaController", "x-operation-name": "confirmTotp", "tags": [ "MfaController" ], "responses": { "200": { "description": "Confirms TOTP activation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaCodeConfirmRequest" } } } }, "operationId": "MfaController.confirmTotp" } }, "/v1/auth/mfa/totp/disable": { "post": { "x-controller-name": "MfaController", "x-operation-name": "disableTotp", "tags": [ "MfaController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TOTP disabled" } } } } }, "operationId": "MfaController.disableTotp" } }, "/v1/auth/mfa/totp/setup": { "post": { "x-controller-name": "MfaController", "x-operation-name": "setupTotp", "tags": [ "MfaController" ], "responses": { "200": { "description": "TOTP secret + QR code for enrollment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotpSetupResponse" } } } } }, "operationId": "MfaController.setupTotp" } }, "/v1/auth/mfa/trusted-devices/{id}": { "delete": { "x-controller-name": "MfaController", "x-operation-name": "revokeTrustedDevice", "tags": [ "MfaController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Trusted device revoked" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MfaController.revokeTrustedDevice" } }, "/v1/auth/mfa/trusted-devices": { "get": { "x-controller-name": "MfaController", "x-operation-name": "listTrustedDevices", "tags": [ "MfaController" ], "responses": { "200": { "description": "Devices trusted to skip MFA (adaptive/risk-based)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrustedDeviceSummary" } } } } } }, "parameters": [ { "name": "deviceId", "in": "query", "schema": { "type": "string" } } ], "operationId": "MfaController.listTrustedDevices" } }, "/v1/auth/mfa/verify": { "post": { "x-controller-name": "MfaController", "x-operation-name": "verify", "tags": [ "MfaController" ], "responses": { "200": { "description": "Completes an MFA challenge and returns a token pair", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaVerifyRequest" } } } }, "operationId": "MfaController.verify" } }, "/v1/auth/mfa/webauthn/authenticate/options": { "post": { "x-controller-name": "MfaController", "x-operation-name": "getWebauthnAuthenticateOptions", "tags": [ "MfaController" ], "responses": { "200": { "description": "Return value of MfaController.getWebauthnAuthenticateOptions" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebauthnAuthOptionsRequest" } } } }, "operationId": "MfaController.getWebauthnAuthenticateOptions" } }, "/v1/auth/mfa/webauthn/register/options": { "post": { "x-controller-name": "MfaController", "x-operation-name": "getWebauthnRegisterOptions", "tags": [ "MfaController" ], "responses": { "200": { "description": "Return value of MfaController.getWebauthnRegisterOptions" } }, "operationId": "MfaController.getWebauthnRegisterOptions" } }, "/v1/auth/mfa/webauthn/register/verify": { "post": { "x-controller-name": "MfaController", "x-operation-name": "verifyWebauthnRegistration", "tags": [ "MfaController" ], "responses": { "200": { "description": "Newly registered WebAuthn credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebauthnCredentialSummary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebauthnRegisterVerifyRequest" } } } }, "operationId": "MfaController.verifyWebauthnRegistration" } }, "/v1/auth/mfa/webauthn/{credentialId}": { "delete": { "x-controller-name": "MfaController", "x-operation-name": "removeWebauthnCredential", "tags": [ "MfaController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "WebAuthn credential removed" } } } } }, "parameters": [ { "name": "credentialId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MfaController.removeWebauthnCredential" } }, "/v1/auth/oauth/providers": { "get": { "x-controller-name": "OAuthController", "x-operation-name": "listOAuthProviders", "tags": [ "OAuthController" ], "responses": { "200": { "description": "List configured OAuth providers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthProviderInfo" } } } } } }, "operationId": "OAuthController.listOAuthProviders" } }, "/v1/auth/oauth/{provider}/authorize": { "get": { "x-controller-name": "OAuthController", "x-operation-name": "getAuthorizationUrl", "tags": [ "OAuthController" ], "responses": { "200": { "description": "Authorization URL to redirect the user to", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthAuthorizationUrlResponse" } } } } }, "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "redirectUri", "in": "query", "schema": { "type": "string" } } ], "operationId": "OAuthController.getAuthorizationUrl" } }, "/v1/auth/oauth/{provider}/callback": { "get": { "x-controller-name": "OAuthController", "x-operation-name": "handleCallback", "tags": [ "OAuthController" ], "responses": { "200": { "description": "Login response with access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } } }, "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } }, { "name": "redirectUri", "in": "query", "schema": { "type": "string" } } ], "operationId": "OAuthController.handleCallback" } }, "/v1/auth/oauth/{provider}/link": { "post": { "x-controller-name": "OAuthController", "x-operation-name": "linkProvider", "tags": [ "OAuthController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Provider linked successfully" } } } } }, "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkOAuthProviderRequest" } } }, "x-parameter-index": 1 }, "operationId": "OAuthController.linkProvider" } }, "/v1/auth/oauth/{provider}/unlink": { "delete": { "x-controller-name": "OAuthController", "x-operation-name": "unlinkProvider", "tags": [ "OAuthController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Provider unlinked successfully" } } } } }, "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "OAuthController.unlinkProvider" } }, "/v1/auth/refresh": { "post": { "x-controller-name": "AuthController", "x-operation-name": "refresh", "tags": [ "AuthController" ], "responses": { "200": { "description": "Renewed access/refresh token pair", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenPairResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenRequest" } } } }, "operationId": "AuthController.refresh" } }, "/v1/auth/request-password-reset": { "post": { "x-controller-name": "AuthController", "x-operation-name": "requestPasswordReset", "tags": [ "AuthController" ], "responses": { "200": { "description": "Password reset email sent (if user account exists)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordResetRequest" } } } }, "operationId": "AuthController.requestPasswordReset" } }, "/v1/auth/reset-password": { "post": { "x-controller-name": "AuthController", "x-operation-name": "resetPassword", "tags": [ "AuthController" ], "responses": { "200": { "description": "Password has been reset successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponse" } } } }, "400": { "description": "Bad Request (e.g., missing fields, invalid code format, or password too short)" }, "401": { "description": "Unauthorized (e.g., invalid/expired code)" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordConfirmRequest" } } } }, "operationId": "AuthController.resetPassword" } }, "/v1/auth/signup": { "post": { "x-controller-name": "AuthController", "x-operation-name": "create", "tags": [ "AuthController" ], "responses": { "200": { "description": "User self-registration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUser" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "operationId": "AuthController.create" } }, "/v1/auth/verify-code": { "post": { "x-controller-name": "AuthController", "x-operation-name": "verifyUserWithCode", "tags": [ "AuthController" ], "responses": { "200": { "description": "Verify user account using 6-digit code sent via email", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyCodeResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyUserWithCodeRequest" } } } }, "operationId": "AuthController.verifyUserWithCode" } }, "/v1/auth/verify-token": { "get": { "x-controller-name": "AuthController", "x-operation-name": "verifyUserWithToken", "tags": [ "AuthController" ], "responses": { "200": { "description": "Verify user account using token from email link", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponse" } } } } }, "parameters": [ { "name": "token", "in": "query", "schema": { "type": "string" } } ], "operationId": "AuthController.verifyUserWithToken" } }, "/v1/collection-routes/{routeId}/executions/{executionId}/visits/{visitId}/forms": { "post": { "x-controller-name": "CollectionRouteController", "x-operation-name": "recordVisitForm", "tags": [ "CollectionRouteController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Record a form answered during a visit" } } } } }, "parameters": [ { "name": "routeId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "executionId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "visitId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "formId" ], "properties": { "formId": { "type": "string" }, "answeredAt": { "type": "string", "format": "date-time" } } } } }, "x-parameter-index": 3 }, "operationId": "CollectionRouteController.recordVisitForm" } }, "/v1/collection-routes/{routeId}/executions/{executionId}/visits": { "post": { "x-controller-name": "CollectionRouteController", "x-operation-name": "recordVisit", "tags": [ "CollectionRouteController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Record a passive liability visit during execution" } } } } }, "parameters": [ { "name": "routeId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "executionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "liabilityId", "visitedAt" ], "properties": { "liabilityId": { "type": "string" }, "visitedAt": { "type": "string", "format": "date-time" } } } } }, "x-parameter-index": 2 }, "operationId": "CollectionRouteController.recordVisit" } }, "/v1/collection-routes/{routeId}/executions/{executionId}": { "patch": { "x-controller-name": "CollectionRouteController", "x-operation-name": "updateExecution", "tags": [ "CollectionRouteController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Update execution status or finish it" } } } } }, "parameters": [ { "name": "routeId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "executionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "em_andamento", "concluida", "cancelada" ] }, "finishedAt": { "type": "string", "format": "date-time" }, "notes": { "type": "string" } } } } }, "x-parameter-index": 2 }, "operationId": "CollectionRouteController.updateExecution" } }, "/v1/collection-routes/{routeId}/executions": { "post": { "x-controller-name": "CollectionRouteController", "x-operation-name": "startExecution", "tags": [ "CollectionRouteController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Start a new route execution" } } } } }, "parameters": [ { "name": "routeId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "collectorId" ], "properties": { "collectorId": { "type": "string" }, "notes": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "CollectionRouteController.startExecution" } }, "/v1/collection-routes/{id}": { "patch": { "x-controller-name": "CollectionRouteController", "x-operation-name": "updateById", "tags": [ "CollectionRouteController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "CollectionRoute updated" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "projectId": { "type": "string" }, "passiveIds": { "type": "array", "items": { "type": "string" } }, "routeFeatureIds": { "type": "array", "items": { "type": "string" } }, "collectorIds": { "type": "array", "items": { "type": "string" } }, "formIds": { "type": "array", "items": { "type": "string" } } } } } }, "x-parameter-index": 1 }, "operationId": "CollectionRouteController.updateById" }, "get": { "x-controller-name": "CollectionRouteController", "x-operation-name": "findById", "tags": [ "CollectionRouteController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "CollectionRoute instance with all relations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CollectionRouteController.findById" }, "delete": { "x-controller-name": "CollectionRouteController", "x-operation-name": "deleteById", "tags": [ "CollectionRouteController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CollectionRoute soft-deleted" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CollectionRouteController.deleteById" } }, "/v1/collection-routes": { "post": { "x-controller-name": "CollectionRouteController", "x-operation-name": "create", "tags": [ "CollectionRouteController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "CollectionRoute created" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "projectId", "collectorIds", "formIds" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "projectId": { "type": "string" }, "passiveIds": { "type": "array", "items": { "type": "string" } }, "routeFeatureIds": { "type": "array", "items": { "type": "string" } }, "collectorIds": { "type": "array", "items": { "type": "string" } }, "formIds": { "type": "array", "items": { "type": "string" } } } } } } }, "operationId": "CollectionRouteController.create" }, "get": { "x-controller-name": "CollectionRouteController", "x-operation-name": "find", "tags": [ "CollectionRouteController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Array of CollectionRoute instances" } } } } }, "parameters": [ { "name": "projectId", "in": "query", "schema": { "type": "string" } } ], "operationId": "CollectionRouteController.find" } }, "/v1/evidences/{id}": { "patch": { "x-controller-name": "LiabilityEvidenceController", "x-operation-name": "updateById", "tags": [ "LiabilityEvidenceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LiabilityEvidence PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiabilityEvidencePartialExcluding_id-liabilityId-createdAt-updatedAt-deletedAt_" } } }, "x-parameter-index": 1 }, "operationId": "LiabilityEvidenceController.updateById" }, "delete": { "x-controller-name": "LiabilityEvidenceController", "x-operation-name": "deleteById", "tags": [ "LiabilityEvidenceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LiabilityEvidence DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "LiabilityEvidenceController.deleteById" } }, "/v1/exports/csv": { "get": { "x-controller-name": "ExportController", "x-operation-name": "exportCsv", "tags": [ "ExportController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ExportFilter", "definitions": { "ExportFilter": { "$ref": "#/components/schemas/ExportFilter" } } } } } } ], "operationId": "ExportController.exportCsv" } }, "/v1/exports/xlsx": { "get": { "x-controller-name": "ExportController", "x-operation-name": "exportXlsx", "tags": [ "ExportController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/ExportFilter", "definitions": { "ExportFilter": { "$ref": "#/components/schemas/ExportFilter" } } } } } } ], "operationId": "ExportController.exportXlsx" } }, "/v1/feature-groups/count": { "get": { "x-controller-name": "FeatureGroupController", "x-operation-name": "count", "tags": [ "FeatureGroupController" ], "responses": { "200": { "description": "FeatureGroup model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FeatureGroup.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FeatureGroupController.count" } }, "/v1/feature-groups/{id}": { "patch": { "x-controller-name": "FeatureGroupController", "x-operation-name": "updateById", "tags": [ "FeatureGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FeatureGroup PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureGroupPartial" } } }, "x-parameter-index": 1 }, "operationId": "FeatureGroupController.updateById" }, "get": { "x-controller-name": "FeatureGroupController", "x-operation-name": "findById", "tags": [ "FeatureGroupController" ], "responses": { "200": { "description": "FeatureGroup by ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureGroup" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureGroup.Filter" } } } } ], "operationId": "FeatureGroupController.findById" }, "delete": { "x-controller-name": "FeatureGroupController", "x-operation-name": "deleteById", "tags": [ "FeatureGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FeatureGroup DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "FeatureGroupController.deleteById" } }, "/v1/feature-groups": { "post": { "x-controller-name": "FeatureGroupController", "x-operation-name": "create", "tags": [ "FeatureGroupController" ], "responses": { "200": { "description": "Created FeatureGroup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureGroup" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureGroup" } } } }, "operationId": "FeatureGroupController.create" }, "get": { "x-controller-name": "FeatureGroupController", "x-operation-name": "find", "tags": [ "FeatureGroupController" ], "responses": { "200": { "description": "List of FeatureGroups", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureGroup" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureGroup.Filter1" } } } } ], "operationId": "FeatureGroupController.find" } }, "/v1/feature-groups-permissions": { "get": { "x-controller-name": "FeatureGroupController", "x-operation-name": "findWithPermissions", "tags": [ "FeatureGroupController" ], "responses": { "200": { "description": "List of FeatureGroups with permissions", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureGroupWithFeatures" } } } } } }, "operationId": "FeatureGroupController.findWithPermissions" } }, "/v1/features/count": { "get": { "x-controller-name": "FeatureController", "x-operation-name": "count", "tags": [ "FeatureController" ], "responses": { "200": { "description": "Features model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Features.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FeatureController.count" } }, "/v1/features/sync": { "post": { "x-controller-name": "FeatureController", "x-operation-name": "sync", "tags": [ "FeatureController" ], "responses": { "200": { "description": "Sync discovered permissions from controller metadata", "content": { "application/json": { "schema": { "type": "object", "properties": { "newPermissions": { "type": "array", "items": { "type": "string" } }, "totalPermissions": { "type": "number" } } } } } } }, "operationId": "FeatureController.sync" } }, "/v1/features/{id}": { "patch": { "x-controller-name": "FeatureController", "x-operation-name": "updateById", "tags": [ "FeatureController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Feature PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeaturesPartial" } } }, "x-parameter-index": 1 }, "operationId": "FeatureController.updateById" }, "get": { "x-controller-name": "FeatureController", "x-operation-name": "findById", "tags": [ "FeatureController" ], "responses": { "200": { "description": "Feature by ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Features" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Features.Filter" } } } } ], "operationId": "FeatureController.findById" }, "delete": { "x-controller-name": "FeatureController", "x-operation-name": "deleteById", "tags": [ "FeatureController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Feature DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "FeatureController.deleteById" } }, "/v1/features": { "post": { "x-controller-name": "FeatureController", "x-operation-name": "create", "tags": [ "FeatureController" ], "responses": { "200": { "description": "Created Feature", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Features" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Features" } } } }, "operationId": "FeatureController.create" }, "get": { "x-controller-name": "FeatureController", "x-operation-name": "find", "tags": [ "FeatureController" ], "responses": { "200": { "description": "List of Features", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Features" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Features.Filter1" } } } } ], "operationId": "FeatureController.find" } }, "/v1/forms/count": { "get": { "x-controller-name": "FormController", "x-operation-name": "count", "tags": [ "FormController" ], "responses": { "200": { "description": "Form model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Form.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where
" } } } } ], "operationId": "FormController.count" } }, "/v1/forms/{id}/collectors": { "get": { "x-controller-name": "FormController", "x-operation-name": "findCollectors", "tags": [ "FormController" ], "responses": { "200": { "description": "List of collectors associated with the form", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "FormController.findCollectors" } }, "/v1/forms/{id}/questions/{questionId}": { "post": { "x-controller-name": "FormQuestionController", "x-operation-name": "create", "tags": [ "FormQuestionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Question added to form" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "questionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "FormQuestionController.create" }, "delete": { "x-controller-name": "FormQuestionController", "x-operation-name": "delete", "tags": [ "FormQuestionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Question removed from form" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "questionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "FormQuestionController.delete" } }, "/v1/forms/{id}/routes": { "get": { "x-controller-name": "FormController", "x-operation-name": "findRoutes", "tags": [ "FormController" ], "responses": { "200": { "description": "List of routes associated with the form", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionRoute" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "FormController.findRoutes" } }, "/v1/forms/{id}/sections": { "patch": { "x-controller-name": "FormController", "x-operation-name": "replaceSections", "tags": [ "FormController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Form sections replaced successfully" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFormSectionsRequest" } } }, "description": "Replace all sections of a form", "required": true, "x-parameter-index": 1 }, "operationId": "FormController.replaceSections" }, "get": { "x-controller-name": "FormController", "x-operation-name": "findSections", "tags": [ "FormController" ], "responses": { "200": { "description": "Array of FormSection instances", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "FormController.findSections" } }, "/v1/forms/{id}/takes/count": { "get": { "x-controller-name": "FormTakeController", "x-operation-name": "count", "tags": [ "FormTakeController" ], "summary": "Count takes for a specific form", "description": "Returns the number of submission attempts (takes) recorded for a given form ID.", "responses": { "200": { "description": "Count of form submissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Take.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FormTakeController.count" } }, "/v1/forms/{id}/takes": { "get": { "x-controller-name": "FormTakeController", "x-operation-name": "find", "tags": [ "FormTakeController" ], "summary": "List all takes for a specific form", "description": "Retrieves a list of all submission attempts (takes) associated with a given form ID, including execution dates and collector details.", "responses": { "200": { "description": "Array of Take instances (submissions of form)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TakeWithRelations" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "FormTakeController.find" } }, "/v1/forms/{id}/users/{userId}": { "post": { "x-controller-name": "FormUserController", "x-operation-name": "create", "tags": [ "FormUserController" ], "summary": "Assign a user to a form", "description": "Grants permission to a specific user (collector) to perform submissions (takes) on a form.", "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Form assigned to user" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "FormUserController.create" }, "delete": { "x-controller-name": "FormUserController", "x-operation-name": "delete", "tags": [ "FormUserController" ], "summary": "Unassign a user from a form", "description": "Revokes the permission of a specific user (collector) to perform submissions on a form.", "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Form unassigned from user" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "FormUserController.delete" } }, "/v1/forms/{id}": { "put": { "x-controller-name": "FormController", "x-operation-name": "replaceById", "tags": [ "FormController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Form PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } }, "x-parameter-index": 1 }, "operationId": "FormController.replaceById" }, "patch": { "x-controller-name": "FormController", "x-operation-name": "updateById", "tags": [ "FormController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Form PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFormRequest" } } }, "description": "Partially update a form (optionally replacing sections)", "required": true, "x-parameter-index": 1 }, "operationId": "FormController.updateById" }, "get": { "x-controller-name": "FormController", "x-operation-name": "findById", "tags": [ "FormController" ], "responses": { "200": { "description": "Form model instance with sections", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormWithRelationsResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "FormController.findById" }, "delete": { "x-controller-name": "FormController", "x-operation-name": "deleteById", "tags": [ "FormController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Form DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "FormController.deleteById" } }, "/v1/forms": { "post": { "x-controller-name": "FormController", "x-operation-name": "create", "tags": [ "FormController" ], "responses": { "200": { "description": "Form model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFormRequest" } } }, "description": "Create a form with sections and questions", "required": true }, "operationId": "FormController.create" }, "patch": { "x-controller-name": "FormController", "x-operation-name": "updateAll", "tags": [ "FormController" ], "responses": { "200": { "description": "Form PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Form.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormPartial" } } } }, "operationId": "FormController.updateAll" }, "get": { "x-controller-name": "FormController", "x-operation-name": "find", "tags": [ "FormController" ], "responses": { "200": { "description": "List of forms with sections", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FormWithRelationsResponse" } } } } } }, "operationId": "FormController.find" } }, "/v1/liabilities/{id}/evidences": { "post": { "x-controller-name": "LiabilityEvidenceController", "x-operation-name": "create", "tags": [ "LiabilityEvidenceController" ], "responses": { "200": { "description": "LiabilityEvidence model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiabilityEvidence" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "fileType": { "type": "string" }, "caption": { "type": "string" }, "metadata": { "type": "string" } } } } }, "description": "Multipart form data containing the file and fields", "required": true, "x-parameter-index": 1 }, "operationId": "LiabilityEvidenceController.create" } }, "/v1/liabilities/{id}/status": { "patch": { "x-controller-name": "LiabilityController", "x-operation-name": "updateStatus", "tags": [ "LiabilityController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Liability status updated successfully" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLiabilityStatusRequest" } } }, "x-parameter-index": 1 }, "operationId": "LiabilityController.updateStatus" } }, "/v1/liabilities/{id}/tags/{tagId}": { "delete": { "x-controller-name": "LiabilityController", "x-operation-name": "removeTag", "tags": [ "LiabilityController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Tag removed from liability" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "tagId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "LiabilityController.removeTag" } }, "/v1/liabilities/{id}/tags": { "post": { "x-controller-name": "LiabilityController", "x-operation-name": "assignTag", "tags": [ "LiabilityController" ], "responses": { "200": { "description": "Tag assigned to liability", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRequest" } } }, "x-parameter-index": 1 }, "operationId": "LiabilityController.assignTag" } }, "/v1/liabilities/{id}/title": { "patch": { "x-controller-name": "LiabilityController", "x-operation-name": "updateTitle", "tags": [ "LiabilityController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Liability title updated successfully" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLiabilityTitleRequest" } } }, "x-parameter-index": 1 }, "operationId": "LiabilityController.updateTitle" } }, "/v1/liabilities/{id}": { "patch": { "x-controller-name": "LiabilityController", "x-operation-name": "updateById", "tags": [ "LiabilityController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Liability PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLiabilityRequest" } } }, "x-parameter-index": 1 }, "operationId": "LiabilityController.updateById" }, "get": { "x-controller-name": "LiabilityController", "x-operation-name": "findById", "tags": [ "LiabilityController" ], "responses": { "200": { "description": "Liability model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiabilityWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Liability.Filter" } } } } ], "operationId": "LiabilityController.findById" }, "delete": { "x-controller-name": "LiabilityController", "x-operation-name": "deleteById", "tags": [ "LiabilityController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Liability DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "LiabilityController.deleteById" } }, "/v1/liabilities": { "post": { "x-controller-name": "LiabilityController", "x-operation-name": "create", "tags": [ "LiabilityController" ], "responses": { "200": { "description": "Liability model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Liability" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLiabilityRequest" } } } }, "operationId": "LiabilityController.create" } }, "/v1/location-questions/count": { "get": { "x-controller-name": "LocationQuestionController", "x-operation-name": "count", "tags": [ "LocationQuestionController" ], "responses": { "200": { "description": "LocationQuestion model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "LocationQuestion.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LocationQuestionController.count" } }, "/v1/location-questions/{id}": { "patch": { "x-controller-name": "LocationQuestionController", "x-operation-name": "updateById", "tags": [ "LocationQuestionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LocationQuestion PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationQuestionPartial" } } }, "x-parameter-index": 1 }, "operationId": "LocationQuestionController.updateById" }, "get": { "x-controller-name": "LocationQuestionController", "x-operation-name": "findById", "tags": [ "LocationQuestionController" ], "responses": { "200": { "description": "LocationQuestion model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationQuestionWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "LocationQuestionController.findById" }, "delete": { "x-controller-name": "LocationQuestionController", "x-operation-name": "deleteById", "tags": [ "LocationQuestionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LocationQuestion DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "LocationQuestionController.deleteById" } }, "/v1/location-questions": { "post": { "x-controller-name": "LocationQuestionController", "x-operation-name": "create", "tags": [ "LocationQuestionController" ], "responses": { "200": { "description": "LocationQuestion model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationQuestion" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLocationQuestion" } } } }, "operationId": "LocationQuestionController.create" }, "get": { "x-controller-name": "LocationQuestionController", "x-operation-name": "find", "tags": [ "LocationQuestionController" ], "responses": { "200": { "description": "Array of LocationQuestion instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationQuestionWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "LocationQuestionController.find" } }, "/v1/media-questions/count": { "get": { "x-controller-name": "MediaQuestionController", "x-operation-name": "count", "tags": [ "MediaQuestionController" ], "responses": { "200": { "description": "MediaQuestion model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MediaQuestion.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MediaQuestionController.count" } }, "/v1/media-questions/{id}": { "patch": { "x-controller-name": "MediaQuestionController", "x-operation-name": "updateById", "tags": [ "MediaQuestionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MediaQuestion PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaQuestionPartial" } } }, "x-parameter-index": 1 }, "operationId": "MediaQuestionController.updateById" }, "get": { "x-controller-name": "MediaQuestionController", "x-operation-name": "findById", "tags": [ "MediaQuestionController" ], "responses": { "200": { "description": "MediaQuestion model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaQuestionWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MediaQuestionController.findById" }, "delete": { "x-controller-name": "MediaQuestionController", "x-operation-name": "deleteById", "tags": [ "MediaQuestionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MediaQuestion DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MediaQuestionController.deleteById" } }, "/v1/media-questions": { "post": { "x-controller-name": "MediaQuestionController", "x-operation-name": "create", "tags": [ "MediaQuestionController" ], "responses": { "200": { "description": "MediaQuestion model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaQuestion" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMediaQuestion" } } } }, "operationId": "MediaQuestionController.create" }, "get": { "x-controller-name": "MediaQuestionController", "x-operation-name": "find", "tags": [ "MediaQuestionController" ], "responses": { "200": { "description": "Array of MediaQuestion instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MediaQuestionWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "MediaQuestionController.find" } }, "/v1/ping": { "get": { "x-controller-name": "PingController", "x-operation-name": "ping", "tags": [ "PingController" ], "responses": { "200": { "description": "Ping Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PingResponse" } } } } }, "operationId": "PingController.ping" } }, "/v1/polygon-questions/count": { "get": { "x-controller-name": "PolygonQuestionController", "x-operation-name": "count", "tags": [ "PolygonQuestionController" ], "responses": { "200": { "description": "AreaQuestion model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "AreaQuestion.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "PolygonQuestionController.count" } }, "/v1/polygon-questions/{id}": { "patch": { "x-controller-name": "PolygonQuestionController", "x-operation-name": "updateById", "tags": [ "PolygonQuestionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AreaQuestion PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaQuestionPartial" } } }, "x-parameter-index": 1 }, "operationId": "PolygonQuestionController.updateById" }, "get": { "x-controller-name": "PolygonQuestionController", "x-operation-name": "findById", "tags": [ "PolygonQuestionController" ], "responses": { "200": { "description": "AreaQuestion model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaQuestionWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PolygonQuestionController.findById" }, "delete": { "x-controller-name": "PolygonQuestionController", "x-operation-name": "deleteById", "tags": [ "PolygonQuestionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AreaQuestion DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PolygonQuestionController.deleteById" } }, "/v1/polygon-questions": { "post": { "x-controller-name": "PolygonQuestionController", "x-operation-name": "create", "tags": [ "PolygonQuestionController" ], "responses": { "200": { "description": "AreaQuestion model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaQuestion" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewAreaQuestion" } } } }, "operationId": "PolygonQuestionController.create" }, "get": { "x-controller-name": "PolygonQuestionController", "x-operation-name": "find", "tags": [ "PolygonQuestionController" ], "responses": { "200": { "description": "Array of AreaQuestion instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AreaQuestionWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "PolygonQuestionController.find" } }, "/v1/profiles/collectors/minimum-permissions": { "get": { "x-controller-name": "ProfileController", "x-operation-name": "getMinimumCollectorPermissions", "tags": [ "ProfileController" ], "responses": { "200": { "description": "Minimum permissions required for a collector profile", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "operationId": "ProfileController.getMinimumCollectorPermissions" } }, "/v1/profiles/count": { "get": { "x-controller-name": "ProfileController", "x-operation-name": "count", "tags": [ "ProfileController" ], "responses": { "200": { "description": "Profiles model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Profiles.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProfileController.count" } }, "/v1/profiles/with-permissions-count": { "get": { "x-controller-name": "ProfileController", "x-operation-name": "findWithPermissionsCount", "tags": [ "ProfileController" ], "responses": { "200": { "description": "List of Profiles with their permissions and permissions count", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProfilesWithPermissions" } } } } } }, "operationId": "ProfileController.findWithPermissionsCount" } }, "/v1/profiles/{id}/features/{featureId}": { "post": { "x-controller-name": "ProfileController", "x-operation-name": "addFeature", "tags": [ "ProfileController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Permission assigned to profile" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "featureId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProfileController.addFeature" }, "delete": { "x-controller-name": "ProfileController", "x-operation-name": "removeFeature", "tags": [ "ProfileController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Permission removed from profile" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "featureId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProfileController.removeFeature" } }, "/v1/profiles/{id}": { "put": { "x-controller-name": "ProfileController", "x-operation-name": "replaceById", "tags": [ "ProfileController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Profile PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profiles" } } }, "x-parameter-index": 1 }, "operationId": "ProfileController.replaceById" }, "patch": { "x-controller-name": "ProfileController", "x-operation-name": "updateById", "tags": [ "ProfileController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Profile PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilesPartial" } } }, "x-parameter-index": 1 }, "operationId": "ProfileController.updateById" }, "get": { "x-controller-name": "ProfileController", "x-operation-name": "findById", "tags": [ "ProfileController" ], "responses": { "200": { "description": "Profile by ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profiles.Filter" } } } } ], "operationId": "ProfileController.findById" }, "delete": { "x-controller-name": "ProfileController", "x-operation-name": "deleteById", "tags": [ "ProfileController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Profile DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProfileController.deleteById" } }, "/v1/profiles": { "post": { "x-controller-name": "ProfileController", "x-operation-name": "create", "tags": [ "ProfileController" ], "responses": { "200": { "description": "Created Profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profiles" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profiles" } } } }, "operationId": "ProfileController.create" }, "patch": { "x-controller-name": "ProfileController", "x-operation-name": "updateAll", "tags": [ "ProfileController" ], "responses": { "200": { "description": "Profiles PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Profiles.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfilesPartial" } } } }, "operationId": "ProfileController.updateAll" }, "get": { "x-controller-name": "ProfileController", "x-operation-name": "find", "tags": [ "ProfileController" ], "responses": { "200": { "description": "List of Profiles", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProfilesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profiles.Filter1" } } } } ], "operationId": "ProfileController.find" } }, "/v1/projects/count": { "get": { "x-controller-name": "ProjectController", "x-operation-name": "count", "tags": [ "ProjectController" ], "responses": { "200": { "description": "Project model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Project.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProjectController.count" } }, "/v1/projects/liabilities": { "get": { "x-controller-name": "LiabilityController", "x-operation-name": "findByProjects", "tags": [ "LiabilityController" ], "responses": { "200": { "description": "Array of Liability model instances for multiple projects", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LiabilityWithRelations" } } } } } }, "parameters": [ { "name": "projectIds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Liability.Filter1" } } } } ], "operationId": "LiabilityController.findByProjects" } }, "/v1/projects/{id}/activate": { "post": { "x-controller-name": "ProjectController", "x-operation-name": "activate", "tags": [ "ProjectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Project activated successfully" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProjectController.activate" } }, "/v1/projects/{id}/cancel": { "post": { "x-controller-name": "ProjectController", "x-operation-name": "cancel", "tags": [ "ProjectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Project canceled successfully" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProjectController.cancel" } }, "/v1/projects/{projectId}/collection-routes": { "get": { "x-controller-name": "CollectionRouteController", "x-operation-name": "findByProject", "tags": [ "CollectionRouteController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Routes for a specific project" } } } } }, "parameters": [ { "name": "projectId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CollectionRouteController.findByProject" } }, "/v1/projects/{id}/collectors": { "get": { "x-controller-name": "ProjectController", "x-operation-name": "findCollectors", "tags": [ "ProjectController" ], "responses": { "200": { "description": "List of eligible collectors in the project", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProjectController.findCollectors" } }, "/v1/projects/{id}/complete": { "post": { "x-controller-name": "ProjectController", "x-operation-name": "complete", "tags": [ "ProjectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Project completed successfully" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProjectController.complete" } }, "/v1/projects/{id}/custom-fields": { "patch": { "x-controller-name": "ProjectController", "x-operation-name": "patchCustomFields", "tags": [ "ProjectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Partial patch of custom fields" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldPatchRequest" } } }, "x-parameter-index": 1 }, "operationId": "ProjectController.patchCustomFields" } }, "/v1/projects/{id}/forms/count": { "get": { "x-controller-name": "ProjectFormController", "x-operation-name": "count", "tags": [ "ProjectFormController" ], "responses": { "200": { "description": "Count of forms in project", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Form.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProjectFormController.count" } }, "/v1/projects/{id}/forms": { "post": { "x-controller-name": "ProjectFormController", "x-operation-name": "create", "tags": [ "ProjectFormController" ], "responses": { "200": { "description": "Project.Form model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Form" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewFormInProject" } } }, "x-parameter-index": 1 }, "operationId": "ProjectFormController.create" }, "get": { "x-controller-name": "ProjectFormController", "x-operation-name": "find", "tags": [ "ProjectFormController" ], "responses": { "200": { "description": "Array of Form instances belonging to Project", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FormWithRelations" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ProjectFormController.find" } }, "/v1/projects/{projectId}/liabilities": { "get": { "x-controller-name": "LiabilityController", "x-operation-name": "findByProject", "tags": [ "LiabilityController" ], "responses": { "200": { "description": "Array of Liability model instances for a project", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LiabilityWithRelations" } } } } } }, "parameters": [ { "name": "projectId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Liability.Filter1" } } } } ], "operationId": "LiabilityController.findByProject" } }, "/v1/projects/{id}/members/count": { "get": { "x-controller-name": "ProjectUserController", "x-operation-name": "count", "tags": [ "ProjectUserController" ], "summary": "Count project members", "description": "Returns the total number of members currently assigned to a project.", "responses": { "200": { "description": "Count of members", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProjectUser.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProjectUserController.count" } }, "/v1/projects/{id}/members/{userId}": { "delete": { "x-controller-name": "ProjectMemberController", "x-operation-name": "removeMember", "tags": [ "ProjectMemberController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Member removed successfully" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProjectMemberController.removeMember" } }, "/v1/projects/{id}/members": { "post": { "x-controller-name": "ProjectMemberController", "x-operation-name": "addMember", "tags": [ "ProjectMemberController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Member added successfully" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddProjectMemberRequest" } } }, "x-parameter-index": 1 }, "operationId": "ProjectMemberController.addMember" }, "get": { "x-controller-name": "ProjectUserController", "x-operation-name": "find", "tags": [ "ProjectUserController" ], "summary": "List all members of a project", "description": "Retrieves the list of users (members) assigned to a specific project along with their project-specific roles.", "responses": { "200": { "description": "Array of ProjectUser instances (members)", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectUserWithRelations" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ProjectUserController.find" } }, "/v1/projects/{id}/pause": { "post": { "x-controller-name": "ProjectController", "x-operation-name": "pause", "tags": [ "ProjectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Project paused successfully" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProjectController.pause" } }, "/v1/projects/{projectId}/route-features": { "get": { "x-controller-name": "RouteFeatureController", "x-operation-name": "findByProject", "tags": [ "RouteFeatureController" ], "responses": { "200": { "description": "List of route features belonging to a project", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RouteFeatureResponse" } } } } } }, "parameters": [ { "name": "projectId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteFeature.Filter" } } } } ], "operationId": "RouteFeatureController.findByProject" } }, "/v1/projects/{id}/summary": { "get": { "x-controller-name": "ProjectController", "x-operation-name": "getSummary", "tags": [ "ProjectController" ], "responses": { "200": { "description": "Project summary with relations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProjectController.getSummary" } }, "/v1/projects/{id}": { "put": { "x-controller-name": "ProjectController", "x-operation-name": "replaceById", "tags": [ "ProjectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Project PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "x-parameter-index": 1 }, "operationId": "ProjectController.replaceById" }, "patch": { "x-controller-name": "ProjectController", "x-operation-name": "updateById", "tags": [ "ProjectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Project PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectRequest" } } }, "x-parameter-index": 1 }, "operationId": "ProjectController.updateById" }, "get": { "x-controller-name": "ProjectController", "x-operation-name": "findById", "tags": [ "ProjectController" ], "responses": { "200": { "description": "Project model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project.Filter" } } } } ], "operationId": "ProjectController.findById" }, "delete": { "x-controller-name": "ProjectController", "x-operation-name": "deleteById", "tags": [ "ProjectController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Project DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProjectController.deleteById" } }, "/v1/projects": { "post": { "x-controller-name": "ProjectController", "x-operation-name": "create", "tags": [ "ProjectController" ], "responses": { "200": { "description": "Project model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectRequest" } } } }, "operationId": "ProjectController.create" }, "patch": { "x-controller-name": "ProjectController", "x-operation-name": "updateAll", "tags": [ "ProjectController" ], "responses": { "200": { "description": "Project PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Project.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "operationId": "ProjectController.updateAll" }, "get": { "x-controller-name": "ProjectController", "x-operation-name": "find", "tags": [ "ProjectController" ], "responses": { "200": { "description": "List of projects", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project.Filter1" } } } } ], "operationId": "ProjectController.find" } }, "/v1/question-hints/count": { "get": { "x-controller-name": "QuestionHintController", "x-operation-name": "count", "tags": [ "QuestionHintController" ], "summary": "Count question hints", "description": "Returns the total number of question hints configured in the system.", "responses": { "200": { "description": "Hint model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Hint.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "QuestionHintController.count" } }, "/v1/question-hints/{id}": { "patch": { "x-controller-name": "QuestionHintController", "x-operation-name": "updateById", "tags": [ "QuestionHintController" ], "summary": "Update a question hint", "description": "Updates the details or instruction text of a specific question hint.", "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Hint PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HintPartial" } } }, "x-parameter-index": 1 }, "operationId": "QuestionHintController.updateById" }, "get": { "x-controller-name": "QuestionHintController", "x-operation-name": "findById", "tags": [ "QuestionHintController" ], "summary": "Get question hint by ID", "description": "Retrieves details of a specific question hint by its unique ID.", "responses": { "200": { "description": "Hint model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HintWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "QuestionHintController.findById" }, "delete": { "x-controller-name": "QuestionHintController", "x-operation-name": "deleteById", "tags": [ "QuestionHintController" ], "summary": "Delete a question hint", "description": "Deletes a specific question hint from a question.", "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Hint DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "QuestionHintController.deleteById" } }, "/v1/question-hints": { "post": { "x-controller-name": "QuestionHintController", "x-operation-name": "create", "tags": [ "QuestionHintController" ], "summary": "Create a new question hint", "description": "Creates a new help text or tip for a specific form question.", "responses": { "200": { "description": "Hint model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hint" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewHint" } } } }, "operationId": "QuestionHintController.create" }, "get": { "x-controller-name": "QuestionHintController", "x-operation-name": "find", "tags": [ "QuestionHintController" ], "summary": "List all question hints", "description": "Retrieves a list of all question hints across all forms.", "responses": { "200": { "description": "Array of Hint instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HintWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "QuestionHintController.find" } }, "/v1/question-options/count": { "get": { "x-controller-name": "QuestionOptionController", "x-operation-name": "count", "tags": [ "QuestionOptionController" ], "responses": { "200": { "description": "Option model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Option.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where