1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-02 08:20:22 +01:00
docs/content/references/introduction.md

23 lines
977 B
Markdown
Raw Normal View History

2018-11-23 15:08:58 +01:00
---
2018-11-29 22:02:12 +01:00
title: API & Library References
description: All the references for Ocean Protocol components.
2018-11-23 15:08:58 +01:00
---
2018-11-29 22:02:12 +01:00
**Heads Up! This reference section is in heavy development and updated as we integrate data from various code reference tools into this site.**
The following components expose a consumable REST API which are documented on this site:
2018-11-23 15:08:58 +01:00
<repo name="aquarius"></repo>
<repo name="brizo"></repo>
Those are sourced from their respective Swagger specs. On this site you can't execute the documented API calls yet. If you need this, you can run a component's local Swagger UI as outlined in the repository instructions on GitHub.
2018-11-29 22:02:12 +01:00
References of all the functions and methods used in our libraries are not yet integrated here. For now, have a look at the respective repos for more infos:
2018-11-23 15:08:58 +01:00
<repo name="squid-js"></repo>
<repo name="squid-py"></repo>
ReadTheDocs hosts the [squid-py API Reference Docs](https://squid-py.readthedocs.io/en/latest/).
2018-11-23 15:08:58 +01:00
<repo name="squid-java"></repo>