feat: add kolkrabbi route registry and types#97
Open
erika-wallace wants to merge 1 commit into
Open
Conversation
tlowrimore-heroku
left a comment
Contributor
There was a problem hiding this comment.
Kolkrabbi exposes a Hyperschema that we should be able to use to generate these routes and types. Let's discuss!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds route registry and types for Kolkrabbi API.
@heroku/types/kolkrabbiexport for Kolkrabbi API type definitions@heroku/types/kolkrabbi/routesexport for runtime route metadataNote:
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 userappLink.info- GET app-to-repo bindingappLink.update- PATCH app-to-repo binding settingspipeline.listAppLinks- GET all app links for a pipelinepipelineRepository.info- GET pipeline-to-repo bindingpipelineRepository.create- POST new pipeline-to-repo bindingpipelineRepository.update- PATCH pipeline-to-repo settingsgithubTarball.info- GET archive URL for repo/refFiles changed
dist/kolkrabbi/routes.js- Runtime route registry (method, path, hasRequestBody)dist/kolkrabbi/routes.d.ts- Type declarations for routesdist/kolkrabbi/types.d.ts- Request/response type definitions and HerokuClient interfacepackage.json- Added kolkrabbi exportsType of Change
Breaking Changes (major semver update)
!after your change type to denote a change that breaks current behaviorFeature Additions (minor semver update)
Patch Updates (patch semver update)
Testing
Notes:
Steps:
npm inpm run typecheckScreenshots (if applicable)
Related Issues
GUS work item: W-23374327
🤖 Generated with Claude Code