GitHub v3 REST API — Migrations

naftiko: 1.0.0-alpha2
info:
  label: GitHub v3 REST API — Migrations
  description: 'GitHub v3 REST API — Migrations. 11 operations. Lead operation: GitHub List Organization Migrations. Self-contained
    Naftiko capability covering one Github business surface.'
  tags:
  - Github
  - Migrations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GITHUB_API_KEY: GITHUB_API_KEY
capability:
  consumes:
  - type: http
    namespace: github-migrations
    baseUri: ''
    description: GitHub v3 REST API — Migrations business capability. Self-contained, no shared references.
    resources:
    - name: orgs-org-migrations
      path: /orgs/{org}/migrations
      operations:
      - name: migrationslistfororg
        method: GET
        description: GitHub List Organization Migrations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: exclude
          in: query
          type: array
          description: Exclude attributes from the API response to improve performance
      - name: migrationsstartfororg
        method: POST
        description: GitHub Start an Organization Migration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-org-migrations-migration_id
      path: /orgs/{org}/migrations/{migration_id}
      operations:
      - name: migrationsgetstatusfororg
        method: GET
        description: GitHub Get an Organization Migration Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: exclude
          in: query
          type: array
          description: Exclude attributes from the API response to improve performance
    - name: orgs-org-migrations-migration_id-archive
      path: /orgs/{org}/migrations/{migration_id}/archive
      operations:
      - name: migrationsdownloadarchivefororg
        method: GET
        description: GitHub Download an Organization Migration Archive
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: migrationsdeletearchivefororg
        method: DELETE
        description: GitHub Delete an Organization Migration Archive
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orgs-org-migrations-migration_id-repos-repo_name-lock
      path: /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock
      operations:
      - name: migrationsunlockrepofororg
        method: DELETE
        description: GitHub Unlock an Organization Repository
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orgs-org-migrations-migration_id-repositories
      path: /orgs/{org}/migrations/{migration_id}/repositories
      operations:
      - name: migrationslistreposfororg
        method: GET
        description: GitHub List Repositories in an Organization Migration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: user-migrations
      path: /user/migrations
      operations:
      - name: migrationslistforauthenticateduser
        method: GET
        description: GitHub List User Migrations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: migrationsstartforauthenticateduser
        method: POST
        description: GitHub Start a User Migration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: user-migrations-migration_id-archive
      path: /user/migrations/{migration_id}/archive
      operations:
      - name: migrationsgetarchiveforauthenticateduser
        method: GET
        description: GitHub Download a User Migration Archive
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: user-migrations-migration_id-repositories
      path: /user/migrations/{migration_id}/repositories
      operations:
      - name: migrationslistreposforauthenticateduser
        method: GET
        description: GitHub List Repositories for a User Migration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: github-migrations-rest
    port: 8080
    description: REST adapter for GitHub v3 REST API — Migrations. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/orgs/{org}/migrations
      name: orgs-org-migrations
      description: REST surface for orgs-org-migrations.
      operations:
      - method: GET
        name: migrationslistfororg
        description: GitHub List Organization Migrations
        call: github-migrations.migrationslistfororg
        with:
          exclude: rest.exclude
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: migrationsstartfororg
        description: GitHub Start an Organization Migration
        call: github-migrations.migrationsstartfororg
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{org}/migrations/{migration-id}
      name: orgs-org-migrations-migration-id
      description: REST surface for orgs-org-migrations-migration_id.
      operations:
      - method: GET
        name: migrationsgetstatusfororg
        description: GitHub Get an Organization Migration Status
        call: github-migrations.migrationsgetstatusfororg
        with:
          exclude: rest.exclude
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{org}/migrations/{migration-id}/archive
      name: orgs-org-migrations-migration-id-archive
      description: REST surface for orgs-org-migrations-migration_id-archive.
      operations:
      - method: GET
        name: migrationsdownloadarchivefororg
        description: GitHub Download an Organization Migration Archive
        call: github-migrations.migrationsdownloadarchivefororg
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: migrationsdeletearchivefororg
        description: GitHub Delete an Organization Migration Archive
        call: github-migrations.migrationsdeletearchivefororg
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{org}/migrations/{migration-id}/repos/{repo-name}/lock
      name: orgs-org-migrations-migration-id-repos-repo-name-lock
      description: REST surface for orgs-org-migrations-migration_id-repos-repo_name-lock.
      operations:
      - method: DELETE
        name: migrationsunlockrepofororg
        description: GitHub Unlock an Organization Repository
        call: github-migrations.migrationsunlockrepofororg
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orgs/{org}/migrations/{migration-id}/repositories
      name: orgs-org-migrations-migration-id-repositories
      description: REST surface for orgs-org-migrations-migration_id-repositories.
      operations:
      - method: GET
        name: migrationslistreposfororg
        description: GitHub List Repositories in an Organization Migration
        call: github-migrations.migrationslistreposfororg
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/user/migrations
      name: user-migrations
      description: REST surface for user-migrations.
      operations:
      - method: GET
        name: migrationslistforauthenticateduser
        description: GitHub List User Migrations
        call: github-migrations.migrationslistforauthenticateduser
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: migrationsstartforauthenticateduser
        description: GitHub Start a User Migration
        call: github-migrations.migrationsstartforauthenticateduser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/user/migrations/{migration-id}/archive
      name: user-migrations-migration-id-archive
      description: REST surface for user-migrations-migration_id-archive.
      operations:
      - method: GET
        name: migrationsgetarchiveforauthenticateduser
        description: GitHub Download a User Migration Archive
        call: github-migrations.migrationsgetarchiveforauthenticateduser
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/user/migrations/{migration-id}/repositories
      name: user-migrations-migration-id-repositories
      description: REST surface for user-migrations-migration_id-repositories.
      operations:
      - method: GET
        name: migrationslistreposforauthenticateduser
        description: GitHub List Repositories for a User Migration
        call: github-migrations.migrationslistreposforauthenticateduser
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: github-migrations-mcp
    port: 9090
    transport: http
    description: MCP adapter for GitHub v3 REST API — Migrations. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: github-list-organization-migrations
      description: GitHub List Organization Migrations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-migrations.migrationslistfororg
      with:
        exclude: tools.exclude
      outputParameters:
      - type: object
        mapping: $.
    - name: github-start-organization-migration
      description: GitHub Start an Organization Migration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: github-migrations.migrationsstartfororg
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: github-get-organization-migration-status
      description: GitHub Get an Organization Migration Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-migrations.migrationsgetstatusfororg
      with:
        exclude: tools.exclude
      outputParameters:
      - type: object
        mapping: $.
    - name: github-download-organization-migration-archive
      description: GitHub Download an Organization Migration Archive
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-migrations.migrationsdownloadarchivefororg
      outputParameters:
      - type: object
        mapping: $.
    - name: github-delete-organization-migration-archive
      description: GitHub Delete an Organization Migration Archive
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: github-migrations.migrationsdeletearchivefororg
      outputParameters:
      - type: object
        mapping: $.
    - name: github-unlock-organization-repository
      description: GitHub Unlock an Organization Repository
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: github-migrations.migrationsunlockrepofororg
      outputParameters:
      - type: object
        mapping: $.
    - name: github-list-repositories-organization-migration
      description: GitHub List Repositories in an Organization Migration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-migrations.migrationslistreposfororg
      outputParameters:
      - type: object
        mapping: $.
    - name: github-list-user-migrations
      description: GitHub List User Migrations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-migrations.migrationslistforauthenticateduser
      outputParameters:
      - type: object
        mapping: $.
    - name: github-start-user-migration
      description: GitHub Start a User Migration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: github-migrations.migrationsstartforauthenticateduser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: github-download-user-migration-archive
      description: GitHub Download a User Migration Archive
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-migrations.migrationsgetarchiveforauthenticateduser
      outputParameters:
      - type: object
        mapping: $.
    - name: github-list-repositories-user-migration
      description: GitHub List Repositories for a User Migration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: github-migrations.migrationslistreposforauthenticateduser
      outputParameters:
      - type: object
        mapping: $.