docs: Add information about HabitatPromote to API documentation

habitat-sh · Dec 1, 2017 · 16982b5 · 16982b5
1 parent 284fe15
commit 16982b5
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -35,3 +35,19 @@ The following is a description of the Habitat operator API. To see manifest exam
 | name | Name of the bind specified in the Habitat configuration files. | string | true |
 | service | Name of the service this bind refers to. | string | true |
 | group | Group of the service this bind refers to. | string | true |
+
+## HabitatPromote
+
+| Field | Description | Scheme | Required |
+| ----- | ----------- | ------ | -------- |
+| metadata | | [metav1.ObjectMeta](https://kubernetes.io/docs/api-reference/v1.6/#objectmeta-v1-meta) | true |
+| spec | | [HabitatSpec](#habitatspec) | true |
+| status | | | false |
+
+## HabitatPromoteSpec
+
+| Field | Description | Scheme | Required |
+| ----- | ----------- | ------ | -------- |
+| habitatName | Name of the Habitat object to promote. | string | true |
+| oldChannel | Name of the old channel which the Habitat application is using. | string | true |
+| newChannel | Name of the new channel which the Habitat application is going to use after promotion. | string | true |