Skip to content

Generate OpenAPI 3.0 specification and configure self-hosted CI runners#41

Draft
Copilot wants to merge 3 commits intomasterfrom
copilot/generate-openapi-3-0
Draft

Generate OpenAPI 3.0 specification and configure self-hosted CI runners#41
Copilot wants to merge 3 commits intomasterfrom
copilot/generate-openapi-3-0

Conversation

Copy link

Copilot AI commented Feb 10, 2026

Adds OpenAPI 3.0 specification for the Base.org Web API and migrates CI infrastructure to self-hosted runners.

Changes

OpenAPI 3.0 Specification (apps/web/openapi.yaml)

  • Documents 26 endpoints across 11 categories (Basenames, Proofs, Registry, Mining, etc.)
  • Includes complete request/response schemas with validation patterns
  • Supports Bearer Token (JWT) and Basic Auth
  • Validates with swagger-cli and spectral

Private Data Protection (.gitignore)

Excludes private API documentation patterns:

openapi.private.*
api-docs-private.*
swagger-private.*

Self-Hosted Runners

Migrated 6 GitHub Actions workflows from ubuntu-latest to [self-hosted, linux]:

  • main.yml, node.js.yml, e2e-tests.yml
  • bearer.yml, file-size-checker.yml, update-algolia.yml

Documentation

  • API_DOCUMENTATION.md: Usage guide with client generation examples
  • OPENAPI_QUICKREF.md: Quick reference for common operations

Usage

View API docs:

docker run -p 8080:8080 -e SWAGGER_JSON=/openapi.yaml \
  -v $(pwd)/apps/web/openapi.yaml:/openapi.yaml swaggerapi/swagger-ui

Generate TypeScript client:

npx @openapitools/openapi-generator-cli generate \
  -i apps/web/openapi.yaml -g typescript-fetch -o ./client

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits February 10, 2026 22:20
…d configure self-hosted runners

Co-authored-by: Kushmanmb <193178375+Kushmanmb@users.noreply.github.com>
Co-authored-by: Kushmanmb <193178375+Kushmanmb@users.noreply.github.com>
Copilot AI changed the title [WIP] Add OpenAPI 3.0 specification Generate OpenAPI 3.0 specification and configure self-hosted CI runners Feb 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants