mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
fixes
This commit is contained in:
parent
c1b156e08e
commit
f45a142ddf
@ -29,7 +29,7 @@ The main and new key component introduced to support these additional Publisher
|
|||||||
|
|
||||||
Ocean Provider is the technical component executed by the **Publishers**, which provides extended data services. Ocean Provider includes the credentials to interact with the infrastructure (initially in cloud providers, but it could be on-premise).
|
Ocean Provider is the technical component executed by the **Publishers**, which provides extended data services. Ocean Provider includes the credentials to interact with the infrastructure (initially in cloud providers, but it could be on-premise).
|
||||||
|
|
||||||
### Compute-to-Data Enviroment (Operator-Service)
|
### Compute-to-Data Environment (Operator-Service)
|
||||||
|
|
||||||
The Operator Service is a micro-service that implements part of the Compute-to-Data spec [OEP-12](https://github.com/oceanprotocol/OEPs/tree/master/12),
|
The Operator Service is a micro-service that implements part of the Compute-to-Data spec [OEP-12](https://github.com/oceanprotocol/OEPs/tree/master/12),
|
||||||
in charge of managing the workflow executing requests.
|
in charge of managing the workflow executing requests.
|
||||||
|
@ -10,9 +10,10 @@ This section has API reference docs (or links to external ones) for the followin
|
|||||||
<repo name="provider"></repo>
|
<repo name="provider"></repo>
|
||||||
<repo name="react"></repo>
|
<repo name="react"></repo>
|
||||||
<repo name="ocean.py"></repo>
|
<repo name="ocean.py"></repo>
|
||||||
<repo name="ocean-contracts"></repo>
|
<repo name="contracts"></repo>
|
||||||
|
|
||||||
The API references for Aquarius and Provider are auto-generated from the Swagger specs (JSON files) of the live instances. On this site you can't execute the documented API calls yet. If you need that, you can run a component's local Swagger UI as outlined in the repository instructions on GitHub.
|
The API references for Aquarius and Provider are auto-generated from the Swagger specs (JSON files) of the live instances. On this site you can't execute the documented API calls yet. If you need that, you can run a component's local Swagger UI as outlined in the repository instructions on GitHub.
|
||||||
|
|
||||||
Additionally, if you need API docs for a past version of Aquarius or Provider, check out their specs on SwaggerHub:
|
Additionally, if you need API docs for a past version of Aquarius or Provider, check out their specs on SwaggerHub:
|
||||||
|
|
||||||
- [SwaggerHub: Aquarius](https://app.swaggerhub.com/apis/Ocean-Protocol/aquarius)
|
- [SwaggerHub: Aquarius](https://app.swaggerhub.com/apis/Ocean-Protocol/aquarius)
|
||||||
|
@ -149,7 +149,7 @@ Some text to show that the reference links can follow later.
|
|||||||
|
|
||||||
Here's our jellyfish, with the title being output as caption:
|
Here's our jellyfish, with the title being output as caption:
|
||||||
|
|
||||||
![alt text](../node_modules/@oceanprotocol/art/jellyfish/jellyfish-grid@2x.png 'Ocean Protocol Jellyfish')
|
![alt text](../node_modules/@oceanprotocol/art/creatures/jellyfish/jellyfish-grid@2x.png 'Ocean Protocol Jellyfish')
|
||||||
|
|
||||||
## Code and Syntax Highlighting
|
## Code and Syntax Highlighting
|
||||||
|
|
||||||
@ -370,14 +370,14 @@ In all Markdown docs you can use some select React Components. This magic is don
|
|||||||
The `Repository` component fetching and displaying information about a GitHub repo. Component can be used in Markdown as `<repo>`, it requires a `name` to be passed:
|
The `Repository` component fetching and displaying information about a GitHub repo. Component can be used in Markdown as `<repo>`, it requires a `name` to be passed:
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<repo name="commons"></repo>
|
<repo name="market"></repo>
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that the component name in Markdown needs to be always in lowercase, and have a closing tag.
|
Note that the component name in Markdown needs to be always in lowercase, and have a closing tag.
|
||||||
|
|
||||||
Resulting in:
|
Resulting in:
|
||||||
|
|
||||||
<repo name="commons"></repo>
|
<repo name="market"></repo>
|
||||||
|
|
||||||
You can also pass `readme="true"` and the readme contents of the repo will be rendered:
|
You can also pass `readme="true"` and the readme contents of the repo will be rendered:
|
||||||
|
|
||||||
@ -394,19 +394,19 @@ Resulting in:
|
|||||||
You can embed any file contents like so, note that the language needs to be defined manually to get proper syntax highlighting:
|
You can embed any file contents like so, note that the language needs to be defined manually to get proper syntax highlighting:
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
GITHUB-EMBED https://github.com/oceanprotocol/squid-js/blob/master/src/keeper/Web3Provider.ts js GITHUB-EMBED
|
GITHUB-EMBED https://github.com/oceanprotocol/ocean.js/blob/main/src/lib.ts js GITHUB-EMBED
|
||||||
```
|
```
|
||||||
|
|
||||||
Resulting in:
|
Resulting in:
|
||||||
|
|
||||||
GITHUB-EMBED https://github.com/oceanprotocol/squid-js/blob/master/src/keeper/Web3Provider.ts js GITHUB-EMBED
|
GITHUB-EMBED https://github.com/oceanprotocol/ocean.js/blob/main/src/lib.ts js GITHUB-EMBED
|
||||||
|
|
||||||
## Swagger spec references
|
## Swagger spec references
|
||||||
|
|
||||||
Many Swagger fields like the description (`info.description`) are rendered through Markdown so you can write actual Markdown in those fields.
|
Many Swagger fields like the description (`info.description`) are rendered through Markdown so you can write actual Markdown in those fields.
|
||||||
|
|
||||||
- [Aquarius API reference](/references/aquarius/)
|
- [Aquarius API reference](/references/aquarius/)
|
||||||
- [Brizo API reference](/references/brizo/)
|
- [Provider API reference](/references/provider/)
|
||||||
|
|
||||||
For a complete overview of everything supported by Swagger and implemented in this site, take a look at the hidden Pet Store example:
|
For a complete overview of everything supported by Swagger and implemented in this site, take a look at the hidden Pet Store example:
|
||||||
|
|
||||||
|
@ -37,7 +37,7 @@ const queryGithub = graphql`
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
object(expression: "develop:README.md") {
|
object(expression: "main:README.md") {
|
||||||
id
|
id
|
||||||
... on GitHub_Blob {
|
... on GitHub_Blob {
|
||||||
text
|
text
|
||||||
|
Loading…
Reference in New Issue
Block a user