{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-@l10n/en/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Versioning","description":"Documentação oficial, guias e referência da API Auvo v2.","siteUrl":"https://developers.auvo.com.br","lang":"pt-BR","keywords":"auvo, api, documentação, developers, field service, workforce","meta":[{"name":"og:site_name","content":"Auvo Developers"},{"name":"og:locale","content":"pt_BR"},{"name":"og:locale:alternate","content":"es_ES"},{"name":"og:locale:alternate","content":"en_US"},{"name":"twitter:card","content":"summary_large_image"},{"name":"twitter:site","content":"@auvoapp"}],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"versioning","__idx":0},"children":["Versioning"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Auvo API uses ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL versioning"]},": v2 lives under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2"]},". Compatible changes"," ","(new optional fields, new endpoints) ship in v2; incompatible changes move to"," ","the next major version."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"deprecation-policy","__idx":1},"children":["Deprecation policy"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A deprecated endpoint or field stays available for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["at least 90 days"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Deprecations are announced via:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-deprecation-date"]}," in the spec."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Response header ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Deprecation: @timestamp"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Weekly ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/changelog"},"children":["changelog"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Email to account admins that used the endpoint in the last 30 days."]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"not-breaking-changes","__idx":2},"children":["NOT breaking changes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New optional fields in requests."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New fields in responses."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New endpoints / new verbs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["New 2xx and 4xx codes with additional meaning."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"breaking-changes","__idx":3},"children":["Breaking changes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removing/renaming fields or endpoints."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changing existing types/enums."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Adding ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]}," request fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Changing HTTP codes on existing operations."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"communication-channel","__idx":4},"children":["Communication channel"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Subscribe to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["changelog.rss"]}," or follow our RSS/Atom feed. Webhook subscribers"," ","receiving the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api.deprecated"]}," event are notified too."]}]},"headings":[{"value":"Versioning","id":"versioning","depth":1},{"value":"Deprecation policy","id":"deprecation-policy","depth":2},{"value":"NOT breaking changes","id":"not-breaking-changes","depth":2},{"value":"Breaking changes","id":"breaking-changes","depth":2},{"value":"Communication channel","id":"communication-channel","depth":2}],"frontmatter":{"title":"Versioning","description":"Breaking-change policy, deprecations and communication.","seo":{"title":"Versioning"}},"lastModified":"2026-04-24T13:01:34.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/en/guides/versioning","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}