APIs

  • APIs: Application Programming Interface. For the purposes of TF an API is any form of interface that is exposed to other TF apps/services and/or exposed to third party services or external applications. 
  • API Classifications:For the purposes of being declared Stable, Provisional, or Tentative, an API is a collection of code that provides some high-level functionality, e.g., flow programming or data store access. When listed on a release plan, APIs should be given a short name, classified into one of the three categories, and have the supporting bundles (if/when they exist) listed as well.
    • Stable API: An API that can be accessed external to your project, existed in a previous version of TF, and will continue to exist in the current version of TF with no changes. By definition, all Stable APIs are frozen throughout this entire release cycle. Note that all APIs are assumed to be Stable APIs unless called out as Provisional and/or Tentative in a release plan.
    • Provisional API: An API that can be accessed external to your project and is introduced in the current release, or an externally accessible API that existed in a previous version of TF but is being modified for the current release.

Tentative API: A Provisional API that will be provided in a best effort manner, but which may or may not be delivered in the final release. The Go/NoGo status of Tentative APIs must be made by M2

  • No labels