api: split pulling API changes and regenerating new API

For checking wether the api was tempered with, we need separate action,
that just checks the code against the currently pulled spec.

This introduces two subactions for `npx api`.
These are `npx api:generate` and `npx api:pull`.
This commit is contained in:
Ondrej Ezr 2024-01-23 10:07:27 +01:00 committed by Lucas Garfield
parent 82e096a19c
commit 25144511ad
5 changed files with 27 additions and 5 deletions

19
api/README.md Normal file
View file

@ -0,0 +1,19 @@
# API
This folder contains generated code for API endpoints needed by this repo.
## Updating API changes
To pull new API changes and regenerating the code run
```shell
npm run api
```
## Regenerating the code only
To regenerate the code only, run
```shell
npm run api:generate
```

12
api/codegen.sh Normal file
View file

@ -0,0 +1,12 @@
#!/bin/bash
# Run commands in the background using & operator
npx @rtk-query/codegen-openapi ./api/config/imageBuilder.ts &
npx @rtk-query/codegen-openapi ./api/config/rhsm.ts &
npx @rtk-query/codegen-openapi ./api/config/contentSources.ts &
npx @rtk-query/codegen-openapi ./api/config/provisioning.ts &
npx @rtk-query/codegen-openapi ./api/config/edge.ts &
# Wait for all background jobs to finish
wait

4
api/pull.sh Normal file
View file

@ -0,0 +1,4 @@
#!/bin/bash
# Download the most up-to-date imageBuilder.yaml file and overwrite the existing one
curl https://raw.githubusercontent.com/osbuild/image-builder/main/internal/v1/api.yaml -o ./api/schema/imageBuilder.yaml