Skip to content

feat: add kolkrabbi route registry and types#97

Open
erika-wallace wants to merge 1 commit into
mainfrom
ew/add-kolkrabbi-routes
Open

feat: add kolkrabbi route registry and types#97
erika-wallace wants to merge 1 commit into
mainfrom
ew/add-kolkrabbi-routes

Conversation

@erika-wallace

@erika-wallace erika-wallace commented Jul 22, 2026

Copy link
Copy Markdown

Summary

This PR adds route registry and types for Kolkrabbi API.

  • Add @heroku/types/kolkrabbi export for Kolkrabbi API type definitions
  • Add @heroku/types/kolkrabbi/routes export for runtime route metadata

Note:
The hand-written request/response types were verified against Kolkrabbi service Ruby source code

Routes added

Covers 8 Kolkrabbi endpoints across 5 resource groups:

  • account.infoWithToken - GET GitHub token for calling user
  • appLink.info - GET app-to-repo binding
  • appLink.update - PATCH app-to-repo binding settings
  • pipeline.listAppLinks - GET all app links for a pipeline
  • pipelineRepository.info - GET pipeline-to-repo binding
  • pipelineRepository.create - POST new pipeline-to-repo binding
  • pipelineRepository.update - PATCH pipeline-to-repo settings
  • githubTarball.info - GET archive URL for repo/ref

Files changed

  • dist/kolkrabbi/routes.js - Runtime route registry (method, path, hasRequestBody)
  • dist/kolkrabbi/routes.d.ts - Type declarations for routes
  • dist/kolkrabbi/types.d.ts - Request/response type definitions and HerokuClient interface
  • package.json - Added kolkrabbi exports

Type of Change

Breaking Changes (major semver update)

  • Add a ! after your change type to denote a change that breaks current behavior

Feature Additions (minor semver update)

  • feat: Introduces a new feature to the codebase

Patch Updates (patch semver update)

  • fix: Bug fix
  • deps: Dependency upgrade
  • revert: Revert a previous commit
  • chore: Change that does not affect production code
  • refactor: Refactoring existing code without changing behavior
  • test: Add/update/remove tests

Testing

Notes:

Steps:

  1. Pull down this branch
  2. npm i
  3. npm run typecheck

Screenshots (if applicable)

Related Issues

GUS work item: W-23374327

🤖 Generated with Claude Code

@erika-wallace
erika-wallace requested a review from a team as a code owner July 22, 2026 21:10
@erika-wallace erika-wallace changed the title Add Kolkrabbi route registry and types feat: add kolkrabbi route registry and types Jul 22, 2026

@tlowrimore-heroku tlowrimore-heroku left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Kolkrabbi exposes a Hyperschema that we should be able to use to generate these routes and types. Let's discuss!

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