Skip to content

DOCUMENTATION.md

Latest commit

 

History

History
35 lines (23 loc) · 1.8 KB

DOCUMENTATION.md

File metadata and controls

35 lines (23 loc) · 1.8 KB

Documentation of ASR API

Overview

The APIs in the project have been created to enable gRPC communication with Techmo ASR solutions.

Versioning

To familiarize yourself with breaking and non-breaking changes terms, see "Versioning gRPC services" at Microsoft Learn

Unless necessary, breaking changes should be avoided. Keeping APIs backwards compatible should be the preferred way of development. Protos of previous stable API releases should be preserved for as long as they are planned to be serviced.

The package version must be in form:

package-version = major-version [patch-version] [suffix] ; v1, v1p1, v1p1beta1, ...

major-version   = "v" number ; v1, v2, ..., vN
patch-version   = "p" number ; p1, p2, ..., pN
suffix          = ("alpha" / "beta") number ; alpha1, alpha2, ..., alphaN / beta1, beta2, ..., betaN

number          = 1*digit ; 1, 2, ..., N
digit           = "1" / "2" / "3" / "4" / "5" / "6" / "7" / "8" / "9"
  • The major version number "v" must always be increased during a general breaking overhaul.
  • New non-breaking functionalities should be introduced by a new version of the package with the patch version suffix "p".
  • New features must be developed on mirrors of stable releases with "alpha" and "beta" suffixes, also numbered incrementally. Such packages should be considered unstable and prone to change and, therefore, generally not for production use. To indicate a feature freeze, the suffix must be removed.

Reference