diff options
| author | Bryan Newbold <bnewbold@robocracy.org> | 2018-09-11 13:59:32 -0700 |
|---|---|---|
| committer | Bryan Newbold <bnewbold@robocracy.org> | 2018-09-11 13:59:32 -0700 |
| commit | cd8e09fcb6ee0a1b23c0bd57d0f097f99fd6d828 (patch) | |
| tree | fbd5c91c576a2fce2c44cfe36e5754b69aedc046 /rust/HACKING.md | |
| parent | 0dc872921023030f6ffd320eb038e5379b47fa53 (diff) | |
| download | fatcat-cd8e09fcb6ee0a1b23c0bd57d0f097f99fd6d828.tar.gz fatcat-cd8e09fcb6ee0a1b23c0bd57d0f097f99fd6d828.zip | |
refactor fatcat-api => fatcat-api-spec
Diffstat (limited to 'rust/HACKING.md')
| -rw-r--r-- | rust/HACKING.md | 5 |
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 |