diff options
Diffstat (limited to 'internal/gtsmodel/README.md')
| -rw-r--r-- | internal/gtsmodel/README.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/internal/gtsmodel/README.md b/internal/gtsmodel/README.md new file mode 100644 index 000000000..12a05ddec --- /dev/null +++ b/internal/gtsmodel/README.md @@ -0,0 +1,5 @@ +# gtsmodel + +This package contains types used *internally* by GoToSocial and added/removed/selected from the database. As such, they contain sensitive fields which should **never** be serialized or reach the API level. Use the [mastotypes](../../pkg/mastotypes) package for that. + +The annotation used on these structs is for handling them via the go-pg ORM. See [here](https://pg.uptrace.dev/models/). |