I'm hoping to get help and/or someone from the Directus Team to provide insights so that I can make the PR:
The current package.json has scripts that do not match outputs like what appear in the API Docs:
|
"scripts": { |
|
"dev": "nodemon --watch './openapi/**/*.yaml' --exec 'redocly bundle ./openapi/index.yaml -o ./dist/index.yaml && pnpm scalar serve ./dist/oas.yaml -p 5001' --ext yaml", |
|
"build": "redocly bundle ./openapi/index.yaml -o ./dist/oas.yaml && redocly bundle ./openapi/index.yaml -o ./dist/oas.json --ext json && jiti scripts/build-js.ts", |
|
"lint": "redocly lint --max-problems=1000 ./dist/oas.yaml", |
|
"fix-casing": "npx tsx scripts/fix-casing.ts" |
|
}, |
I'd like to propose that the package.json and the README.md are updated (or a CONTRIBUTIONS.md is created that address the following:
- How to easily get an output that is similar to the API Docs when you run
pnpm dev
- Explanation of (and a 'how-to-get-it-right' for) the invisible character at
/openapi/index.yaml (line 40 has it)
|
"/comments": |
|
$ref: paths/comments/index.yaml |
|
"/comments": |
|
$ref: paths/comments/singular/index.yaml |
Maybe it's best to just put a comment block that can be copied and pasted then uncommented? A reminder for the reviewer? Or a PR Template that explains it? Not sure the best way to address.
Also, running pnpm lint throws errors in the current codebase that I wasn't sure if should have an explicit lint ignore on or not.
As an aside, it would be great to have a regular cadence from the Directus Team on getting PRs reviewed; I have a few open PRs that are getting stale on my end without explanation or feedback.
Addressing this should also address #46
I'm hoping to get help and/or someone from the Directus Team to provide insights so that I can make the PR:
The current
package.jsonhas scripts that do not match outputs like what appear in the API Docs:openapi/package.json
Lines 24 to 29 in 75e9cac
I'd like to propose that the
package.jsonand theREADME.mdare updated (or aCONTRIBUTIONS.mdis created that address the following:pnpm dev/openapi/index.yaml(line 40 has it)openapi/openapi/index.yaml
Lines 38 to 41 in 75e9cac
Maybe it's best to just put a comment block that can be copied and pasted then uncommented? A reminder for the reviewer? Or a PR Template that explains it? Not sure the best way to address.
Also, running
pnpm lintthrows errors in the current codebase that I wasn't sure if should have an explicit lint ignore on or not.As an aside, it would be great to have a regular cadence from the Directus Team on getting PRs reviewed; I have a few open PRs that are getting stale on my end without explanation or feedback.
Addressing this should also address #46