Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#788: documentation clarification #789

Merged
merged 1 commit into from Apr 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions factcast-site/documentation/content/concept/fact.md
Expand Up @@ -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}$"
}
Expand Down
9 changes: 9 additions & 0 deletions factcast-site/documentation/content/migration/_index.md
Expand Up @@ -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'.
Expand Down