https://github.com/oasisprotocol/docs-api
API reference documentation
https://github.com/oasisprotocol/docs-api
Last synced: 3 months ago
JSON representation
API reference documentation
- Host: GitHub
- URL: https://github.com/oasisprotocol/docs-api
- Owner: oasisprotocol
- Created: 2021-06-18T10:24:07.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2026-02-26T16:47:29.000Z (4 months ago)
- Last Synced: 2026-02-26T22:56:41.295Z (4 months ago)
- Size: 642 KB
- Stars: 0
- Watchers: 10
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Oasis API reference documentation
Branch `gh-pages` in this repository hosts the https://api.docs.oasis.io
site.
## `gh-pages` organization
- `js`: contains API reference for JavaScript and TypeScript packages named
after the package name deployed at npmjs.org, but with stripped
`@oasisprotocol/` prefix. For example `@oasisprotocol/client` is hosted
inside `js/client` folder.
- `sol`: contains API reference for Solidity packages named after the package
name deployed at npmjs.org, but with stripped `@oasisprotocol/` prefix. For
example `@oasisprotocol/sapphire-contracts` is hosted inside
`sol/sapphire-contracts`.
- `py`: contains API reference for Python packages named after the import name
of the package e.g. `sapphirepy`.
- `rust`: contains API reference for Rust packages named after the import name
of the package e.g. `oasis_runtime_sdk`.
`gh-pages` branch is periodically updated by fetching the content of
`api-reference` branch of the `oasis-sdk`, `sapphire-paratime` and other Oasis
repositories in the future.