{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-@l10n/pt/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Versionamento e descontinuação da API"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"versionamento-e-descontinuação-da-api","__idx":0},"children":["Versionamento e descontinuação da API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A MoreLogin publica uma versão de snapshot do contrato legível por máquina no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["info.version"]}," de cada documento OpenAPI. A versão usa o formato de calendário ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YYYY-MM-DD"]}," e identifica o contrato de documentação, não um segmento de versão na URL da requisição."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"regras-de-compatibilidade","__idx":1},"children":["Regras de compatibilidade"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Mudança"},"children":["Mudança"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Classificação"},"children":["Classificação"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Tratamento na documentação"},"children":["Tratamento na documentação"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Adicionar um campo de requisição ou resposta opcional, uma operação ou um valor de enumeração"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Aditiva"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Registrar no changelog e atualizar todas as especificações localizadas"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Esclarecer descrições ou corrigir um exemplo sem mudar o comportamento em execução"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Correção de documentação"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Registrar quando altera a orientação de integração"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tornar um campo opcional obrigatório, remover/renomear um campo ou operação, restringir valores aceitos ou mudar a semântica estabelecida"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Quebra"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fornecer um caminho de migração e um contrato versionado separadamente antes da remoção"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Marcar uma operação com ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deprecated: true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Descontinuação"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Documentar o substituto, a data do anúncio e a data prevista de remoção quando aprovada"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Os clientes devem ignorar campos de resposta e valores de enumeração desconhecidos quando sua lógica de negócio permitir. Isso reduz quebras causadas por versões aditivas."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"metadados-de-descontinuação","__idx":2},"children":["Metadados de descontinuação"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A operação OpenAPI é o local legível por máquina com autoridade. Uma operação descontinuada precisa incluir:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deprecated: true"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["uma descrição que nomeie o substituto ou afirme que não existe"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["uma entrada de anúncio no changelog da API"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["uma data prevista de remoção somente depois que os responsáveis pelo produto e pelo gateway a aprovarem"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Nenhum período mínimo universal de descontinuação é garantido atualmente. Até que uma data de remoção seja explicitamente publicada, os clientes devem tratar a operação como suportada, mas planejar a migração."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"fonte-da-verdade","__idx":3},"children":["Fonte da verdade"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["O comportamento em execução continua sendo a autoridade. OpenAPI, exemplos, cópias localizadas, o manifesto de comportamento das operações e o changelog são verificados juntos na CI para evitar desvio de contrato."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"níveis-de-verificação","__idx":4},"children":["Níveis de verificação"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A aprovação no controle de qualidade do repositório comprova que os arquivos OpenAPI, exemplos, links, cópias localizadas e artefatos de governança são internamente consistentes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A verificação das páginas renderizadas comprova que rotas representativas da documentação carregam e são exibidas sem erros no cliente."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Somente um teste de fumaça autenticado na API implantada pode comprovar que o comportamento de produção corresponde ao contrato publicado. Este repositório não executa esse teste por padrão; portanto, as notas de versão devem informar separadamente quando a verificação de produção foi realizada."]}]},"headings":[{"value":"Versionamento e descontinuação da API","id":"versionamento-e-descontinuação-da-api","depth":1},{"value":"Regras de compatibilidade","id":"regras-de-compatibilidade","depth":2},{"value":"Metadados de descontinuação","id":"metadados-de-descontinuação","depth":2},{"value":"Fonte da verdade","id":"fonte-da-verdade","depth":2},{"value":"Níveis de verificação","id":"níveis-de-verificação","depth":2}],"frontmatter":{"seo":{"title":"Versionamento e descontinuação da API"}},"lastModified":"2026-09-05T06:38:55.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/pt/api-reference/appendix/versioning-and-deprecation","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}