From 20dc5ebe60bfeb7ac0e7cee0f77d9408003611f6 Mon Sep 17 00:00:00 2001
From: Andy Mantell <134642+andymantell@users.noreply.github.com>
Date: Wed, 2 Oct 2024 13:38:02 +0100
Subject: [PATCH] Document organisation webapi notify api key requirement

---
 .../01-development-environment.adoc           | 23 +++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/docs/development/01-development-environment.adoc b/docs/development/01-development-environment.adoc
index ba5dbf42d..00f49cd5e 100644
--- a/docs/development/01-development-environment.adoc
+++ b/docs/development/01-development-environment.adoc
@@ -58,6 +58,29 @@ for the `organisation-app` service:
       OneLogin__PrivateKey: "-----BEGIN RSA PRIVATE KEY-----SECRET KEY-----END RSA PRIVATE KEY-----"
 ----
 
+=== Organisation WebApi
+
+The `Organisation.WebApi` requires the following secrets / environment variables:
+
+* `GOVUKNotify:ApiKey` / `GOVUKNotify__ApiKey`
+
+These can be set as secrets with the following dotnet commands:
+
+[source,bash]
+----
+dotnet user-secrets set --project Services/CO.CDP.Organisation.WebApi/CO.CDP.Organisation.WebApi.csproj GOVUKNotify:ApiKey "123456"
+----
+
+For Docker, the following environment variables need to be updated in `compose.override.yml`
+for the `organisation` service:
+
+[source,yaml]
+----
+  organisation:
+    environment:
+      GOVUKNotify__ApiKey: "123456"
+----
+
 === Authority API
 
 The `Authority` API depends on the following secrets / environment variables: