Skip to content

Add OpenAPI spec#280

Merged
n8mgr merged 4 commits intomasterfrom
pj/docs
Oct 9, 2025
Merged

Add OpenAPI spec#280
n8mgr merged 4 commits intomasterfrom
pj/docs

Conversation

@peterjan
Copy link
Copy Markdown
Member

@peterjan peterjan commented Oct 8, 2025

This PR adds an OpenAPI spec for walletd. I'm going to do the same for walletd and hostd. This is in reference to one of the goals we set last year, but we failed to accomplish it in due time. But better late than never.

I'm not too familiar with Scalar, I copy pasted the workflow from indexd and tweaked it a bit. The openapi spec was generated of course, I verified it manually though and ran it through a validator.

Fixes #273

@peterjan peterjan self-assigned this Oct 8, 2025
@github-project-automation github-project-automation bot moved this to In Progress in Sia Oct 8, 2025
@peterjan peterjan changed the title Aadd OpenAPI docs Add OpenAPI docs Oct 8, 2025
@peterjan
Copy link
Copy Markdown
Member Author

peterjan commented Oct 8, 2025

merge blocker: should add SCALAR_API_KEY secret

@peterjan peterjan marked this pull request as ready for review October 8, 2025 14:30
Copilot AI review requested due to automatic review settings October 8, 2025 14:30
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds an OpenAPI specification for the explored API to enable better documentation and API client generation. The specification includes comprehensive endpoint definitions, schema definitions, and authentication details for the Sia blockchain explorer API.

Key Changes:

  • Added complete OpenAPI 3.0 specification defining all explored API endpoints and data structures
  • Configured GitHub workflows for automated OpenAPI documentation publishing and version synchronization
  • Integrated with Scalar for hosted API documentation

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
openapi.yml Complete OpenAPI specification for explored API with endpoints, schemas, and authentication
.github/workflows/openapi-sync.yml Workflow to sync OpenAPI versions on releases
.github/workflows/openapi-publish.yml Workflow to publish OpenAPI docs to Scalar registry

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@peterjan peterjan changed the title Add OpenAPI docs Add OpenAPI spec Oct 8, 2025
alexfreska
alexfreska previously approved these changes Oct 8, 2025
@n8mgr
Copy link
Copy Markdown
Member

n8mgr commented Oct 9, 2025

@codex

chris124567
chris124567 previously approved these changes Oct 9, 2025
@alexfreska
Copy link
Copy Markdown
Member

@peterjan iirc SCALAR_API_KEY is available org wide.

@n8mgr n8mgr merged commit 9bd5e37 into master Oct 9, 2025
9 checks passed
@n8mgr n8mgr deleted the pj/docs branch October 9, 2025 18:28
@github-project-automation github-project-automation bot moved this from In Progress to Done in Sia Oct 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Add OpenAPI spec

6 participants