{"repo":"blockfrost/openapi","free":true,"listed":false,"github":"https://github.com/blockfrost/openapi","clone":"git clone https://github.com/blockfrost/openapi.git","description":"OpenAPI specification for Blockfrost.io service","language":"TypeScript","stars":26,"topics":["cardano","openapi","blockfrost"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"Blockfrost.io OpenAPI Open Source OpenAPI specification for Blockfrost.io backend API. Getting started • Development Getting started The development version is available in the master branch. The latest active release can be found under GitHub Releases. For the published documentation , visit docs.blockfrost.io. Development Blockfrost OpenAPI blockfrost-openapi.yaml specification is generated from all yaml files in src directory. Then there is Mithril Aggregator API spec mithril.yaml which can be downloaded from Mithril Github. These two specs are then merged together via openapi-merge-cli (configuration is inside openapi-merge.json ). Only the Mithril endpoints with a tag Cardano » Mithril are included into the final spec. Tag Cardano » Mithril needs to be added manually to each relevant endpoint in Mithril OpenAPI spec. If you add a new file then don't forget to add it to paths in src/definitions.yaml . Edit the source yaml files and build the package: Regenerating types TypeScript types ( src/generated-types.ts ) are regenerated as part of yarn build , or standalone with: Rust types (the rust/ crate) are generated from the bundled openapi.yaml , so run yarn build (or at least yarn bundle ) first if you have changed the source yaml files. The generation uses openapi-generator, which requires a Java runtime: If you don't have Java installed, use the Docker variant, which runs the same generator version inside a container: The generator version is pinned in openapitools.json ","default_branch":null,"files":null,"tree":[],"storefront":"/r/blockfrost","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/blockfrost/openapi/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}