summaryrefslogtreecommitdiffstats
path: root/rust/HACKING.md
diff options
context:
space:
mode:
Diffstat (limited to 'rust/HACKING.md')
-rw-r--r--rust/HACKING.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/rust/HACKING.md b/rust/HACKING.md
index 0dde5058..57642b2d 100644
--- a/rust/HACKING.md
+++ b/rust/HACKING.md
@@ -16,8 +16,9 @@ swagger API spec on one side and the SQL schema on the other.
- `./src/api_wrappers.rs`: hand- and macro-generated wrapper functions, one per
API endpoint, that map between API request and return types, and
rust-idiomatic request and return types (plus API models).
-- `./fatcat-api`: autogenerated API models and endpoint types/signatures
-- `../fatcat-openapi2.yaml`:
+- `./fatcat-api-spec`: autogenerated API models and endpoint types/signatures
+- `../fatcat-openapi2.yaml`: OpenAPI 2 specification of API models and
+ endpoints
When deciding to use this structure, it wasn't expected that either
`api_wrappers.rs` or `database_models.rs` would need to hand-maintained; both