oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-06-13 08:03:15 +02:00
Code Releases Activity

update copy

Browse Source
This commit is contained in:
Matthias Kretschmann 2019-04-17 12:58:02 +02:00
parent 880dcc8fc7
commit 8fef5459f7
Signed by: m
GPG Key ID: 606EEEF3C479A91F
2 changed files with 7 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -194,14 +194,12 @@ The sidebar for those generated reference pages will automatically switch to inc
#### Swagger specs
Reference pages based on Swagger specs are sourced from a Swagger spec `json` file, at the moment they simply live as manual copies under `/data/`:
Reference pages based on Swagger specs are sourced from remotely hosted Swagger specs:
- [`aquarius.json`](./data/aquarius.json)
- [`brizo.json`](./data/brizo.json)
- [`https://nginx-aquarius.dev-ocean.com/spec`](https://nginx-aquarius.dev-ocean.com/spec)
- [`https://nginx-brizo.dev-ocean.com/spec`](https://nginx-brizo.dev-ocean.com/spec)
There's no automation setup around updating those files so [until this is setup](https://github.com/oceanprotocol/docs/issues/74), they need to be manually updated with copy & paste, like they did in the middle ages. You can copy them from a running instance of Aquarius or Brizo which will expose those spec files, e.g. under `localhost:5000/spec` for Aquarius and `localhost:8030/spec` for Brizo.
For more information about stylistic issues, take a look at the section in the test page:
They are fetched and updated automatically upon every site build. For more information about stylistic issues, take a look at the section in the test page:
- [Swagger spec references](https://docs.oceanprotocol.com/test#swagger-spec-references)

8
content/references/introduction.md
View File

@ -1,11 +1,9 @@
---
title: API & Library References
description: All the references for Ocean Protocol components.
title: API References
description: All the API reference docs for Ocean Protocol components and libraries.
---
**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:
This section has API reference docs (or links to external ones) for the following Ocean Protocol components and libraries:
<repo name="aquarius"></repo>
<repo name="brizo"></repo>