From d9a81c6131fb0d0c7536f9d91892dc6e07a76ec4 Mon Sep 17 00:00:00 2001 From: Robby Uitbeijerse Date: Fri, 10 Nov 2023 10:42:13 +0100 Subject: [PATCH] chore: improve sdk docs (#101) * chore: improve sdk docs * chore: improve sdk docs --- pages/service/sdk.mdx | 33 ++++++++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/pages/service/sdk.mdx b/pages/service/sdk.mdx index a6f51f5..d8d5872 100644 --- a/pages/service/sdk.mdx +++ b/pages/service/sdk.mdx @@ -1,18 +1,23 @@ import { Callout, Cards, Card } from "nextra/components"; -# SDK +# Beam Accounts SDK The recommended way to interact with the Beam API is by using one of our official SDKs. All of the provided SDKs are meant to be used **server side**, as it's crucial to not expose any of the api keys we provided publicly. +At the time of writing, the SDKs we're shipping are all automatically generated after every service release. We're currently using [OpenAPI generator](https://openapi-generator.tech/) and [OpenAPI Typescript Codegen](https://www.npmjs.com/package/openapi-typescript-codegen). + - It's of the utmost importants that your api key never gets exposed. If your + It's of the utmost Importance that your api key never gets exposed. If your api key is / has been at risk of being exposed, please contact - build@onbeam.com. + build@onbeam.com. Alternatively: re-create your API keys yourself using the + provided regenerate-key, the old ones will automatically be invalidated. +--- + ### Beam SDKs -In order to get started, we currently provide the following SDKs. Note that if there's no available SDK available for your preferred language, there's always the possibility of directly connecting to Beam it's RESTful API. +In order to get started, we currently provide the following SDKs. Note that if there's no available SDK available for your preferred language, there's always the possibility of directly connecting to the RESTful endpoints by passing your API key in the `x-api-key` header. +--- + +### Beam SDK repository + +If you're interseted in how we generate the SDK, have a look at the [Github repository](https://github.com/Merit-Circle/beam-sdk). If you don't want to use our provided SDKs, it might still be of inspiration. + +--- + +### Releases + +If you are interested in more granular changelogs for SDK releases, have a look at our [Github releases](https://github.com/Merit-Circle/beam-sdk/releases) + +Every deployment of the Beam API leads to a new **patch** version of the SDK being released. With every release, the release description in the Github release contains a description that explains the difference between the previous and new version based on the REStful endpoints. + +In the future, we hope to automatically assess major, minor and patch versions, but we currently rely on patch incrementals only. + +--- + ### Beam OpenAPI Specification -Beam OpenAPI specification empowers you with a broad set of developer tooling, starting with Postman collections and generating your own SDK. +Beam OpenAPI specification empowers you with a broad set of developer tooling, starting with Postman collections and generating your own SDK. It also serves as the basis for our generated release changelogs and SDKs. [Beam OpenAPI Specification](https://api.testnet.onbeam.com/api/game-json)