Skip to content

ajoshi31/API-versioning-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 

Repository files navigation

Version 1.0.1

An internal update

API:

  • Walk
  • Talk
  • Throw a fisty

Patch

Patch updates are interchangeable, meaning consumers can upgrade or downgrade freely.

Content: Internal fix Example: Bug fix, Performance improvement, environment or internal tweaks Policy: Consumers should update their software without hesitation

Minor

Minor updates are backwards compatible, meaning consumers can upgrade freely.

Content: Interface change with full backward compatibility Example: New feature, Endpoint declared deprecated Policy: Update your software to get some new features. Nothing will break

Version 1.1.0

An internal update

API:

  • Walk
  • Talk
  • Throw a fisty
    • Jab
    • Shield

Next Minor Update as we added new functionality and adding a deprication warning

Version 1.2.0

An internal update

API:

  • Walk
  • Talk
  • Throw a fisty
    • Jab (depricated)
    • Shield
  • *swing

Major

Major updates are non-compatible, meaning consumers can not upgrade without changing their software where applicable.

Content: Interface change breaking backward compatibility Example: Change API endpoint name or signature, Remove an endpoint Policy: Test your system extensively after updating. Migration documents may be in order

Version 2.0.0

An internal update

API:

  • Walk
  • Talk
  • Throw a fisty
    • Shield
  • *swing
    • shIELD REMOVED
    • JAB REMOVED

Change in the next release version

Version 2.0.1

Patch update

API:

  • Walk
  • Talk
  • Throw a fisty
  • Swing -> Making swing more fast this is release in the v1.2.0 so better to udpate in that version also