chore: add @kumahq/kuma-http-api package for housing out HTTP API types #3516
+590
−131
Conversation
This file contains 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
Signed-off-by: John Cowen <[email protected]>
✅ Deploy Preview for kuma-gui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
schogges
reviewed
Feb 6, 2025
Comment on lines
+30
to
+46
| build: types/fetch install ## Regenerate the TS types from kumahq/kuma OpenAPI specs | ||
| @npx openapi-typescript \ | ||
| $(KUMAHQ_HTTP_API)/kuma/docs/generated/openapi.yaml \ | ||
| -o $(KUMAHQ_HTTP_API)/index.d.ts | ||
|
|
||
| types/fetch: | ||
| @echo "Fetching latest kumahq/kuma@master..." | ||
| @cd $(KUMAHQ_HTTP_API) \ | ||
| && \ | ||
| if [ -d "./kuma/.git" ]; then \ | ||
| cd ./kuma \ | ||
| && git pull; \ | ||
| else \ | ||
| git clone https://github.com/kumahq/kuma.git \ | ||
| --single-branch --branch=master \ | ||
| --depth 1; \ | ||
| fi |
There was a problem hiding this comment.
Is there a specific reason why we are cloning the whole kuma repo while we could just use the remote schema?
I think this would work aswell:
npx openapi-typescript \
https://raw.githubusercontent.com/kumahq/kuma/refs/heads/master/docs/generated/openapi.yaml \
-o $(KUMAHQ_HTTP_API)/index.d.ts
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.
Adds new
@kumahq/kuma-http-apipackageAlso adds the necessary Makefile scripts to clone/update the remote kuma repository before generating types.
CI integration will be the next step here, which should just be able to call
make -C ./packages/kuma-http-api buildon a PR kuma itself. I've held off on that final step as I want to evaluate amount of noise, plus possible cyclic dependencies (if kuma submits a PR to us, and then we submit a PR to them etc etc)Note: The
index.d.tsfile should really be the same asauto-generated.d.ts, but as time has moved on slightly its not. There were no problems when runningmake lintin the application though.