diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 98c0e61..732ecb2 100644 --- 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 index 142c19e..36ba2a5 100644 Binary files a/bun.lockb and b/bun.lockb differ diff --git a/package.json b/package.json index a8fef76..6cc3fee 100644 --- 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" } } \ No newline at end of file diff --git a/redocly.yml b/redocly.yml index 637ebbd..aa6ee9d 100644 --- 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 b/spec/components/responses/error.yml similarity index 100% rename from openapi/components/responses/error.yml rename to spec/components/responses/error.yml diff --git a/openapi/components/schemas/advancedGameSettings.yml b/spec/components/schemas/advancedGameSettings.yml similarity index 100% rename from openapi/components/schemas/advancedGameSettings.yml rename to spec/components/schemas/advancedGameSettings.yml diff --git a/openapi/components/schemas/error.yml b/spec/components/schemas/error.yml similarity index 100% rename from openapi/components/schemas/error.yml rename to spec/components/schemas/error.yml diff --git a/openapi/components/schemas/privilegeLevel.yml b/spec/components/schemas/privilegeLevel.yml similarity index 100% rename from openapi/components/schemas/privilegeLevel.yml rename to spec/components/schemas/privilegeLevel.yml diff --git a/openapi/components/schemas/saveHeader.yml b/spec/components/schemas/saveHeader.yml similarity index 100% rename from openapi/components/schemas/saveHeader.yml rename to spec/components/schemas/saveHeader.yml diff --git a/openapi/components/schemas/serverOptions.yml b/spec/components/schemas/serverOptions.yml similarity index 100% rename from openapi/components/schemas/serverOptions.yml rename to spec/components/schemas/serverOptions.yml diff --git a/openapi/components/schemas/sessionSaveStruct.yml b/spec/components/schemas/sessionSaveStruct.yml similarity index 100% rename from openapi/components/schemas/sessionSaveStruct.yml rename to spec/components/schemas/sessionSaveStruct.yml diff --git a/openapi/functions/applyAdvancedGameSettings/applyAdvancedGameSettings.yml b/spec/functions/applyAdvancedGameSettings/applyAdvancedGameSettings.yml similarity index 100% rename from openapi/functions/applyAdvancedGameSettings/applyAdvancedGameSettings.yml rename to spec/functions/applyAdvancedGameSettings/applyAdvancedGameSettings.yml diff --git a/openapi/functions/applyAdvancedGameSettings/applyAdvancedGameSettingsRequest.yml b/spec/functions/applyAdvancedGameSettings/applyAdvancedGameSettingsRequest.yml similarity index 100% rename from openapi/functions/applyAdvancedGameSettings/applyAdvancedGameSettingsRequest.yml rename to spec/functions/applyAdvancedGameSettings/applyAdvancedGameSettingsRequest.yml diff --git a/openapi/functions/applyServerOptions/applyServerOptions.yml b/spec/functions/applyServerOptions/applyServerOptions.yml similarity index 100% rename from openapi/functions/applyServerOptions/applyServerOptions.yml rename to spec/functions/applyServerOptions/applyServerOptions.yml diff --git a/openapi/functions/applyServerOptions/applyServerOptionsRequest.yml b/spec/functions/applyServerOptions/applyServerOptionsRequest.yml similarity index 100% rename from openapi/functions/applyServerOptions/applyServerOptionsRequest.yml rename to spec/functions/applyServerOptions/applyServerOptionsRequest.yml diff --git a/openapi/functions/claimServer/claimServer.yml b/spec/functions/claimServer/claimServer.yml similarity index 100% rename from openapi/functions/claimServer/claimServer.yml rename to spec/functions/claimServer/claimServer.yml diff --git a/openapi/functions/claimServer/claimServerRequest.yml b/spec/functions/claimServer/claimServerRequest.yml similarity index 100% rename from openapi/functions/claimServer/claimServerRequest.yml rename to spec/functions/claimServer/claimServerRequest.yml diff --git a/openapi/functions/claimServer/claimServerResponse.yml b/spec/functions/claimServer/claimServerResponse.yml similarity index 100% rename from openapi/functions/claimServer/claimServerResponse.yml rename to spec/functions/claimServer/claimServerResponse.yml diff --git a/openapi/functions/createNewGame/createNewGame.yml b/spec/functions/createNewGame/createNewGame.yml similarity index 100% rename from openapi/functions/createNewGame/createNewGame.yml rename to spec/functions/createNewGame/createNewGame.yml diff --git a/openapi/functions/createNewGame/createNewGameRequest.yml b/spec/functions/createNewGame/createNewGameRequest.yml similarity index 100% rename from openapi/functions/createNewGame/createNewGameRequest.yml rename to spec/functions/createNewGame/createNewGameRequest.yml diff --git a/openapi/functions/deleteSaveFile/deleteSaveFile.yml b/spec/functions/deleteSaveFile/deleteSaveFile.yml similarity index 100% rename from openapi/functions/deleteSaveFile/deleteSaveFile.yml rename to spec/functions/deleteSaveFile/deleteSaveFile.yml diff --git a/openapi/functions/deleteSaveFile/deleteSaveFileRequest.yml b/spec/functions/deleteSaveFile/deleteSaveFileRequest.yml similarity index 100% rename from openapi/functions/deleteSaveFile/deleteSaveFileRequest.yml rename to spec/functions/deleteSaveFile/deleteSaveFileRequest.yml diff --git a/openapi/functions/deleteSaveSession/deleteSaveSession.yml b/spec/functions/deleteSaveSession/deleteSaveSession.yml similarity index 100% rename from openapi/functions/deleteSaveSession/deleteSaveSession.yml rename to spec/functions/deleteSaveSession/deleteSaveSession.yml diff --git a/openapi/functions/deleteSaveSession/deleteSaveSessionRequest.yml b/spec/functions/deleteSaveSession/deleteSaveSessionRequest.yml similarity index 100% rename from openapi/functions/deleteSaveSession/deleteSaveSessionRequest.yml rename to spec/functions/deleteSaveSession/deleteSaveSessionRequest.yml diff --git a/openapi/functions/downloadSaveGame/downloadSaveGame.yml b/spec/functions/downloadSaveGame/downloadSaveGame.yml similarity index 100% rename from openapi/functions/downloadSaveGame/downloadSaveGame.yml rename to spec/functions/downloadSaveGame/downloadSaveGame.yml diff --git a/openapi/functions/downloadSaveGame/downloadSaveGameRequest.yml b/spec/functions/downloadSaveGame/downloadSaveGameRequest.yml similarity index 100% rename from openapi/functions/downloadSaveGame/downloadSaveGameRequest.yml rename to spec/functions/downloadSaveGame/downloadSaveGameRequest.yml diff --git a/openapi/functions/enumerateSessions/enumerateSessions.yml b/spec/functions/enumerateSessions/enumerateSessions.yml similarity index 100% rename from openapi/functions/enumerateSessions/enumerateSessions.yml rename to spec/functions/enumerateSessions/enumerateSessions.yml diff --git a/openapi/functions/enumerateSessions/enumerateSessionsRequest.yml b/spec/functions/enumerateSessions/enumerateSessionsRequest.yml similarity index 100% rename from openapi/functions/enumerateSessions/enumerateSessionsRequest.yml rename to spec/functions/enumerateSessions/enumerateSessionsRequest.yml diff --git a/openapi/functions/enumerateSessions/enumerateSessionsResponse.yml b/spec/functions/enumerateSessions/enumerateSessionsResponse.yml similarity index 100% rename from openapi/functions/enumerateSessions/enumerateSessionsResponse.yml rename to spec/functions/enumerateSessions/enumerateSessionsResponse.yml diff --git a/openapi/functions/getAdvancedGameSettings/getAdvancedGameSettings.yml b/spec/functions/getAdvancedGameSettings/getAdvancedGameSettings.yml similarity index 100% rename from openapi/functions/getAdvancedGameSettings/getAdvancedGameSettings.yml rename to spec/functions/getAdvancedGameSettings/getAdvancedGameSettings.yml diff --git a/openapi/functions/getAdvancedGameSettings/getAdvancedGameSettingsRequest.yml b/spec/functions/getAdvancedGameSettings/getAdvancedGameSettingsRequest.yml similarity index 100% rename from openapi/functions/getAdvancedGameSettings/getAdvancedGameSettingsRequest.yml rename to spec/functions/getAdvancedGameSettings/getAdvancedGameSettingsRequest.yml diff --git a/openapi/functions/getAdvancedGameSettings/getAdvancedGameSettingsResponse.yml b/spec/functions/getAdvancedGameSettings/getAdvancedGameSettingsResponse.yml similarity index 100% rename from openapi/functions/getAdvancedGameSettings/getAdvancedGameSettingsResponse.yml rename to spec/functions/getAdvancedGameSettings/getAdvancedGameSettingsResponse.yml diff --git a/openapi/functions/getServerOptions/getServerOptions.yml b/spec/functions/getServerOptions/getServerOptions.yml similarity index 100% rename from openapi/functions/getServerOptions/getServerOptions.yml rename to spec/functions/getServerOptions/getServerOptions.yml diff --git a/openapi/functions/getServerOptions/getServerOptionsRequest.yml b/spec/functions/getServerOptions/getServerOptionsRequest.yml similarity index 100% rename from openapi/functions/getServerOptions/getServerOptionsRequest.yml rename to spec/functions/getServerOptions/getServerOptionsRequest.yml diff --git a/openapi/functions/getServerOptions/getServerOptionsResponse.yml b/spec/functions/getServerOptions/getServerOptionsResponse.yml similarity index 100% rename from openapi/functions/getServerOptions/getServerOptionsResponse.yml rename to spec/functions/getServerOptions/getServerOptionsResponse.yml diff --git a/openapi/functions/healthCheck/healthCheck.yml b/spec/functions/healthCheck/healthCheck.yml similarity index 100% rename from openapi/functions/healthCheck/healthCheck.yml rename to spec/functions/healthCheck/healthCheck.yml diff --git a/openapi/functions/healthCheck/healthCheckRequest.yml b/spec/functions/healthCheck/healthCheckRequest.yml similarity index 100% rename from openapi/functions/healthCheck/healthCheckRequest.yml rename to spec/functions/healthCheck/healthCheckRequest.yml diff --git a/openapi/functions/healthCheck/healthCheckResponse.yml b/spec/functions/healthCheck/healthCheckResponse.yml similarity index 100% rename from openapi/functions/healthCheck/healthCheckResponse.yml rename to spec/functions/healthCheck/healthCheckResponse.yml diff --git a/openapi/functions/loadGame/loadGame.yml b/spec/functions/loadGame/loadGame.yml similarity index 100% rename from openapi/functions/loadGame/loadGame.yml rename to spec/functions/loadGame/loadGame.yml diff --git a/openapi/functions/loadGame/loadGameRequest.yml b/spec/functions/loadGame/loadGameRequest.yml similarity index 100% rename from openapi/functions/loadGame/loadGameRequest.yml rename to spec/functions/loadGame/loadGameRequest.yml diff --git a/openapi/functions/passwordLogin/passwordLogin.yml b/spec/functions/passwordLogin/passwordLogin.yml similarity index 100% rename from openapi/functions/passwordLogin/passwordLogin.yml rename to spec/functions/passwordLogin/passwordLogin.yml diff --git a/openapi/functions/passwordLogin/passwordLoginRequest.yml b/spec/functions/passwordLogin/passwordLoginRequest.yml similarity index 100% rename from openapi/functions/passwordLogin/passwordLoginRequest.yml rename to spec/functions/passwordLogin/passwordLoginRequest.yml diff --git a/openapi/functions/passwordLogin/passwordLoginResponse.yml b/spec/functions/passwordLogin/passwordLoginResponse.yml similarity index 100% rename from openapi/functions/passwordLogin/passwordLoginResponse.yml rename to spec/functions/passwordLogin/passwordLoginResponse.yml diff --git a/openapi/functions/passwordlessLogin/passwordlessLogin.yml b/spec/functions/passwordlessLogin/passwordlessLogin.yml similarity index 100% rename from openapi/functions/passwordlessLogin/passwordlessLogin.yml rename to spec/functions/passwordlessLogin/passwordlessLogin.yml diff --git a/openapi/functions/passwordlessLogin/passwordlessLoginRequest.yml b/spec/functions/passwordlessLogin/passwordlessLoginRequest.yml similarity index 100% rename from openapi/functions/passwordlessLogin/passwordlessLoginRequest.yml rename to spec/functions/passwordlessLogin/passwordlessLoginRequest.yml diff --git a/openapi/functions/passwordlessLogin/passwordlessLoginResponse.yml b/spec/functions/passwordlessLogin/passwordlessLoginResponse.yml similarity index 100% rename from openapi/functions/passwordlessLogin/passwordlessLoginResponse.yml rename to spec/functions/passwordlessLogin/passwordlessLoginResponse.yml diff --git a/openapi/functions/queryServerState/queryServerState.yml b/spec/functions/queryServerState/queryServerState.yml similarity index 100% rename from openapi/functions/queryServerState/queryServerState.yml rename to spec/functions/queryServerState/queryServerState.yml diff --git a/openapi/functions/queryServerState/queryServerStateRequest.yml b/spec/functions/queryServerState/queryServerStateRequest.yml similarity index 100% rename from openapi/functions/queryServerState/queryServerStateRequest.yml rename to spec/functions/queryServerState/queryServerStateRequest.yml diff --git a/openapi/functions/queryServerState/queryServerStateResponse.yml b/spec/functions/queryServerState/queryServerStateResponse.yml similarity index 100% rename from openapi/functions/queryServerState/queryServerStateResponse.yml rename to spec/functions/queryServerState/queryServerStateResponse.yml diff --git a/openapi/functions/renameServer/renameServer.yml b/spec/functions/renameServer/renameServer.yml similarity index 100% rename from openapi/functions/renameServer/renameServer.yml rename to spec/functions/renameServer/renameServer.yml diff --git a/openapi/functions/renameServer/renameServerRequest.yml b/spec/functions/renameServer/renameServerRequest.yml similarity index 100% rename from openapi/functions/renameServer/renameServerRequest.yml rename to spec/functions/renameServer/renameServerRequest.yml diff --git a/openapi/functions/runCommand/runCommand.yml b/spec/functions/runCommand/runCommand.yml similarity index 100% rename from openapi/functions/runCommand/runCommand.yml rename to spec/functions/runCommand/runCommand.yml diff --git a/openapi/functions/runCommand/runCommandRequest.yml b/spec/functions/runCommand/runCommandRequest.yml similarity index 100% rename from openapi/functions/runCommand/runCommandRequest.yml rename to spec/functions/runCommand/runCommandRequest.yml diff --git a/openapi/functions/runCommand/runCommandResponse.yml b/spec/functions/runCommand/runCommandResponse.yml similarity index 100% rename from openapi/functions/runCommand/runCommandResponse.yml rename to spec/functions/runCommand/runCommandResponse.yml diff --git a/openapi/functions/saveGame/saveGame.yml b/spec/functions/saveGame/saveGame.yml similarity index 100% rename from openapi/functions/saveGame/saveGame.yml rename to spec/functions/saveGame/saveGame.yml diff --git a/openapi/functions/saveGame/saveGameRequest.yml b/spec/functions/saveGame/saveGameRequest.yml similarity index 100% rename from openapi/functions/saveGame/saveGameRequest.yml rename to spec/functions/saveGame/saveGameRequest.yml diff --git a/openapi/functions/setAdminPassword/setAdminPassword.yml b/spec/functions/setAdminPassword/setAdminPassword.yml similarity index 100% rename from openapi/functions/setAdminPassword/setAdminPassword.yml rename to spec/functions/setAdminPassword/setAdminPassword.yml diff --git a/openapi/functions/setAdminPassword/setAdminPasswordRequest.yml b/spec/functions/setAdminPassword/setAdminPasswordRequest.yml similarity index 100% rename from openapi/functions/setAdminPassword/setAdminPasswordRequest.yml rename to spec/functions/setAdminPassword/setAdminPasswordRequest.yml diff --git a/openapi/functions/setAdminPassword/setAdminPasswordResponse.yml b/spec/functions/setAdminPassword/setAdminPasswordResponse.yml similarity index 100% rename from openapi/functions/setAdminPassword/setAdminPasswordResponse.yml rename to spec/functions/setAdminPassword/setAdminPasswordResponse.yml diff --git a/openapi/functions/setAutoLoadSessionName/setAutoLoadSessionName.yml b/spec/functions/setAutoLoadSessionName/setAutoLoadSessionName.yml similarity index 100% rename from openapi/functions/setAutoLoadSessionName/setAutoLoadSessionName.yml rename to spec/functions/setAutoLoadSessionName/setAutoLoadSessionName.yml diff --git a/openapi/functions/setAutoLoadSessionName/setAutoLoadSessionNameRequest.yml b/spec/functions/setAutoLoadSessionName/setAutoLoadSessionNameRequest.yml similarity index 100% rename from openapi/functions/setAutoLoadSessionName/setAutoLoadSessionNameRequest.yml rename to spec/functions/setAutoLoadSessionName/setAutoLoadSessionNameRequest.yml diff --git a/openapi/functions/setClientPassword/setClientPassword.yml b/spec/functions/setClientPassword/setClientPassword.yml similarity index 100% rename from openapi/functions/setClientPassword/setClientPassword.yml rename to spec/functions/setClientPassword/setClientPassword.yml diff --git a/openapi/functions/setClientPassword/setClientPasswordRequest.yml b/spec/functions/setClientPassword/setClientPasswordRequest.yml similarity index 100% rename from openapi/functions/setClientPassword/setClientPasswordRequest.yml rename to spec/functions/setClientPassword/setClientPasswordRequest.yml diff --git a/openapi/functions/shutdown/shutdown.yml b/spec/functions/shutdown/shutdown.yml similarity index 100% rename from openapi/functions/shutdown/shutdown.yml rename to spec/functions/shutdown/shutdown.yml diff --git a/openapi/functions/shutdown/shutdownRequest.yml b/spec/functions/shutdown/shutdownRequest.yml similarity index 100% rename from openapi/functions/shutdown/shutdownRequest.yml rename to spec/functions/shutdown/shutdownRequest.yml diff --git a/openapi/functions/uploadSaveGame/uploadSaveGame.yml b/spec/functions/uploadSaveGame/uploadSaveGame.yml similarity index 100% rename from openapi/functions/uploadSaveGame/uploadSaveGame.yml rename to spec/functions/uploadSaveGame/uploadSaveGame.yml diff --git a/openapi/functions/uploadSaveGame/uploadSaveGameRequest.yml b/spec/functions/uploadSaveGame/uploadSaveGameRequest.yml similarity index 100% rename from openapi/functions/uploadSaveGame/uploadSaveGameRequest.yml rename to spec/functions/uploadSaveGame/uploadSaveGameRequest.yml diff --git a/openapi/functions/verifyAuthenticationToken/verifyAuthenticationToken.yml b/spec/functions/verifyAuthenticationToken/verifyAuthenticationToken.yml similarity index 100% rename from openapi/functions/verifyAuthenticationToken/verifyAuthenticationToken.yml rename to spec/functions/verifyAuthenticationToken/verifyAuthenticationToken.yml diff --git a/openapi/functions/verifyAuthenticationToken/verifyAuthenticationTokenRequest.yml b/spec/functions/verifyAuthenticationToken/verifyAuthenticationTokenRequest.yml similarity index 100% rename from openapi/functions/verifyAuthenticationToken/verifyAuthenticationTokenRequest.yml rename to spec/functions/verifyAuthenticationToken/verifyAuthenticationTokenRequest.yml diff --git a/openapi/openapi.yml b/spec/reference.yml similarity index 100% rename from openapi/openapi.yml rename to spec/reference.yml