Bump.sh · Capability

Spec Preview On Pull Request

Spec Preview On Pull Request is a Naftiko capability published by Bump.sh, one of 6 capabilities the APIs.io network indexes for this provider.

Can be deployed as a REST endpoint, MCP tool, or Agent Skill via Naftiko.

Run with Naftiko

Capability Spec

apiVersion: naftiko.io/v1
kind: Capability
metadata:
  id: spec-preview-on-pull-request
  name: Spec Preview on Pull Request
  provider: bump-sh
  description: >-
    Generate an ephemeral, shareable preview of an OpenAPI or AsyncAPI
    specification for reviewers on every pull request without publishing the
    change to a permanent documentation.
spec:
  inputs:
    - name: definitionContent
      description: Raw specification content (JSON or YAML).
  steps:
    - id: create-preview
      uses: bump-sh-api.createPreview
      with:
        definition: ${{ inputs.definitionContent }}
    - id: refresh-preview
      uses: bump-sh-api.updatePreview
      with:
        preview_id: ${{ steps.create-preview.outputs.id }}
        definition: ${{ inputs.definitionContent }}
      condition: ${{ inputs.refresh == true }}
  outputs:
    previewUrl: ${{ steps.create-preview.outputs.public_url }}
    expiresAt: ${{ steps.create-preview.outputs.expires_at }}