{
“openapi”: “3.0.3”,
“info”: {
“title”: “Viaje Comigo Go (Caronas) API”,
“description”: “API documentation for the **Viaje Comigo Go (Caronas)** application.\n\n**Authentication:** Most endpoints require the `api_key` header. If using Swagger UI, click the **Authorize** button at the top of the page and enter your API key before trying any endpoint.”,
“version”: “1.0.0”
},
“servers”: [
{
“url”: “https://kind-rota-fcil-go.base44.app/api”,
“description”: “API server”
}
],
“security”: [
{
“ApiKeyAuth”: []
}
],
“paths”: {
“/entities/Motorista”: {
“get”: {
“tags”: [
“Entities – Motorista”
],
“summary”: “List Motorista records”,
“operationId”: “list_Motorista”,
“description”: “Retrieve a list of Motorista records with optional filtering, sorting, and pagination.”,
“parameters”: [
{
“name”: “q”,
“in”: “query”,
“schema”: {
“type”: “string”
},
“description”: “JSON query filter, e.g. {\”status\”:\”active\”}”
},
{
“name”: “limit”,
“in”: “query”,
“schema”: {
“type”: “integer”,
“default”: 100
},
“description”: “Maximum number of records to return”
},
{
“name”: “skip”,
“in”: “query”,
“schema”: {
“type”: “integer”,
“default”: 0
},
“description”: “Number of records to skip (pagination)”
},
{
“name”: “sort_by”,
“in”: “query”,
“schema”: {
“type”: “string”
},
“description”: “Field name to sort by. Prefix with ‘-‘ for descending order, e.g. -created_date”
}
],
“responses”: {
“200”: {
“description”: “List of records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Motorista”
}
}
}
}
}
}
},
“post”: {
“tags”: [
“Entities – Motorista”
],
“summary”: “Create a Motorista record”,
“operationId”: “create_Motorista”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Motorista”
},
“example”: {
“nome”: “Example nome”,
“cidade”: “Example cidade”,
“veiculo”: “Example veiculo”,
“tipo_veiculo”: “Carro”
}
}
}
},
“responses”: {
“200”: {
“description”: “Created record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Motorista”
}
}
}
}
}
},
“delete”: {
“tags”: [
“Entities – Motorista”
],
“summary”: “Delete multiple Motorista records”,
“operationId”: “delete_many_Motorista”,
“description”: “**Warning:** Passing an empty `{}` query will delete ALL records in this entity.”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“description”: “Query filter to match records to delete”
},
“example”: {
“nome”: “Example nome”
}
}
}
},
“responses”: {
“200”: {
“description”: “Deletion result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
},
“deleted”: {
“type”: “integer”
}
}
}
}
}
}
}
}
},
“/entities/Motorista/bulk”: {
“post”: {
“tags”: [
“Entities – Motorista”
],
“summary”: “Bulk create Motorista records”,
“operationId”: “bulk_create_Motorista”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Motorista”
}
},
“example”: [
{
“nome”: “Example nome”,
“cidade”: “Example cidade”,
“veiculo”: “Example veiculo”,
“tipo_veiculo”: “Carro”
}
]
}
}
},
“responses”: {
“200”: {
“description”: “List of created records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Motorista”
}
}
}
}
}
}
},
“put”: {
“tags”: [
“Entities – Motorista”
],
“summary”: “Bulk update Motorista records”,
“operationId”: “bulk_update_Motorista”,
“description”: “Each item must include an ‘id’ field along with the fields to update.”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Motorista”
}
},
“example”: [
{
“id”: “
“nome”: “Example nome”,
“cidade”: “Example cidade”,
“veiculo”: “Example veiculo”,
“tipo_veiculo”: “Carro”
}
]
}
}
},
“responses”: {
“200”: {
“description”: “List of updated records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Motorista”
}
}
}
}
}
}
}
},
“/entities/Motorista/update-many”: {
“patch”: {
“tags”: [
“Entities – Motorista”
],
“summary”: “Update many Motorista records by query”,
“operationId”: “update_many_Motorista”,
“description”: “Update multiple records matching a query filter. Supports MongoDB update operators ($set, $inc, $push, $pull).”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“required”: [
“query”,
“data”
],
“properties”: {
“query”: {
“type”: “object”,
“description”: “Query filter to match records”
},
“data”: {
“type”: “object”,
“description”: “Update operations to apply”
}
}
},
“example”: {
“query”: {
“nome”: “Example nome”
},
“data”: {
“$set”: {
“nome”: “Example nome”
}
}
}
}
}
},
“responses”: {
“200”: {
“description”: “Update result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
},
“updated”: {
“type”: “integer”
},
“has_more”: {
“type”: “boolean”
}
}
}
}
}
}
}
}
},
“/entities/Motorista/{Motorista_id}”: {
“get”: {
“tags”: [
“Entities – Motorista”
],
“summary”: “Get a Motorista record by ID”,
“operationId”: “get_Motorista”,
“parameters”: [
{
“name”: “Motorista_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “The record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Motorista”
}
}
}
}
}
},
“put”: {
“tags”: [
“Entities – Motorista”
],
“summary”: “Update a Motorista record”,
“operationId”: “update_Motorista”,
“parameters”: [
{
“name”: “Motorista_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Motorista”
}
}
}
},
“responses”: {
“200”: {
“description”: “Updated record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Motorista”
}
}
}
}
}
},
“delete”: {
“tags”: [
“Entities – Motorista”
],
“summary”: “Delete a Motorista record”,
“operationId”: “delete_Motorista”,
“description”: “Soft-deletes the record. Use the restore endpoint to undo.”,
“parameters”: [
{
“name”: “Motorista_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “Deletion result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
}
}
}
}
}
}
}
}
},
“/entities/Motorista/{Motorista_id}/restore”: {
“put”: {
“tags”: [
“Entities – Motorista”
],
“summary”: “Restore a deleted Motorista record”,
“operationId”: “restore_Motorista”,
“parameters”: [
{
“name”: “Motorista_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “Restored record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Motorista”
}
}
}
}
}
}
},
“/entities/Reserva”: {
“get”: {
“tags”: [
“Entities – Reserva”
],
“summary”: “List Reserva records”,
“operationId”: “list_Reserva”,
“description”: “Retrieve a list of Reserva records with optional filtering, sorting, and pagination.”,
“parameters”: [
{
“name”: “q”,
“in”: “query”,
“schema”: {
“type”: “string”
},
“description”: “JSON query filter, e.g. {\”status\”:\”active\”}”
},
{
“name”: “limit”,
“in”: “query”,
“schema”: {
“type”: “integer”,
“default”: 100
},
“description”: “Maximum number of records to return”
},
{
“name”: “skip”,
“in”: “query”,
“schema”: {
“type”: “integer”,
“default”: 0
},
“description”: “Number of records to skip (pagination)”
},
{
“name”: “sort_by”,
“in”: “query”,
“schema”: {
“type”: “string”
},
“description”: “Field name to sort by. Prefix with ‘-‘ for descending order, e.g. -created_date”
}
],
“responses”: {
“200”: {
“description”: “List of records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Reserva”
}
}
}
}
}
}
},
“post”: {
“tags”: [
“Entities – Reserva”
],
“summary”: “Create a Reserva record”,
“operationId”: “create_Reserva”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Reserva”
},
“example”: {
“viagem_id”: “Example viagem_id”,
“passageiro_nome”: “Example passageiro_nome”,
“num_passageiros”: 0
}
}
}
},
“responses”: {
“200”: {
“description”: “Created record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Reserva”
}
}
}
}
}
},
“delete”: {
“tags”: [
“Entities – Reserva”
],
“summary”: “Delete multiple Reserva records”,
“operationId”: “delete_many_Reserva”,
“description”: “**Warning:** Passing an empty `{}` query will delete ALL records in this entity.”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“description”: “Query filter to match records to delete”
},
“example”: {
“viagem_id”: “Example viagem_id”
}
}
}
},
“responses”: {
“200”: {
“description”: “Deletion result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
},
“deleted”: {
“type”: “integer”
}
}
}
}
}
}
}
}
},
“/entities/Reserva/bulk”: {
“post”: {
“tags”: [
“Entities – Reserva”
],
“summary”: “Bulk create Reserva records”,
“operationId”: “bulk_create_Reserva”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Reserva”
}
},
“example”: [
{
“viagem_id”: “Example viagem_id”,
“passageiro_nome”: “Example passageiro_nome”,
“num_passageiros”: 0
}
]
}
}
},
“responses”: {
“200”: {
“description”: “List of created records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Reserva”
}
}
}
}
}
}
},
“put”: {
“tags”: [
“Entities – Reserva”
],
“summary”: “Bulk update Reserva records”,
“operationId”: “bulk_update_Reserva”,
“description”: “Each item must include an ‘id’ field along with the fields to update.”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Reserva”
}
},
“example”: [
{
“id”: “
“viagem_id”: “Example viagem_id”,
“passageiro_nome”: “Example passageiro_nome”,
“num_passageiros”: 0
}
]
}
}
},
“responses”: {
“200”: {
“description”: “List of updated records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Reserva”
}
}
}
}
}
}
}
},
“/entities/Reserva/update-many”: {
“patch”: {
“tags”: [
“Entities – Reserva”
],
“summary”: “Update many Reserva records by query”,
“operationId”: “update_many_Reserva”,
“description”: “Update multiple records matching a query filter. Supports MongoDB update operators ($set, $inc, $push, $pull).”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“required”: [
“query”,
“data”
],
“properties”: {
“query”: {
“type”: “object”,
“description”: “Query filter to match records”
},
“data”: {
“type”: “object”,
“description”: “Update operations to apply”
}
}
},
“example”: {
“query”: {
“viagem_id”: “Example viagem_id”
},
“data”: {
“$set”: {
“viagem_id”: “Example viagem_id”
}
}
}
}
}
},
“responses”: {
“200”: {
“description”: “Update result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
},
“updated”: {
“type”: “integer”
},
“has_more”: {
“type”: “boolean”
}
}
}
}
}
}
}
}
},
“/entities/Reserva/{Reserva_id}”: {
“get”: {
“tags”: [
“Entities – Reserva”
],
“summary”: “Get a Reserva record by ID”,
“operationId”: “get_Reserva”,
“parameters”: [
{
“name”: “Reserva_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “The record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Reserva”
}
}
}
}
}
},
“put”: {
“tags”: [
“Entities – Reserva”
],
“summary”: “Update a Reserva record”,
“operationId”: “update_Reserva”,
“parameters”: [
{
“name”: “Reserva_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Reserva”
}
}
}
},
“responses”: {
“200”: {
“description”: “Updated record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Reserva”
}
}
}
}
}
},
“delete”: {
“tags”: [
“Entities – Reserva”
],
“summary”: “Delete a Reserva record”,
“operationId”: “delete_Reserva”,
“description”: “Soft-deletes the record. Use the restore endpoint to undo.”,
“parameters”: [
{
“name”: “Reserva_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “Deletion result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
}
}
}
}
}
}
}
}
},
“/entities/Reserva/{Reserva_id}/restore”: {
“put”: {
“tags”: [
“Entities – Reserva”
],
“summary”: “Restore a deleted Reserva record”,
“operationId”: “restore_Reserva”,
“parameters”: [
{
“name”: “Reserva_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “Restored record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Reserva”
}
}
}
}
}
}
},
“/entities/Encomenda”: {
“get”: {
“tags”: [
“Entities – Encomenda”
],
“summary”: “List Encomenda records”,
“operationId”: “list_Encomenda”,
“description”: “Retrieve a list of Encomenda records with optional filtering, sorting, and pagination.”,
“parameters”: [
{
“name”: “q”,
“in”: “query”,
“schema”: {
“type”: “string”
},
“description”: “JSON query filter, e.g. {\”status\”:\”active\”}”
},
{
“name”: “limit”,
“in”: “query”,
“schema”: {
“type”: “integer”,
“default”: 100
},
“description”: “Maximum number of records to return”
},
{
“name”: “skip”,
“in”: “query”,
“schema”: {
“type”: “integer”,
“default”: 0
},
“description”: “Number of records to skip (pagination)”
},
{
“name”: “sort_by”,
“in”: “query”,
“schema”: {
“type”: “string”
},
“description”: “Field name to sort by. Prefix with ‘-‘ for descending order, e.g. -created_date”
}
],
“responses”: {
“200”: {
“description”: “List of records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Encomenda”
}
}
}
}
}
}
},
“post”: {
“tags”: [
“Entities – Encomenda”
],
“summary”: “Create a Encomenda record”,
“operationId”: “create_Encomenda”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Encomenda”
},
“example”: {
“origem”: “Example origem”,
“destino”: “Example destino”,
“descricao”: “Example descricao”,
“nome_remetente”: “Example nome_remetente”
}
}
}
},
“responses”: {
“200”: {
“description”: “Created record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Encomenda”
}
}
}
}
}
},
“delete”: {
“tags”: [
“Entities – Encomenda”
],
“summary”: “Delete multiple Encomenda records”,
“operationId”: “delete_many_Encomenda”,
“description”: “**Warning:** Passing an empty `{}` query will delete ALL records in this entity.”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“description”: “Query filter to match records to delete”
},
“example”: {
“origem”: “Example origem”
}
}
}
},
“responses”: {
“200”: {
“description”: “Deletion result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
},
“deleted”: {
“type”: “integer”
}
}
}
}
}
}
}
}
},
“/entities/Encomenda/bulk”: {
“post”: {
“tags”: [
“Entities – Encomenda”
],
“summary”: “Bulk create Encomenda records”,
“operationId”: “bulk_create_Encomenda”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Encomenda”
}
},
“example”: [
{
“origem”: “Example origem”,
“destino”: “Example destino”,
“descricao”: “Example descricao”,
“nome_remetente”: “Example nome_remetente”
}
]
}
}
},
“responses”: {
“200”: {
“description”: “List of created records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Encomenda”
}
}
}
}
}
}
},
“put”: {
“tags”: [
“Entities – Encomenda”
],
“summary”: “Bulk update Encomenda records”,
“operationId”: “bulk_update_Encomenda”,
“description”: “Each item must include an ‘id’ field along with the fields to update.”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Encomenda”
}
},
“example”: [
{
“id”: “
“origem”: “Example origem”,
“destino”: “Example destino”,
“descricao”: “Example descricao”,
“nome_remetente”: “Example nome_remetente”
}
]
}
}
},
“responses”: {
“200”: {
“description”: “List of updated records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Encomenda”
}
}
}
}
}
}
}
},
“/entities/Encomenda/update-many”: {
“patch”: {
“tags”: [
“Entities – Encomenda”
],
“summary”: “Update many Encomenda records by query”,
“operationId”: “update_many_Encomenda”,
“description”: “Update multiple records matching a query filter. Supports MongoDB update operators ($set, $inc, $push, $pull).”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“required”: [
“query”,
“data”
],
“properties”: {
“query”: {
“type”: “object”,
“description”: “Query filter to match records”
},
“data”: {
“type”: “object”,
“description”: “Update operations to apply”
}
}
},
“example”: {
“query”: {
“origem”: “Example origem”
},
“data”: {
“$set”: {
“origem”: “Example origem”
}
}
}
}
}
},
“responses”: {
“200”: {
“description”: “Update result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
},
“updated”: {
“type”: “integer”
},
“has_more”: {
“type”: “boolean”
}
}
}
}
}
}
}
}
},
“/entities/Encomenda/{Encomenda_id}”: {
“get”: {
“tags”: [
“Entities – Encomenda”
],
“summary”: “Get a Encomenda record by ID”,
“operationId”: “get_Encomenda”,
“parameters”: [
{
“name”: “Encomenda_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “The record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Encomenda”
}
}
}
}
}
},
“put”: {
“tags”: [
“Entities – Encomenda”
],
“summary”: “Update a Encomenda record”,
“operationId”: “update_Encomenda”,
“parameters”: [
{
“name”: “Encomenda_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Encomenda”
}
}
}
},
“responses”: {
“200”: {
“description”: “Updated record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Encomenda”
}
}
}
}
}
},
“delete”: {
“tags”: [
“Entities – Encomenda”
],
“summary”: “Delete a Encomenda record”,
“operationId”: “delete_Encomenda”,
“description”: “Soft-deletes the record. Use the restore endpoint to undo.”,
“parameters”: [
{
“name”: “Encomenda_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “Deletion result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
}
}
}
}
}
}
}
}
},
“/entities/Encomenda/{Encomenda_id}/restore”: {
“put”: {
“tags”: [
“Entities – Encomenda”
],
“summary”: “Restore a deleted Encomenda record”,
“operationId”: “restore_Encomenda”,
“parameters”: [
{
“name”: “Encomenda_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “Restored record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Encomenda”
}
}
}
}
}
}
},
“/entities/Viagem”: {
“get”: {
“tags”: [
“Entities – Viagem”
],
“summary”: “List Viagem records”,
“operationId”: “list_Viagem”,
“description”: “Retrieve a list of Viagem records with optional filtering, sorting, and pagination.”,
“parameters”: [
{
“name”: “q”,
“in”: “query”,
“schema”: {
“type”: “string”
},
“description”: “JSON query filter, e.g. {\”status\”:\”active\”}”
},
{
“name”: “limit”,
“in”: “query”,
“schema”: {
“type”: “integer”,
“default”: 100
},
“description”: “Maximum number of records to return”
},
{
“name”: “skip”,
“in”: “query”,
“schema”: {
“type”: “integer”,
“default”: 0
},
“description”: “Number of records to skip (pagination)”
},
{
“name”: “sort_by”,
“in”: “query”,
“schema”: {
“type”: “string”
},
“description”: “Field name to sort by. Prefix with ‘-‘ for descending order, e.g. -created_date”
}
],
“responses”: {
“200”: {
“description”: “List of records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Viagem”
}
}
}
}
}
}
},
“post”: {
“tags”: [
“Entities – Viagem”
],
“summary”: “Create a Viagem record”,
“operationId”: “create_Viagem”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Viagem”
},
“example”: {
“origem”: “Example origem”,
“destino”: “Example destino”,
“data”: “Example data”,
“horario”: “Example horario”,
“valor_por_passageiro”: 0,
“vagas”: 0
}
}
}
},
“responses”: {
“200”: {
“description”: “Created record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Viagem”
}
}
}
}
}
},
“delete”: {
“tags”: [
“Entities – Viagem”
],
“summary”: “Delete multiple Viagem records”,
“operationId”: “delete_many_Viagem”,
“description”: “**Warning:** Passing an empty `{}` query will delete ALL records in this entity.”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“description”: “Query filter to match records to delete”
},
“example”: {
“origem”: “Example origem”
}
}
}
},
“responses”: {
“200”: {
“description”: “Deletion result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
},
“deleted”: {
“type”: “integer”
}
}
}
}
}
}
}
}
},
“/entities/Viagem/bulk”: {
“post”: {
“tags”: [
“Entities – Viagem”
],
“summary”: “Bulk create Viagem records”,
“operationId”: “bulk_create_Viagem”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Viagem”
}
},
“example”: [
{
“origem”: “Example origem”,
“destino”: “Example destino”,
“data”: “Example data”,
“horario”: “Example horario”,
“valor_por_passageiro”: 0,
“vagas”: 0
}
]
}
}
},
“responses”: {
“200”: {
“description”: “List of created records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Viagem”
}
}
}
}
}
}
},
“put”: {
“tags”: [
“Entities – Viagem”
],
“summary”: “Bulk update Viagem records”,
“operationId”: “bulk_update_Viagem”,
“description”: “Each item must include an ‘id’ field along with the fields to update.”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Viagem”
}
},
“example”: [
{
“id”: “
“origem”: “Example origem”,
“destino”: “Example destino”,
“data”: “Example data”,
“horario”: “Example horario”,
“valor_por_passageiro”: 0,
“vagas”: 0
}
]
}
}
},
“responses”: {
“200”: {
“description”: “List of updated records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Viagem”
}
}
}
}
}
}
}
},
“/entities/Viagem/update-many”: {
“patch”: {
“tags”: [
“Entities – Viagem”
],
“summary”: “Update many Viagem records by query”,
“operationId”: “update_many_Viagem”,
“description”: “Update multiple records matching a query filter. Supports MongoDB update operators ($set, $inc, $push, $pull).”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“required”: [
“query”,
“data”
],
“properties”: {
“query”: {
“type”: “object”,
“description”: “Query filter to match records”
},
“data”: {
“type”: “object”,
“description”: “Update operations to apply”
}
}
},
“example”: {
“query”: {
“origem”: “Example origem”
},
“data”: {
“$set”: {
“origem”: “Example origem”
}
}
}
}
}
},
“responses”: {
“200”: {
“description”: “Update result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
},
“updated”: {
“type”: “integer”
},
“has_more”: {
“type”: “boolean”
}
}
}
}
}
}
}
}
},
“/entities/Viagem/{Viagem_id}”: {
“get”: {
“tags”: [
“Entities – Viagem”
],
“summary”: “Get a Viagem record by ID”,
“operationId”: “get_Viagem”,
“parameters”: [
{
“name”: “Viagem_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “The record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Viagem”
}
}
}
}
}
},
“put”: {
“tags”: [
“Entities – Viagem”
],
“summary”: “Update a Viagem record”,
“operationId”: “update_Viagem”,
“parameters”: [
{
“name”: “Viagem_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Viagem”
}
}
}
},
“responses”: {
“200”: {
“description”: “Updated record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Viagem”
}
}
}
}
}
},
“delete”: {
“tags”: [
“Entities – Viagem”
],
“summary”: “Delete a Viagem record”,
“operationId”: “delete_Viagem”,
“description”: “Soft-deletes the record. Use the restore endpoint to undo.”,
“parameters”: [
{
“name”: “Viagem_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “Deletion result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
}
}
}
}
}
}
}
}
},
“/entities/Viagem/{Viagem_id}/restore”: {
“put”: {
“tags”: [
“Entities – Viagem”
],
“summary”: “Restore a deleted Viagem record”,
“operationId”: “restore_Viagem”,
“parameters”: [
{
“name”: “Viagem_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “Restored record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Viagem”
}
}
}
}
}
}
},
“/entities/Avaliacao”: {
“get”: {
“tags”: [
“Entities – Avaliacao”
],
“summary”: “List Avaliacao records”,
“operationId”: “list_Avaliacao”,
“description”: “Retrieve a list of Avaliacao records with optional filtering, sorting, and pagination.”,
“parameters”: [
{
“name”: “q”,
“in”: “query”,
“schema”: {
“type”: “string”
},
“description”: “JSON query filter, e.g. {\”status\”:\”active\”}”
},
{
“name”: “limit”,
“in”: “query”,
“schema”: {
“type”: “integer”,
“default”: 100
},
“description”: “Maximum number of records to return”
},
{
“name”: “skip”,
“in”: “query”,
“schema”: {
“type”: “integer”,
“default”: 0
},
“description”: “Number of records to skip (pagination)”
},
{
“name”: “sort_by”,
“in”: “query”,
“schema”: {
“type”: “string”
},
“description”: “Field name to sort by. Prefix with ‘-‘ for descending order, e.g. -created_date”
}
],
“responses”: {
“200”: {
“description”: “List of records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Avaliacao”
}
}
}
}
}
}
},
“post”: {
“tags”: [
“Entities – Avaliacao”
],
“summary”: “Create a Avaliacao record”,
“operationId”: “create_Avaliacao”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Avaliacao”
},
“example”: {
“viagem_id”: “Example viagem_id”,
“motorista_id”: “Example motorista_id”,
“passageiro_nome”: “Example passageiro_nome”,
“nota”: 0
}
}
}
},
“responses”: {
“200”: {
“description”: “Created record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Avaliacao”
}
}
}
}
}
},
“delete”: {
“tags”: [
“Entities – Avaliacao”
],
“summary”: “Delete multiple Avaliacao records”,
“operationId”: “delete_many_Avaliacao”,
“description”: “**Warning:** Passing an empty `{}` query will delete ALL records in this entity.”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“description”: “Query filter to match records to delete”
},
“example”: {
“viagem_id”: “Example viagem_id”
}
}
}
},
“responses”: {
“200”: {
“description”: “Deletion result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
},
“deleted”: {
“type”: “integer”
}
}
}
}
}
}
}
}
},
“/entities/Avaliacao/bulk”: {
“post”: {
“tags”: [
“Entities – Avaliacao”
],
“summary”: “Bulk create Avaliacao records”,
“operationId”: “bulk_create_Avaliacao”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Avaliacao”
}
},
“example”: [
{
“viagem_id”: “Example viagem_id”,
“motorista_id”: “Example motorista_id”,
“passageiro_nome”: “Example passageiro_nome”,
“nota”: 0
}
]
}
}
},
“responses”: {
“200”: {
“description”: “List of created records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Avaliacao”
}
}
}
}
}
}
},
“put”: {
“tags”: [
“Entities – Avaliacao”
],
“summary”: “Bulk update Avaliacao records”,
“operationId”: “bulk_update_Avaliacao”,
“description”: “Each item must include an ‘id’ field along with the fields to update.”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Avaliacao”
}
},
“example”: [
{
“id”: “
“viagem_id”: “Example viagem_id”,
“motorista_id”: “Example motorista_id”,
“passageiro_nome”: “Example passageiro_nome”,
“nota”: 0
}
]
}
}
},
“responses”: {
“200”: {
“description”: “List of updated records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/Avaliacao”
}
}
}
}
}
}
}
},
“/entities/Avaliacao/update-many”: {
“patch”: {
“tags”: [
“Entities – Avaliacao”
],
“summary”: “Update many Avaliacao records by query”,
“operationId”: “update_many_Avaliacao”,
“description”: “Update multiple records matching a query filter. Supports MongoDB update operators ($set, $inc, $push, $pull).”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“required”: [
“query”,
“data”
],
“properties”: {
“query”: {
“type”: “object”,
“description”: “Query filter to match records”
},
“data”: {
“type”: “object”,
“description”: “Update operations to apply”
}
}
},
“example”: {
“query”: {
“viagem_id”: “Example viagem_id”
},
“data”: {
“$set”: {
“viagem_id”: “Example viagem_id”
}
}
}
}
}
},
“responses”: {
“200”: {
“description”: “Update result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
},
“updated”: {
“type”: “integer”
},
“has_more”: {
“type”: “boolean”
}
}
}
}
}
}
}
}
},
“/entities/Avaliacao/{Avaliacao_id}”: {
“get”: {
“tags”: [
“Entities – Avaliacao”
],
“summary”: “Get a Avaliacao record by ID”,
“operationId”: “get_Avaliacao”,
“parameters”: [
{
“name”: “Avaliacao_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “The record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Avaliacao”
}
}
}
}
}
},
“put”: {
“tags”: [
“Entities – Avaliacao”
],
“summary”: “Update a Avaliacao record”,
“operationId”: “update_Avaliacao”,
“parameters”: [
{
“name”: “Avaliacao_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Avaliacao”
}
}
}
},
“responses”: {
“200”: {
“description”: “Updated record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Avaliacao”
}
}
}
}
}
},
“delete”: {
“tags”: [
“Entities – Avaliacao”
],
“summary”: “Delete a Avaliacao record”,
“operationId”: “delete_Avaliacao”,
“description”: “Soft-deletes the record. Use the restore endpoint to undo.”,
“parameters”: [
{
“name”: “Avaliacao_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “Deletion result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
}
}
}
}
}
}
}
}
},
“/entities/Avaliacao/{Avaliacao_id}/restore”: {
“put”: {
“tags”: [
“Entities – Avaliacao”
],
“summary”: “Restore a deleted Avaliacao record”,
“operationId”: “restore_Avaliacao”,
“parameters”: [
{
“name”: “Avaliacao_id”,
“in”: “path”,
“required”: true,
“schema”: {
“type”: “string”
},
“description”: “Record ID”
}
],
“responses”: {
“200”: {
“description”: “Restored record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/Avaliacao”
}
}
}
}
}
}
},
“/entities/CadastroMotorista”: {
“get”: {
“tags”: [
“Entities – CadastroMotorista”
],
“summary”: “List CadastroMotorista records”,
“operationId”: “list_CadastroMotorista”,
“description”: “Retrieve a list of CadastroMotorista records with optional filtering, sorting, and pagination.”,
“parameters”: [
{
“name”: “q”,
“in”: “query”,
“schema”: {
“type”: “string”
},
“description”: “JSON query filter, e.g. {\”status\”:\”active\”}”
},
{
“name”: “limit”,
“in”: “query”,
“schema”: {
“type”: “integer”,
“default”: 100
},
“description”: “Maximum number of records to return”
},
{
“name”: “skip”,
“in”: “query”,
“schema”: {
“type”: “integer”,
“default”: 0
},
“description”: “Number of records to skip (pagination)”
},
{
“name”: “sort_by”,
“in”: “query”,
“schema”: {
“type”: “string”
},
“description”: “Field name to sort by. Prefix with ‘-‘ for descending order, e.g. -created_date”
}
],
“responses”: {
“200”: {
“description”: “List of records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/CadastroMotorista”
}
}
}
}
}
}
},
“post”: {
“tags”: [
“Entities – CadastroMotorista”
],
“summary”: “Create a CadastroMotorista record”,
“operationId”: “create_CadastroMotorista”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/CadastroMotorista”
},
“example”: {
“nome”: “Example nome”,
“telefone”: “Example telefone”,
“cidade”: “Example cidade”,
“cnh_numero”: “Example cnh_numero”,
“veiculo”: “Example veiculo”,
“placa”: “Example placa”,
“tipo_veiculo”: “Carro”
}
}
}
},
“responses”: {
“200”: {
“description”: “Created record”,
“content”: {
“application/json”: {
“schema”: {
“$ref”: “#/components/schemas/CadastroMotorista”
}
}
}
}
}
},
“delete”: {
“tags”: [
“Entities – CadastroMotorista”
],
“summary”: “Delete multiple CadastroMotorista records”,
“operationId”: “delete_many_CadastroMotorista”,
“description”: “**Warning:** Passing an empty `{}` query will delete ALL records in this entity.”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“description”: “Query filter to match records to delete”
},
“example”: {
“nome”: “Example nome”
}
}
}
},
“responses”: {
“200”: {
“description”: “Deletion result”,
“content”: {
“application/json”: {
“schema”: {
“type”: “object”,
“properties”: {
“success”: {
“type”: “boolean”
},
“deleted”: {
“type”: “integer”
}
}
}
}
}
}
}
}
},
“/entities/CadastroMotorista/bulk”: {
“post”: {
“tags”: [
“Entities – CadastroMotorista”
],
“summary”: “Bulk create CadastroMotorista records”,
“operationId”: “bulk_create_CadastroMotorista”,
“requestBody”: {
“required”: true,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {
“$ref”: “#/components/schemas/CadastroMotorista”
}
},
“example”: [
{
“nome”: “Example nome”,
“telefone”: “Example telefone”,
“cidade”: “Example cidade”,
“cnh_numero”: “Example cnh_numero”,
“veiculo”: “Example veiculo”,
“placa”: “Example placa”,
“tipo_veiculo”: “Carro”
}
]
}
}
},
“responses”: {
“200”: {
“description”: “List of created records”,
“content”: {
“application/json”: {
“schema”: {
“type”: “array”,
“items”: {