Entitlements

coder · mtojek · Jan 13, 2023 · Dec 22, 2022 · Jan 2, 2023 · Jan 2, 2023
commit 77be926a08b44e3711c84a36b239ac0fc48825bf
diff --git a/Makefile b/Makefile
@@ -483,7 +483,7 @@ docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/me
 	cd site
 	yarn run format:write:only ../docs/admin/prometheus.md
 
-coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen -not \( -path './scripts/apidocgen/node_modules' -prune \) -type f) $(wildcard coderd/*.go) $(wildcard codersdk/*.go) .swaggo
+coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen -not \( -path './scripts/apidocgen/node_modules' -prune \) -type f) $(wildcard coderd/*.go) $(wildcard enterprise/coderd/*.go) $(wildcard codersdk/*.go) .swaggo
 	./scripts/apidocgen/generate.sh
 	cd site
 	yarn run format:write:only ../docs/api ../docs/manifest.json ../coderd/apidoc/swagger.json

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -303,6 +303,31 @@ const docTemplate = `{
                 }
             }
         },
+        "/entitlements": {
+            "get": {
+                "security": [
+                    {
+                        "CoderSessionToken": []
+                    }
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Enterprise"
+                ],
+                "summary": "Get entitlements",
+                "operationId": "get-entitlements",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/codersdk.Entitlements"
+                        }
+                    }
+                }
+            }
+        },
         "/files": {
             "post": {
                 "security": [
@@ -4788,6 +4813,55 @@ const docTemplate = `{
                 }
             }
         },
+        "codersdk.Entitlements": {
+            "type": "object",
+            "properties": {
+                "errors": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "experimental": {
+                    "type": "boolean"
+                },
+                "features": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "$ref": "#/definitions/codersdk.Feature"
+                    }
+                },
+                "has_license": {
+                    "type": "boolean"
+                },
+                "trial": {
+                    "type": "boolean"
+                },
+                "warnings": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            }
+        },
+        "codersdk.Feature": {
+            "type": "object",
+            "properties": {
+                "actual": {
+                    "type": "integer"
+                },
+                "enabled": {
+                    "type": "boolean"
+                },
+                "entitlement": {
+                    "type": "string"
+                },
+                "limit": {
+                    "type": "integer"
+                }
+            }
+        },
         "codersdk.GenerateAPIKeyResponse": {
             "type": "object",
             "properties": {

diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
@@ -257,6 +257,27 @@
         }
       }
     },
+    "/entitlements": {
+      "get": {
+        "security": [
+          {
+            "CoderSessionToken": []
+          }
+        ],
+        "produces": ["application/json"],
+        "tags": ["Enterprise"],
+        "summary": "Get entitlements",
+        "operationId": "get-entitlements",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "$ref": "#/definitions/codersdk.Entitlements"
+            }
+          }
+        }
+      }
+    },
     "/files": {
       "post": {
         "security": [
@@ -4279,6 +4300,55 @@
         }
       }
     },
+    "codersdk.Entitlements": {
+      "type": "object",
+      "properties": {
+        "errors": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "experimental": {
+          "type": "boolean"
+        },
+        "features": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/codersdk.Feature"
+          }
+        },
+        "has_license": {
+          "type": "boolean"
+        },
+        "trial": {
+          "type": "boolean"
+        },
+        "warnings": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "codersdk.Feature": {
+      "type": "object",
+      "properties": {
+        "actual": {
+          "type": "integer"
+        },
+        "enabled": {
+          "type": "boolean"
+        },
+        "entitlement": {
+          "type": "string"
+        },
+        "limit": {
+          "type": "integer"
+        }
+      }
+    },
     "codersdk.GenerateAPIKeyResponse": {
       "type": "object",
       "properties": {

diff --git a/docs/api/enterprise.md b/docs/api/enterprise.md
@@ -0,0 +1,52 @@
+# Enterprise
+
+> This page is incomplete, stay tuned.
+
+## Get entitlements
+
+### Code samples
+
+```shell
+# Example request using curl
+curl -X GET http://coder-server:8080/api/v2/entitlements \
+  -H 'Accept: application/json' \
+  -H 'Coder-Session-Token: API_KEY'
+```
+
+`GET /entitlements`
+
+### Example responses
+
+> 200 Response
+
+```json
+{
+  "errors": ["string"],
+  "experimental": true,
+  "features": {
+    "property1": {
+      "actual": 0,
+      "enabled": true,
+      "entitlement": "string",
+      "limit": 0
+    },
+    "property2": {
+      "actual": 0,
+      "enabled": true,
+      "entitlement": "string",
+      "limit": 0
+    }
+  },
+  "has_license": true,
+  "trial": true,
+  "warnings": ["string"]
+}
+```
+
+### Responses
+
+| Status | Meaning                                                 | Description | Schema                                                   |
+| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------- |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          | [codersdk.Entitlements](schemas.md#codersdkentitlements) |
+
+To perform this operation, you must be authenticated. [Learn more](authentication.md).
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -2082,6 +2082,64 @@ CreateParameterRequest is a structure used to create a new parameter value for a
 | `usage`      | string  | false    |              |             |
 | `value`      | integer | false    |              |             |
 
+## codersdk.Entitlements
+
+```json
+{
+  "errors": ["string"],
+  "experimental": true,
+  "features": {
+    "property1": {
+      "actual": 0,
+      "enabled": true,
+      "entitlement": "string",
+      "limit": 0
+    },
+    "property2": {
+      "actual": 0,
+      "enabled": true,
+      "entitlement": "string",
+      "limit": 0
+    }
+  },
+  "has_license": true,
+  "trial": true,
+  "warnings": ["string"]
+}
+```
+
+### Properties
+
+| Name               | Type                                 | Required | Restrictions | Description |
+| ------------------ | ------------------------------------ | -------- | ------------ | ----------- |
+| `errors`           | array of string                      | false    |              |             |
+| `experimental`     | boolean                              | false    |              |             |
+| `features`         | object                               | false    |              |             |
+| » `[any property]` | [codersdk.Feature](#codersdkfeature) | false    |              |             |
+| `has_license`      | boolean                              | false    |              |             |
+| `trial`            | boolean                              | false    |              |             |
+| `warnings`         | array of string                      | false    |              |             |
+
+## codersdk.Feature
+
+```json
+{
+  "actual": 0,
+  "enabled": true,
+  "entitlement": "string",
+  "limit": 0
+}
+```
+
+### Properties
+
+| Name          | Type    | Required | Restrictions | Description |
+| ------------- | ------- | -------- | ------------ | ----------- |
+| `actual`      | integer | false    |              |             |
+| `enabled`     | boolean | false    |              |             |
+| `entitlement` | string  | false    |              |             |
+| `limit`       | integer | false    |              |             |
+
 ## codersdk.GenerateAPIKeyResponse
 
 ```json

diff --git a/docs/manifest.json b/docs/manifest.json
@@ -345,6 +345,10 @@
           "title": "Authorization",
           "path": "./api/authorization.md"
         },
+        {
+          "title": "Enterprise",
+          "path": "./api/enterprise.md"
+        },
         {
           "title": "Files",
           "path": "./api/files.md"

diff --git a/enterprise/coderd/coderd.go b/enterprise/coderd/coderd.go
@@ -331,6 +331,13 @@ func (api *API) updateEntitlements(ctx context.Context) error {
 	return nil
 }
 
+// @Summary Get entitlements
+// @ID get-entitlements
+// @Security CoderSessionToken
+// @Produce json
+// @Tags Enterprise
+// @Success 200 {object} codersdk.Entitlements
+// @Router /entitlements [get]
 func (api *API) serveEntitlements(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 	api.entitlementsMu.RLock()

diff --git a/scripts/apidocgen/generate.sh b/scripts/apidocgen/generate.sh
@@ -20,7 +20,7 @@ log "Use temporary file: ${API_MD_TMP_FILE}"
 pushd "${PROJECT_ROOT}"
 go run github.com/swaggo/swag/cmd/swag@v1.8.6 init \
 	--generalInfo="coderd.go" \
-	--dir="./coderd,./codersdk" \
+	--dir="./coderd,./codersdk,./enterprise/coderd" \
 	--output="./coderd/apidoc" \
 	--outputTypes="go,json" \
 	--parseDependency=true