Skip to content

Commit

Permalink
Update add apis
Browse files Browse the repository at this point in the history
  • Loading branch information
Fireye04 committed Aug 12, 2024
1 parent b14b96e commit 648a151
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/dev/add_apis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,7 @@ Use this as an opportunity to debug your API calls so they work as intended befo
Add a schema
============
`Sasquatch <https://sasquatch.lsst.io>`__ (the wearer of the proverbial backpack), uses `Avro schemas <https://sasquatch.lsst.io/user-guide/avro.html>`__
for data serialization. Navigate to ``src/sasquatchbackpack/schemas`` and create a ``.avsc`` file for each different API call you want to make.
for data serialization. Navigate to ``src/sasquatchbackpack/schemas`` and create a folder for your API.
Inside, create a ``.avsc`` file for each different API call you want to make. The contents of the file depends on the data in question, so
make sure to look at what you're getting from your API call and use the doccumentation to create an accurate representation of that data that you'll be sending.

0 comments on commit 648a151

Please sign in to comment.