move to openapi json definitions

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Compression is enabled by default, can be disabled by setting
   `ENABLE_RESPONSE_COMPRESSION` to `false`. If using post-hooks, you must update
   to hooks to handle compression or disable compression.
+- OpenAPI definitions are now returned as JSON instead of YAML
 
 ## [4.2.0] - 2025-05-05
 

README.md

@@ -1466,6 +1466,12 @@ Next, edit that file to make it specific to this server. For example:
 - Fix each endpoint, especially the Landing Page defintion, which gets duplicated
 - Add definitions for each tag
 
+Then, convert the yaml to OpenAPI JSON document by running
+
+```shell
+yq -o=json src/lambdas/api/openapi.yaml > src/lambdas/api/openapi.json
+```
+
 To validate the resulting OpenAPI file, run
 
 ```shell

package.json

@@ -27,7 +27,7 @@
     "sls-remove": "sls remove",
     "package": "sls package",
     "serve": "REQUEST_LOGGING_FORMAT=dev LOG_LEVEL=debug STAC_API_URL=http://localhost:3000 ENABLE_TRANSACTIONS_EXTENSION=true nodemon --exec node --loader ts-node/esm ./src/lambdas/api/local.ts",
-    "build-api-docs": "npx @redocly/cli build-docs src/lambdas/api/openapi.yaml -o ./docs/index.html",
+    "build-api-docs": "npx @redocly/cli build-docs src/lambdas/api/openapi.json -o ./docs/index.html",
     "prepare": "husky"
   },
   "ava": {

src/lambdas/api/app.js

@@ -77,8 +77,8 @@ const pathName = process.env['LAMBDA_TASK_ROOT']
 
 app.get('/api', async (_req, res, next) => {
   try {
-    res.type('application/vnd.oai.openapi')
-    res.download(path.resolve(pathName, 'openapi.yaml'))
+    res.type('application/vnd.oai.openapi+json;version=3.0')
+    res.download(path.resolve(pathName, 'openapi.json'))
   } catch (error) {
     next(error)
   }