ApiDefinitionGuidelines: Add section on API versioning

Signed-off-by: Gabe Goodhart <[email protected]>
instructlab · Jun 4, 2024 · 83b627c · 83b627c
1 parent 0156135
commit 83b627c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.spellcheck-en-custom.txt b/.spellcheck-en-custom.txt
@@ -4,6 +4,7 @@ Abhishek
 Akash
 AMDGPU
 API
+API's
 api
 arge
 arXiv

diff --git a/api-definitions/README.md b/api-definitions/README.md
@@ -15,3 +15,9 @@ The common abstract interface for the service APIs is defined by [REST APIs](htt
   * [platform.yaml](./platform.yaml): This defines the platform-level APIs used by the `InstructLab` workflow.
 * Each platform `Capability` should own its own fully-functional sub-API file that can be used by individual capability service implementations
 * Any schema object that is reused between endpoints should be housed in a schema file under [common](./common)
+
+## Versioning and Stability
+
+**WARNING** At this stage in development, we make no guarantees about stability and support for APIs!
+
+**FUTURE**: Once stabilized, the APIs will follow an agreed-upon form of [semantic versioning](https://semver.org/) so that users can rely on the API's stability. The decision of how to version the API and at what granularity to do so is still under discussion.
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ Abhishek @@
     Akash
     AMDGPU
     API
+    API's
     api
     arge
     arXiv
@@ Expand Down @@