Skip to content

Commit

Permalink
Adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
Twinki14 committed Oct 13, 2024
1 parent 3dd47dc commit 3665a44
Show file tree
Hide file tree
Showing 18 changed files with 69 additions and 68 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Applies new values to the provided Advanced Game Settings properties. Will automatically enable Advanced Game Settings for the currently loaded save if they are not enabled already.
tags:
- Game Settings
- Game
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Applies new Server Options to the Dedicated Server. Requires Admin privileges.
tags:
- Server Options
- Server
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/deleteSaveFile/deleteSaveFile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Deletes the existing save game file from the server. Requires Admin privileges. SaveName might be changed to satisfy file system restrictions on file names. Function does not return any data on success.
tags:
- Save Management
- Saves
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/deleteSaveSession/deleteSaveSession.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Deletes all save files belonging to the specific session name. Requires Admin privileges. SessionName must be a valid session name with at least one saved save game file belonging to it. Function does not return any data on success.
tags:
- Save Management
- Sessions
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/downloadSaveGame/downloadSaveGame.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Downloads save game with the given name from the Dedicated Server. Requires Admin privileges. This function responds with the file attachment containing the save game file on success, and with normal error response in case of error.
tags:
- Save Management
- Saves
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/enumerateSessions/enumerateSessions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Enumerates all save game files available on the Dedicated Server. Requires Admin privileges. Function does not require any additional parameters.
tags:
- Save Management
- Sessions
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Retrieves currently applied advanced game settings. Does not require input parameters.
tags:
- Game Settings
- Game
security:
- bearerAuth: []
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/getServerOptions/getServerOptions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Retrieves currently applied server options and server options that are still pending application (because of needing session or server restart) Does not require input parameters.
tags:
- Server Options
- Server
security:
- bearerAuth: []
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/healthCheck/healthCheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ post:
operationId: HealthCheck
description: Performs a health check on the Dedicated Server API. Allows passing additional data between Modded Dedicated Server and Modded Game Client. This function requires no Authentication.
tags:
- Server Status
- Server
security:
- {}
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/loadGame/loadGame.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Loads the save game file by name, optionally with Advanced Game Settings enabled. Requires Admin privileges. Dedicated Server HTTPS API will become temporarily unavailable when save game is being loaded. Function does not return any data on succcess.
tags:
- Save Management
- Saves
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/queryServerState/queryServerState.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Retrieves the current state of the Dedicated Server. Does not require any input parameters.
tags:
- Server Status
- Server
security:
- bearerAuth: []
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/renameServer/renameServer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Renames the Dedicated Server once it has been claimed. Requires Admin privileges. Function does not return any data on success.
tags:
- Server Options
- Server
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/runCommand/runCommand.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Runs the given Console Command on the Dedicated Server, and returns it's output to the Console. Requires Admin privileges.
tags:
- Server Actions
- Server
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/saveGame/saveGame.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Saves the currently loaded session into the new save game file named as the argument. Requires Admin privileges. SaveName might be changed to satisfy file system restrictions on file names. Function does not return any data on success.
tags:
- Save Management
- Saves
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ post:
description: |
Updates the name of the session that the Dedicated Server will automatically load on startup. Does not change currently loaded session. Requires Admin privileges. Function does not return any data on success.
tags:
- Save Management
- Server
- Sessions
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/shutdown/shutdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Shuts down the Dedicated Server. If automatic restart script is setup, this allows restarting the server to apply new settings or update. Requires Admin privileges. Shutdowns initiated by remote hosts are logged with their IP and their token. Function does not return any data on success, and does not take any parameters.
tags:
- Server Actions
- Server
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion openapi/functions/uploadSaveGame/uploadSaveGame.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ post:
description: |
Shuts down the Dedicated Server. If automatic restart script is setup, this allows restarting the server to apply new settings or update. Requires Admin privileges. Shutdowns initiated by remote hosts are logged with their IP and their token. Function does not return any data on success, and does not take any parameters.
tags:
- Save Management
- Saves
security:
- bearerAuth: ['Administrator']
requestBody:
Expand Down
102 changes: 51 additions & 51 deletions openapi/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,14 @@ tags:
description: Authorization
- name: Authorization
description: Authorization
- name: Server Status
- name: Server
description: Server Status
- name: Server Actions
description: Save Management
- name: Server Options
description: Server Options
- name: Game Settings
- name: Game
description: Game Settings
- name: Save Management
description: Save Management
- name: Saves
description: Saves
- name: Sessions
description: Sessions
paths:

# --- Setup
Expand Down Expand Up @@ -66,27 +64,38 @@ paths:
'/api/v1/?function=VerifyAuthenticationToken':
$ref: functions/verifyAuthenticationToken/verifyAuthenticationToken.yml

