Migrate API docs from Apiary to OpenAPI 3.1 + Scalar on GitHub Pages

.github/workflows/apidocs.yml

@@ -0,0 +1,40 @@
+name: API Docs
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - openapi.json
+      - apidocs/**
+      - .github/workflows/apidocs.yml
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Assemble site
+        run: |
+          mkdir -p _site
+          cp apidocs/index.html openapi.json _site/
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: _site
+
+      - id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/pylint_scanner.yml

@@ -28,10 +28,14 @@ jobs:
         pip install --upgrade pylint pylint-sarif-unofficial
         cd counterparty-rs && pip install -e . && cd ..
         cd counterparty-core && pip install -e . && cd ..
+        # pylint2sarif (via python_jsonschema_objects) breaks with the
+        # jsonschema>=4.18 resolver that schemathesis pulls in; pin it back
+        # for this scan-only environment
+        pip install "jsonschema<4.18"
     - name: Analysing the code with pylint
       run: |
         pylint2sarif $(git ls-files '*.py' | grep -v counterparty-rs/tests/ | grep -v counterparty-core/counterpartycore/test/ | grep -v counterparty-core/tools/) || true
     - name: Upload SARIF
-      uses: github/codeql-action/upload-sarif/@v2
+      uses: github/codeql-action/upload-sarif/@v3
       with:
         sarif_file: pylint.sarif

.github/workflows/pytest_action.yml

@@ -71,7 +71,6 @@ jobs:
           sudo cp bitcoin-28.0/bin/bitcoin-cli /usr/local/bin/bitcoin-cli
           sudo cp bitcoin-28.0/bin/bitcoind /usr/local/bin/bitcoind
           sudo cp bitcoin-28.0/bin/bitcoin-wallet /usr/local/bin/bitcoin-wallet
-          npm install dredd --global
           git clone https://github.com/mempool/electrs && cd electrs
           rustup toolchain install nightly
           cargo +nightly update
@@ -93,6 +92,13 @@ jobs:
             mv .coverage ../
           fi
 
+      - name: Upload generated OpenAPI spec
+        if: inputs.test-path == 'integrations/regtest/scenarios_test.py'
+        uses: actions/upload-artifact@v4
+        with:
+          name: openapi-spec
+          path: openapi.json
+
       - name: Save integration cache
         if: always() && inputs.integration_cache_network != ''
         uses: actions/cache/save@v4

README.md

@@ -58,7 +58,7 @@
 
 **Counterparty Core** is the reference implementation of the [Counterparty Protocol](https://counterparty.io), an extension to the Bitcoin protocol which implements a number of features that Bitcoin itself does not offer. These include token issuance, a fully decentralized and trustless asset exchange, contracts for difference, native oracles and trustless gaming. Counterparty works by ‘writing in the margins’ of Bitcoin transactions, and all Counterparty transactions are Bitcoin transactions with additional data that the Counterparty software can read and interpret.
 
-See the **[official project documentation](http://docs.counterparty.io)** for more information, and for instructions on installing and running the Counterparty software.
+See the **[official project documentation](http://docs.counterparty.io)** for more information, and for instructions on installing and running the Counterparty software. The reference for the Counterparty Core API is available at **[apidocs.counterparty.io](https://apidocs.counterparty.io/)**.
 
 
 ## Contributing