#788: documentation clarification (#789)

factcast · Apr 29, 2020 · a55074a · a55074a
1 parent bba3c15
commit a55074a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/factcast-site/documentation/content/concept/fact.md b/factcast-site/documentation/content/concept/fact.md
@@ -49,11 +49,11 @@ JSON-Schema:
             "type": "string",
             "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
         },
-        "aggId": {
-            "id": "/properties/aggId",
+        "aggIds": {
+            "id": "/properties/aggIds",
             "type": "array",
             "items":{
-            	"id": "/properties/aggId/items",
+            	"id": "/properties/aggIds/items",
             	"type": "string",
                 "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
             }

diff --git a/factcast-site/documentation/content/migration/_index.md b/factcast-site/documentation/content/migration/_index.md
@@ -14,6 +14,15 @@ weight = 1000
 
 ## Upgrading to 0.2.0 (quite a lot)
 
+
+#### header field 'aggId' replaced by 'aggIds'
+
+This change was actually two years ago, but it was not documented well, and if you used certain factory methods of DefaultFact, a field 'aggId' was created/read.
+So, to make it perfectly clear, a Fact can have an 'aggIds' header field, which is an array of uuids.
+
+A FactSpec, however has an optional 'aggId' (without the 's'), as it is not an array, but a single one.
+We encourage you to update any header in your postgres, that contains 'aggId', rather than 'aggIds' in the course of migration to 0.2.0
+
 #### basic-auth setup has changed
 
 If you used a 'factcast-security.json' before, you will be please to learn that factcast was extended to support role/namespace based autorisation. Also the filename changed to 'factcast-access.json'.