chore(open-payments): fetch OpenAPI specs locally #846
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
mkurapov
previously approved these changes
Dec 15, 2022
packages/open-payments/package.json
Outdated
| "prepack": "pnpm build", | ||
| "test": "jest --passWithNoTests" | ||
| "test": "jest --passWithNoTests", | ||
| "copy-files": "cp ./src/openapi/*.yaml ./dist/openapi/" |
There was a problem hiding this comment.
should we move this up after clean?
| "fetch-schemas": "./scripts/fetch-schemas.sh", | ||
| "generate:auth-server-types": "openapi-typescript src/openapi/auth-server.yaml --output src/openapi/generated/auth-server-types.ts -t", | ||
| "generate:resource-server-types": "openapi-typescript src/openapi/resource-server.yaml --output src/openapi/generated/resource-server-types.ts -t", | ||
| "generate:types": "pnpm generate:auth-server-types && pnpm generate:resource-server-types", |
There was a problem hiding this comment.
I went down the rabbit hole to try and put up a fix for getting version openapi-typescript v6.1.0 working (https://github.com/interledger/rafiki/issues/729) to properly generate the external type but no luck. Version 5.4.0 was the last one that was working with the proper type generation. We can keep this here until openapi-ts/openapi-typescript#993 is fixed
packages/open-payments/package.json
Outdated
| "clean": "rm -fr dist/", | ||
| "generate:types": "npx ts-node scripts/generate-types.ts", | ||
| "fetch-schemas": "./scripts/fetch-schemas.sh", | ||
| "generate:auth-server-types": "openapi-typescript src/openapi/auth-server.yaml --output src/openapi/generated/auth-server-types.ts -t", |
There was a problem hiding this comment.
why types over interfaces btw?
There was a problem hiding this comment.
I don't know 😅
-t isn't even an option in the version we're using...
Generate TypeScript types from Swagger OpenAPI specs
Usage
$ openapi-typescript [input] [options]
Options
--help display this
--output, -o Specify output file (default: stdout)
--auth (optional) Provide an authentication token for private URL
--headersObject, -h (optional) Provide a JSON object as string of HTTP headers for remote schema request
--header, -x (optional) Provide an array of or singular headers as an alternative to a JSON object. Each header must follow the key: value pattern
--httpMethod, -m (optional) Provide the HTTP Verb/Method for fetching a schema from a remote URL
--immutable-types, -it (optional) Generates immutable types (readonly properties and readonly array)
--additional-properties, -ap (optional) Allow arbitrary properties for all schema objects without "additionalProperties: false"
--default-non-nullable (optional) If a schema object has a default value set, don’t mark it as nullable
--prettier-config, -c (optional) specify path to Prettier config file
--raw-schema (optional) Parse as partial schema (raw components)
--version (optional) Force schema parsing version
mkurapov
reviewed
Dec 15, 2022
| @@ -67,9 +67,6 @@ pnpm clean | |||
|
|
|||
| # install dependencies | |||
| pnpm i | |||
|
|
|||
| # pull in latest openapi specs: | |||
| pnpm fetch-schemas | |||
There was a problem hiding this comment.
I think the README in the auth package also has a fetch-schemas reference
mkurapov
previously approved these changes
Dec 16, 2022
mkurapov
approved these changes
Dec 16, 2022
| "localenv": "docker compose -f ./infrastructure/local/docker-compose.yml -f ./infrastructure/local/peer-docker-compose.yml", | ||
| "localenv:build": "docker compose -f ./infrastructure/local/docker-compose.yml -f ./infrastructure/local/peer-docker-compose.yml -f ./infrastructure/local/build-override.yml build", | ||
| "localenv:seed:auth": "pnpm -C ./packages/auth knex seed:run --env=development && pnpm -C ./packages/auth knex seed:run --env=peerdevelopment", | ||
| "localenv:dbvolumes:remove": "docker volume rm local_database-data && docker volume rm local_tigerbeetle-data", | ||
| "sanity": "pnpm fetch-schemas pnpm -r build && pnpm -r test" |
There was a problem hiding this comment.
What was the sanity for, originally? Should anything else belong here?
There was a problem hiding this comment.
I don't know why it was added
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.
Changes proposed in this pull request
open-paymentsauthandbackendpnpm fetch-schemasis no longer required, and Open Payments OpenAPI specs now live in a single place in the monorepo (where they can optionally be modified).Context
Checklist
fixes #number