Skip to main content
Hovedversionen i URL’en er Florals kompatibilitetsgrænse. Eksisterende integrationer på /api/v1 kan tage kompatible tilføjelser i brug uden at ændre basisstien.

​
Ændringer i v1

Floral kan tilføje:
  • nye handlinger;
  • valgfrie inputfelter og filtre;
  • svarfelter;
  • enum-værdier, når feltdokumentationen tillader udvidelse.
Klienter bør ignorere svarfelter, de ikke kender, og håndtere ukendte enum-værdier sikkert, når feltet er dokumenteret som udvideligt. Floral fjerner eller omdøber ikke eksisterende handlinger eller felter i v1 uden en ny hovedversion.

​
Varsel om udfasning

Planlagte inkompatible ændringer bruger en ny hovedsti og mindst 180 dages overlap. Floral udgiver erstatning, migreringstrin, ikrafttrædelsesdato og supportkanal, før overlapperioden starter. Når en handling udfases, angiver API-referencen dens erstatning. Floral varsler også berørte integrationsejere. Et bekræftet sikkerheds- eller privatlivsproblem kan kræve en kortere periode. I så fald beskriver Floral den sikreste mulige migreringsvej og undtagelsen.

​
Forbered klienten

  • Gør API-basisstien konfigurerbar.
  • Fortolk kun de felter, integrationen bruger.
  • Gem request-id’er og ressourceversioner i logs.
  • Afprøv erstatningen, før produktionstrafikken flyttes.
  • Antag ikke, at udokumenteret adfærd forbliver stabil.