Speakeasy API — Github

naftiko: 1.0.0-alpha2
info:
  label: Speakeasy API — Github
  description: 'Speakeasy API — Github. 11 operations. Lead operation: Github. Self-contained Naftiko capability covering
    one Speakeasy business surface.'
  tags:
  - Speakeasy
  - Github
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SPEAKEASY_API_KEY: SPEAKEASY_API_KEY
capability:
  consumes:
  - type: http
    namespace: speakeasy-github
    baseUri: https://api.prod.speakeasy.com
    description: Speakeasy API — Github business capability. Self-contained, no shared references.
    resources:
    - name: v1-github-action
      path: /v1/github/action
      operations:
      - name: getgithubaction
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: targetName
          in: query
          type: string
          description: The targetName of the workflow target.
        - name: org
          in: query
          type: string
          required: true
        - name: repo
          in: query
          type: string
          required: true
    - name: v1-github-check_access
      path: /v1/github/check_access
      operations:
      - name: checkgithubaccess
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          required: true
        - name: repo
          in: query
          type: string
          required: true
    - name: v1-github-configure_code_samples
      path: /v1/github/configure_code_samples
      operations:
      - name: githubconfigurecodesamples
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-github-configure_mintlify_repo
      path: /v1/github/configure_mintlify_repo
      operations:
      - name: githubconfiguremintlifyrepo
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-github-configure_target
      path: /v1/github/configure_target
      operations:
      - name: githubconfiguretarget
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-github-link
      path: /v1/github/link
      operations:
      - name: linkgithubaccess
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: installation_id
          in: query
          type: string
        - name: github_org
          in: query
          type: string
        - name: github_oidc_token
          in: query
          type: string
    - name: v1-github-publishing_prs
      path: /v1/github/publishing_prs
      operations:
      - name: githubcheckpublishingprs
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: generate_gen_lock_id
          in: query
          type: string
          required: true
        - name: org
          in: query
          type: string
          required: true
        - name: repo
          in: query
          type: string
          required: true
    - name: v1-github-publishing_secrets
      path: /v1/github/publishing_secrets
      operations:
      - name: githubcheckpublishingsecrets
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: generate_gen_lock_id
          in: query
          type: string
          required: true
      - name: githubstorepublishingsecrets
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-github-setup
      path: /v1/github/setup
      operations:
      - name: getgithubsetupstate
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          required: true
        - name: repo
          in: query
          type: string
          required: true
        - name: generate_gen_lock_id
          in: query
          type: string
          required: true
    - name: v1-github-trigger_action
      path: /v1/github/trigger_action
      operations:
      - name: githubtriggeraction
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.SPEAKEASY_API_KEY}}'
  exposes:
  - type: rest
    namespace: speakeasy-github-rest
    port: 8080
    description: REST adapter for Speakeasy API — Github. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/github/action
      name: v1-github-action
      description: REST surface for v1-github-action.
      operations:
      - method: GET
        name: getgithubaction
        description: getgithubaction
        call: speakeasy-github.getgithubaction
        with:
          targetName: rest.targetName
          org: rest.org
          repo: rest.repo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/github/check-access
      name: v1-github-check-access
      description: REST surface for v1-github-check_access.
      operations:
      - method: GET
        name: checkgithubaccess
        description: checkgithubaccess
        call: speakeasy-github.checkgithubaccess
        with:
          org: rest.org
          repo: rest.repo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/github/configure-code-samples
      name: v1-github-configure-code-samples
      description: REST surface for v1-github-configure_code_samples.
      operations:
      - method: POST
        name: githubconfigurecodesamples
        description: githubconfigurecodesamples
        call: speakeasy-github.githubconfigurecodesamples
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/github/configure-mintlify-repo
      name: v1-github-configure-mintlify-repo
      description: REST surface for v1-github-configure_mintlify_repo.
      operations:
      - method: POST
        name: githubconfiguremintlifyrepo
        description: githubconfiguremintlifyrepo
        call: speakeasy-github.githubconfiguremintlifyrepo
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/github/configure-target
      name: v1-github-configure-target
      description: REST surface for v1-github-configure_target.
      operations:
      - method: POST
        name: githubconfiguretarget
        description: githubconfiguretarget
        call: speakeasy-github.githubconfiguretarget
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/github/link
      name: v1-github-link
      description: REST surface for v1-github-link.
      operations:
      - method: POST
        name: linkgithubaccess
        description: linkgithubaccess
        call: speakeasy-github.linkgithubaccess
        with:
          installation_id: rest.installation_id
          github_org: rest.github_org
          github_oidc_token: rest.github_oidc_token
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/github/publishing-prs
      name: v1-github-publishing-prs
      description: REST surface for v1-github-publishing_prs.
      operations:
      - method: GET
        name: githubcheckpublishingprs
        description: githubcheckpublishingprs
        call: speakeasy-github.githubcheckpublishingprs
        with:
          generate_gen_lock_id: rest.generate_gen_lock_id
          org: rest.org
          repo: rest.repo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/github/publishing-secrets
      name: v1-github-publishing-secrets
      description: REST surface for v1-github-publishing_secrets.
      operations:
      - method: GET
        name: githubcheckpublishingsecrets
        description: githubcheckpublishingsecrets
        call: speakeasy-github.githubcheckpublishingsecrets
        with:
          generate_gen_lock_id: rest.generate_gen_lock_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: githubstorepublishingsecrets
        description: githubstorepublishingsecrets
        call: speakeasy-github.githubstorepublishingsecrets
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/github/setup
      name: v1-github-setup
      description: REST surface for v1-github-setup.
      operations:
      - method: GET
        name: getgithubsetupstate
        description: getgithubsetupstate
        call: speakeasy-github.getgithubsetupstate
        with:
          org: rest.org
          repo: rest.repo
          generate_gen_lock_id: rest.generate_gen_lock_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/github/trigger-action
      name: v1-github-trigger-action
      description: REST surface for v1-github-trigger_action.
      operations:
      - method: POST
        name: githubtriggeraction
        description: githubtriggeraction
        call: speakeasy-github.githubtriggeraction
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: speakeasy-github-mcp
    port: 9090
    transport: http
    description: MCP adapter for Speakeasy API — Github. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: getgithubaction
      description: getgithubaction
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: speakeasy-github.getgithubaction
      with:
        targetName: tools.targetName
        org: tools.org
        repo: tools.repo
      outputParameters:
      - type: object
        mapping: $.
    - name: checkgithubaccess
      description: checkgithubaccess
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: speakeasy-github.checkgithubaccess
      with:
        org: tools.org
        repo: tools.repo
      outputParameters:
      - type: object
        mapping: $.
    - name: githubconfigurecodesamples
      description: githubconfigurecodesamples
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: speakeasy-github.githubconfigurecodesamples
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: githubconfiguremintlifyrepo
      description: githubconfiguremintlifyrepo
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: speakeasy-github.githubconfiguremintlifyrepo
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: githubconfiguretarget
      description: githubconfiguretarget
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: speakeasy-github.githubconfiguretarget
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: linkgithubaccess
      description: linkgithubaccess
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: speakeasy-github.linkgithubaccess
      with:
        installation_id: tools.installation_id
        github_org: tools.github_org
        github_oidc_token: tools.github_oidc_token
      outputParameters:
      - type: object
        mapping: $.
    - name: githubcheckpublishingprs
      description: githubcheckpublishingprs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: speakeasy-github.githubcheckpublishingprs
      with:
        generate_gen_lock_id: tools.generate_gen_lock_id
        org: tools.org
        repo: tools.repo
      outputParameters:
      - type: object
        mapping: $.
    - name: githubcheckpublishingsecrets
      description: githubcheckpublishingsecrets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: speakeasy-github.githubcheckpublishingsecrets
      with:
        generate_gen_lock_id: tools.generate_gen_lock_id
      outputParameters:
      - type: object
        mapping: $.
    - name: githubstorepublishingsecrets
      description: githubstorepublishingsecrets
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: speakeasy-github.githubstorepublishingsecrets
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: getgithubsetupstate
      description: getgithubsetupstate
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: speakeasy-github.getgithubsetupstate
      with:
        org: tools.org
        repo: tools.repo
        generate_gen_lock_id: tools.generate_gen_lock_id
      outputParameters:
      - type: object
        mapping: $.
    - name: githubtriggeraction
      description: githubtriggeraction
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: speakeasy-github.githubtriggeraction
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.