api-docs.yaml

openapi: 3.0.3 info: title: Atualiza Imóvel API version: 1.0.0 description: APIs para workflows de atualização de imóveis

servers:

paths:

Workflow 1: Buscar Imóvel

/imovel/buscar: post: tags: - "Consulta de Imóveis" summary: "Buscar dados do imóvel" description: "Workflow para buscar informações detalhadas de um imóvel" requestBody: required: true content: application/json: schema: type: object required: - codigo_imovel properties: codigo_imovel: type: string description: "Código único do imóvel (obrigatório)" example: "IMO123456" incluir_historico: type: boolean description: "Incluir histórico de preços (opcional)" default: false incluir_fotos: type: boolean description: "Incluir URLs das fotos (opcional)" default: true responses: '200': description: "Dados do imóvel encontrados" content: application/json: schema: type: object properties: sucesso: type: boolean example: true dados: type: object properties: codigo: type: string example: "IMO123456" endereco: type: string example: "Rua das Flores, 123" preco_atual: type: number example: 450000.00 fotos: type: array items: type: string example: ["https://exemplo.com/foto1.jpg"] '404': description: "Imóvel não encontrado" content: application/json: schema: type: object properties: sucesso: type: boolean example: false erro: type: string example: "Imóvel não encontrado"

Workflow 2: Atualizar Preço (exemplo de workflow interrelacionado)

/imovel/atualizar-preco: put: tags: - "Atualização de Imóveis" summary: "Atualizar preço do imóvel" description: "Workflow para atualizar o preço de um imóvel existente" requestBody: required: true content: application/json: schema: type: object required: - codigo_imovel - novo_preco properties: codigo_imovel: type: string description: "Código do imóvel (use o mesmo da busca)" example: "IMO123456" novo_preco: type: number description: "Novo preço do imóvel" example: 475000.00 motivo_alteracao: type: string description: "Motivo da alteração (opcional)" example: "Valorização do mercado" responses: '200': description: "Preço atualizado com sucesso" content: application/json: schema: type: object properties: sucesso: type: boolean example: true preco_anterior: type: number example: 450000.00 preco_atual: type: number example: 475000.00