Structure adjustments (#6)

# Motivations Organization # Modifications - Move everything to `/spec` - Rename `openapi.yml` to `reference.yml` - Produce a `.yml` bundle on top of a `.yaml`, just to make it easier for anyone using the remote spec locations - Adjust `package.json` scripts to be more organized, readable, and easily modular - Upgrade Redocly to latest
satisfactory-oas · Oct 13, 2024 · c23293a · c23293a
1 parent 8d868fc
commit c23293a
Show file tree

Hide file tree

Showing 70 changed files with 10 additions and 5 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -45,7 +45,7 @@ jobs:
         configFilePath: GitVersion.yml
 
     - name: Replace - Version
-      run: sed -i 's/0.0.0/${{ steps.gitversion.outputs.majorMinorPatch }}${{ steps.gitversion.outputs.preReleaseLabel }}${{ steps.gitversion.outputs.preReleaseNumber }}/g' openapi/openapi.yml
+      run: sed -i 's/0.0.0/${{ steps.gitversion.outputs.majorMinorPatch }}${{ steps.gitversion.outputs.preReleaseLabel }}${{ steps.gitversion.outputs.preReleaseNumber }}/g' spec/reference.yml
 
     - name: Bun - Install
       run: bun install --frozen-lockfile

diff --git a/bun.lockb b/bun.lockb
diff --git a/package.json b/package.json
@@ -1,13 +1,18 @@
 {
-  "name": "satisfactory-api-v1",
+  "name": "satisfactory-api-spec",
   "version": "1.0.0",
   "private": true,
   "scripts": {
+    "bundle-yaml": "openapi bundle -o dist/$npm_package_name.yaml",
+    "bundle-yml": "openapi bundle -o dist/$npm_package_name.yml",
+    "bundle-json": "openapi bundle -o dist/$npm_package_name.json",
+    "bundle": "bun run bundle-yaml && bun run bundle-yml && bun run bundle-json",
+    "build-redoc": "openapi build-docs dist/$npm_package_name.yaml -o dist/index.html",
+    "build": "bun run bundle && bun run build-redoc",
     "start": "openapi preview-docs",
-    "build": "openapi bundle -o dist/satisfactory-api-spec.yaml && openapi bundle -o dist/satisfactory-api-spec.json && openapi build-docs dist/satisfactory-api-spec.yaml -o dist/index.html",
     "lint": "openapi lint"
   },
   "dependencies": {
-    "@redocly/cli": "^1.25.3"
+    "@redocly/cli": "^1.25.5"
   }
 }
diff --git a/redocly.yml b/redocly.yml
@@ -1,7 +1,7 @@
 # See https://docs.redoc.ly/cli/configuration/ for more information.
 apis:
   main@v1:
-    root: openapi/openapi.yml
+    root: spec/reference.yml
 extends:
 - recommended
 rules:

diff --git a/openapi/components/responses/error.yml → spec/components/responses/error.yml b/openapi/components/responses/error.yml → spec/components/responses/error.yml
diff --git a/...mponents/schemas/advancedGameSettings.yml → ...mponents/schemas/advancedGameSettings.yml b/...mponents/schemas/advancedGameSettings.yml → ...mponents/schemas/advancedGameSettings.yml
diff --git a/openapi/components/schemas/error.yml → spec/components/schemas/error.yml b/openapi/components/schemas/error.yml → spec/components/schemas/error.yml
diff --git a/...api/components/schemas/privilegeLevel.yml → spec/components/schemas/privilegeLevel.yml b/...api/components/schemas/privilegeLevel.yml → spec/components/schemas/privilegeLevel.yml
diff --git a/openapi/components/schemas/saveHeader.yml → spec/components/schemas/saveHeader.yml b/openapi/components/schemas/saveHeader.yml → spec/components/schemas/saveHeader.yml
diff --git a/openapi/components/schemas/serverOptions.yml → spec/components/schemas/serverOptions.yml b/openapi/components/schemas/serverOptions.yml → spec/components/schemas/serverOptions.yml
diff --git a/.../components/schemas/sessionSaveStruct.yml → .../components/schemas/sessionSaveStruct.yml b/.../components/schemas/sessionSaveStruct.yml → .../components/schemas/sessionSaveStruct.yml
diff --git a/...ameSettings/applyAdvancedGameSettings.yml → ...ameSettings/applyAdvancedGameSettings.yml b/...ameSettings/applyAdvancedGameSettings.yml → ...ameSettings/applyAdvancedGameSettings.yml
diff --git a/...ings/applyAdvancedGameSettingsRequest.yml → ...ings/applyAdvancedGameSettingsRequest.yml b/...ings/applyAdvancedGameSettingsRequest.yml → ...ings/applyAdvancedGameSettingsRequest.yml
diff --git a/...applyServerOptions/applyServerOptions.yml → ...applyServerOptions/applyServerOptions.yml b/...applyServerOptions/applyServerOptions.yml → ...applyServerOptions/applyServerOptions.yml
diff --git a/...rverOptions/applyServerOptionsRequest.yml → ...rverOptions/applyServerOptionsRequest.yml b/...rverOptions/applyServerOptionsRequest.yml → ...rverOptions/applyServerOptionsRequest.yml
diff --git a/...api/functions/claimServer/claimServer.yml → spec/functions/claimServer/claimServer.yml b/...api/functions/claimServer/claimServer.yml → spec/functions/claimServer/claimServer.yml
diff --git a/...ctions/claimServer/claimServerRequest.yml → ...ctions/claimServer/claimServerRequest.yml b/...ctions/claimServer/claimServerRequest.yml → ...ctions/claimServer/claimServerRequest.yml
diff --git a/...tions/claimServer/claimServerResponse.yml → ...tions/claimServer/claimServerResponse.yml b/...tions/claimServer/claimServerResponse.yml → ...tions/claimServer/claimServerResponse.yml
diff --git a/...functions/createNewGame/createNewGame.yml → ...functions/createNewGame/createNewGame.yml b/...functions/createNewGame/createNewGame.yml → ...functions/createNewGame/createNewGame.yml
diff --git a/...ns/createNewGame/createNewGameRequest.yml → ...ns/createNewGame/createNewGameRequest.yml b/...ns/createNewGame/createNewGameRequest.yml → ...ns/createNewGame/createNewGameRequest.yml
diff --git a/...nctions/deleteSaveFile/deleteSaveFile.yml → ...nctions/deleteSaveFile/deleteSaveFile.yml b/...nctions/deleteSaveFile/deleteSaveFile.yml → ...nctions/deleteSaveFile/deleteSaveFile.yml
diff --git a/.../deleteSaveFile/deleteSaveFileRequest.yml → .../deleteSaveFile/deleteSaveFileRequest.yml b/.../deleteSaveFile/deleteSaveFileRequest.yml → .../deleteSaveFile/deleteSaveFileRequest.yml
diff --git a/...s/deleteSaveSession/deleteSaveSession.yml → ...s/deleteSaveSession/deleteSaveSession.yml b/...s/deleteSaveSession/deleteSaveSession.yml → ...s/deleteSaveSession/deleteSaveSession.yml
diff --git a/...eSaveSession/deleteSaveSessionRequest.yml → ...eSaveSession/deleteSaveSessionRequest.yml b/...eSaveSession/deleteSaveSessionRequest.yml → ...eSaveSession/deleteSaveSessionRequest.yml
diff --git a/...ons/downloadSaveGame/downloadSaveGame.yml → ...ons/downloadSaveGame/downloadSaveGame.yml b/...ons/downloadSaveGame/downloadSaveGame.yml → ...ons/downloadSaveGame/downloadSaveGame.yml
diff --git a/...nloadSaveGame/downloadSaveGameRequest.yml → ...nloadSaveGame/downloadSaveGameRequest.yml b/...nloadSaveGame/downloadSaveGameRequest.yml → ...nloadSaveGame/downloadSaveGameRequest.yml
diff --git a/...s/enumerateSessions/enumerateSessions.yml → ...s/enumerateSessions/enumerateSessions.yml b/...s/enumerateSessions/enumerateSessions.yml → ...s/enumerateSessions/enumerateSessions.yml
diff --git a/...rateSessions/enumerateSessionsRequest.yml → ...rateSessions/enumerateSessionsRequest.yml b/...rateSessions/enumerateSessionsRequest.yml → ...rateSessions/enumerateSessionsRequest.yml
diff --git a/...ateSessions/enumerateSessionsResponse.yml → ...ateSessions/enumerateSessionsResponse.yml b/...ateSessions/enumerateSessionsResponse.yml → ...ateSessions/enumerateSessionsResponse.yml
diff --git a/...dGameSettings/getAdvancedGameSettings.yml → ...dGameSettings/getAdvancedGameSettings.yml b/...dGameSettings/getAdvancedGameSettings.yml → ...dGameSettings/getAdvancedGameSettings.yml
diff --git a/...ttings/getAdvancedGameSettingsRequest.yml → ...ttings/getAdvancedGameSettingsRequest.yml b/...ttings/getAdvancedGameSettingsRequest.yml → ...ttings/getAdvancedGameSettingsRequest.yml
diff --git a/...tings/getAdvancedGameSettingsResponse.yml → ...tings/getAdvancedGameSettingsResponse.yml b/...tings/getAdvancedGameSettingsResponse.yml → ...tings/getAdvancedGameSettingsResponse.yml
diff --git a/...ons/getServerOptions/getServerOptions.yml → ...ons/getServerOptions/getServerOptions.yml b/...ons/getServerOptions/getServerOptions.yml → ...ons/getServerOptions/getServerOptions.yml
diff --git a/...ServerOptions/getServerOptionsRequest.yml → ...ServerOptions/getServerOptionsRequest.yml b/...ServerOptions/getServerOptionsRequest.yml → ...ServerOptions/getServerOptionsRequest.yml
diff --git a/...erverOptions/getServerOptionsResponse.yml → ...erverOptions/getServerOptionsResponse.yml b/...erverOptions/getServerOptionsResponse.yml → ...erverOptions/getServerOptionsResponse.yml
diff --git a/...api/functions/healthCheck/healthCheck.yml → spec/functions/healthCheck/healthCheck.yml b/...api/functions/healthCheck/healthCheck.yml → spec/functions/healthCheck/healthCheck.yml
diff --git a/...ctions/healthCheck/healthCheckRequest.yml → ...ctions/healthCheck/healthCheckRequest.yml b/...ctions/healthCheck/healthCheckRequest.yml → ...ctions/healthCheck/healthCheckRequest.yml
diff --git a/...tions/healthCheck/healthCheckResponse.yml → ...tions/healthCheck/healthCheckResponse.yml b/...tions/healthCheck/healthCheckResponse.yml → ...tions/healthCheck/healthCheckResponse.yml
diff --git a/openapi/functions/loadGame/loadGame.yml → spec/functions/loadGame/loadGame.yml b/openapi/functions/loadGame/loadGame.yml → spec/functions/loadGame/loadGame.yml
diff --git a/...pi/functions/loadGame/loadGameRequest.yml → spec/functions/loadGame/loadGameRequest.yml b/...pi/functions/loadGame/loadGameRequest.yml → spec/functions/loadGame/loadGameRequest.yml
diff --git a/...functions/passwordLogin/passwordLogin.yml → ...functions/passwordLogin/passwordLogin.yml b/...functions/passwordLogin/passwordLogin.yml → ...functions/passwordLogin/passwordLogin.yml
diff --git a/...ns/passwordLogin/passwordLoginRequest.yml → ...ns/passwordLogin/passwordLoginRequest.yml b/...ns/passwordLogin/passwordLoginRequest.yml → ...ns/passwordLogin/passwordLoginRequest.yml
diff --git a/...s/passwordLogin/passwordLoginResponse.yml → ...s/passwordLogin/passwordLoginResponse.yml b/...s/passwordLogin/passwordLoginResponse.yml → ...s/passwordLogin/passwordLoginResponse.yml
diff --git a/...s/passwordlessLogin/passwordlessLogin.yml → ...s/passwordlessLogin/passwordlessLogin.yml b/...s/passwordlessLogin/passwordlessLogin.yml → ...s/passwordlessLogin/passwordlessLogin.yml
diff --git a/...ordlessLogin/passwordlessLoginRequest.yml → ...ordlessLogin/passwordlessLoginRequest.yml b/...ordlessLogin/passwordlessLoginRequest.yml → ...ordlessLogin/passwordlessLoginRequest.yml
diff --git a/...rdlessLogin/passwordlessLoginResponse.yml → ...rdlessLogin/passwordlessLoginResponse.yml b/...rdlessLogin/passwordlessLoginResponse.yml → ...rdlessLogin/passwordlessLoginResponse.yml
diff --git a/...ons/queryServerState/queryServerState.yml → ...ons/queryServerState/queryServerState.yml b/...ons/queryServerState/queryServerState.yml → ...ons/queryServerState/queryServerState.yml
diff --git a/...ryServerState/queryServerStateRequest.yml → ...ryServerState/queryServerStateRequest.yml b/...ryServerState/queryServerStateRequest.yml → ...ryServerState/queryServerStateRequest.yml
diff --git a/...yServerState/queryServerStateResponse.yml → ...yServerState/queryServerStateResponse.yml b/...yServerState/queryServerStateResponse.yml → ...yServerState/queryServerStateResponse.yml
diff --git a/...i/functions/renameServer/renameServer.yml → spec/functions/renameServer/renameServer.yml b/...i/functions/renameServer/renameServer.yml → spec/functions/renameServer/renameServer.yml
diff --git a/...ions/renameServer/renameServerRequest.yml → ...ions/renameServer/renameServerRequest.yml b/...ions/renameServer/renameServerRequest.yml → ...ions/renameServer/renameServerRequest.yml
diff --git a/openapi/functions/runCommand/runCommand.yml → spec/functions/runCommand/runCommand.yml b/openapi/functions/runCommand/runCommand.yml → spec/functions/runCommand/runCommand.yml
diff --git a/...unctions/runCommand/runCommandRequest.yml → ...unctions/runCommand/runCommandRequest.yml b/...unctions/runCommand/runCommandRequest.yml → ...unctions/runCommand/runCommandRequest.yml
diff --git a/...nctions/runCommand/runCommandResponse.yml → ...nctions/runCommand/runCommandResponse.yml b/...nctions/runCommand/runCommandResponse.yml → ...nctions/runCommand/runCommandResponse.yml
diff --git a/openapi/functions/saveGame/saveGame.yml → spec/functions/saveGame/saveGame.yml b/openapi/functions/saveGame/saveGame.yml → spec/functions/saveGame/saveGame.yml
diff --git a/...pi/functions/saveGame/saveGameRequest.yml → spec/functions/saveGame/saveGameRequest.yml b/...pi/functions/saveGame/saveGameRequest.yml → spec/functions/saveGame/saveGameRequest.yml
diff --git a/...ons/setAdminPassword/setAdminPassword.yml → ...ons/setAdminPassword/setAdminPassword.yml b/...ons/setAdminPassword/setAdminPassword.yml → ...ons/setAdminPassword/setAdminPassword.yml
diff --git a/...AdminPassword/setAdminPasswordRequest.yml → ...AdminPassword/setAdminPasswordRequest.yml b/...AdminPassword/setAdminPasswordRequest.yml → ...AdminPassword/setAdminPasswordRequest.yml
diff --git a/...dminPassword/setAdminPasswordResponse.yml → ...dminPassword/setAdminPasswordResponse.yml b/...dminPassword/setAdminPasswordResponse.yml → ...dminPassword/setAdminPasswordResponse.yml
diff --git a/...oadSessionName/setAutoLoadSessionName.yml → ...oadSessionName/setAutoLoadSessionName.yml b/...oadSessionName/setAutoLoadSessionName.yml → ...oadSessionName/setAutoLoadSessionName.yml
diff --git a/...ionName/setAutoLoadSessionNameRequest.yml → ...ionName/setAutoLoadSessionNameRequest.yml b/...ionName/setAutoLoadSessionNameRequest.yml → ...ionName/setAutoLoadSessionNameRequest.yml
diff --git a/...s/setClientPassword/setClientPassword.yml → ...s/setClientPassword/setClientPassword.yml b/...s/setClientPassword/setClientPassword.yml → ...s/setClientPassword/setClientPassword.yml
diff --git a/...ientPassword/setClientPasswordRequest.yml → ...ientPassword/setClientPasswordRequest.yml b/...ientPassword/setClientPasswordRequest.yml → ...ientPassword/setClientPasswordRequest.yml
diff --git a/openapi/functions/shutdown/shutdown.yml → spec/functions/shutdown/shutdown.yml b/openapi/functions/shutdown/shutdown.yml → spec/functions/shutdown/shutdown.yml
diff --git a/...pi/functions/shutdown/shutdownRequest.yml → spec/functions/shutdown/shutdownRequest.yml b/...pi/functions/shutdown/shutdownRequest.yml → spec/functions/shutdown/shutdownRequest.yml
diff --git a/...nctions/uploadSaveGame/uploadSaveGame.yml → ...nctions/uploadSaveGame/uploadSaveGame.yml b/...nctions/uploadSaveGame/uploadSaveGame.yml → ...nctions/uploadSaveGame/uploadSaveGame.yml
diff --git a/.../uploadSaveGame/uploadSaveGameRequest.yml → .../uploadSaveGame/uploadSaveGameRequest.yml b/.../uploadSaveGame/uploadSaveGameRequest.yml → .../uploadSaveGame/uploadSaveGameRequest.yml
diff --git a/...cationToken/verifyAuthenticationToken.yml → ...cationToken/verifyAuthenticationToken.yml b/...cationToken/verifyAuthenticationToken.yml → ...cationToken/verifyAuthenticationToken.yml
diff --git a/...oken/verifyAuthenticationTokenRequest.yml → ...oken/verifyAuthenticationTokenRequest.yml b/...oken/verifyAuthenticationTokenRequest.yml → ...oken/verifyAuthenticationTokenRequest.yml
diff --git a/openapi/openapi.yml → spec/reference.yml b/openapi/openapi.yml → spec/reference.yml