# --- Server Status
# --- Sessions
# - Placed here to keep a specific ordering in our generated documentation

# EnumerateSessions
'/api/v1/?function=EnumerateSessions':
$ref: functions/enumerateSessions/enumerateSessions.yml

# --- Server

# HealthCheck
'/api/v1/?function=HealthCheck':
$ref: functions/healthCheck/healthCheck.yml

# QueryServerState
'/api/v1/?function=QueryServerState':
$ref: functions/queryServerState/queryServerState.yml
# GetServerOptions
'/api/v1/?function=GetServerOptions':
$ref: functions/getServerOptions/getServerOptions.yml

# --- Game Settings
# ApplyServerOptions
'/api/v1/?function=ApplyServerOptions':
$ref: functions/applyServerOptions/applyServerOptions.yml

# GetAdvancedGameSettings
'/api/v1/?function=GetAdvancedGameSettings':
$ref: functions/getAdvancedGameSettings/getAdvancedGameSettings.yml
# SetAutoLoadSessionName
'/api/v1/?function=SetAutoLoadSessionName':
$ref: functions/setAutoLoadSessionName/setAutoLoadSessionName.yml

# ApplyAdvancedGameSettings
'/api/v1/?function=ApplyAdvancedGameSettings':
$ref: functions/applyAdvancedGameSettings/applyAdvancedGameSettings.yml
# QueryServerState
'/api/v1/?function=QueryServerState':
$ref: functions/queryServerState/queryServerState.yml

# --- Server Actions
# RenameServer
'/api/v1/?function=RenameServer':
$ref: functions/renameServer/renameServer.yml

# RunCommand
'/api/v1/?function=RunCommand':
Expand All @@ -96,50 +105,41 @@ paths:
'/api/v1/?function=Shutdown':
$ref: functions/shutdown/shutdown.yml

# --- Server Options
# --- Sessions
# - Placed here to keep a specific ordering in our generated documentation

# GetServerOptions
'/api/v1/?function=GetServerOptions':
$ref: functions/getServerOptions/getServerOptions.yml
# DeleteSaveSession
'/api/v1/?function=DeleteSaveSession':
$ref: functions/deleteSaveSession/deleteSaveSession.yml

# ApplyServerOptions
'/api/v1/?function=ApplyServerOptions':
$ref: functions/applyServerOptions/applyServerOptions.yml
# --- Game

# RenameServer
'/api/v1/?function=RenameServer':
$ref: functions/renameServer/renameServer.yml
# GetAdvancedGameSettings
'/api/v1/?function=GetAdvancedGameSettings':
$ref: functions/getAdvancedGameSettings/getAdvancedGameSettings.yml

# --- Save Management
# ApplyAdvancedGameSettings
'/api/v1/?function=ApplyAdvancedGameSettings':
$ref: functions/applyAdvancedGameSettings/applyAdvancedGameSettings.yml

# SetAutoLoadSessionName
'/api/v1/?function=SetAutoLoadSessionName':
$ref: functions/setAutoLoadSessionName/setAutoLoadSessionName.yml
# --- Saves

# SaveGame
'/api/v1/?function=SaveGame':
$ref: functions/saveGame/saveGame.yml

# DeleteSaveFile
'/api/v1/?function=DeleteSaveFile':
$ref: functions/deleteSaveFile/deleteSaveFile.yml

# DeleteSaveSession
'/api/v1/?function=DeleteSaveSession':
$ref: functions/deleteSaveSession/deleteSaveSession.yml
# DownloadSaveGame
'/api/v1/?function=DownloadSaveGame':
$ref: functions/downloadSaveGame/downloadSaveGame.yml

# EnumerateSessions
'/api/v1/?function=EnumerateSessions':
$ref: functions/enumerateSessions/enumerateSessions.yml
# UploadSaveGame
'/api/v1/?function=UploadSaveGame':
$ref: functions/uploadSaveGame/uploadSaveGame.yml

# LoadGame
'/api/v1/?function=LoadGame':
$ref: functions/loadGame/loadGame.yml

# UploadSaveGame
'/api/v1/?function=UploadSaveGame':
$ref: functions/uploadSaveGame/uploadSaveGame.yml

# DownloadSaveGame
'/api/v1/?function=DownloadSaveGame':
$ref: functions/downloadSaveGame/downloadSaveGame.yml
# DeleteSaveFile
'/api/v1/?function=DeleteSaveFile':
$ref: functions/deleteSaveFile/deleteSaveFile.yml

0 comments on commit 3665a44

Please sign in to comment.