Skip to content

Commit

Permalink
Give all request functions an example
Browse files Browse the repository at this point in the history
  • Loading branch information
Twinki14 committed Sep 29, 2024
1 parent 48edc42 commit 33f8ddf
Show file tree
Hide file tree
Showing 24 changed files with 24 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: ApplyAdvancedGameSettings
default: ApplyAdvancedGameSettings
example: ApplyAdvancedGameSettings
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: ApplyServerOptions
default: ApplyServerOptions
example: ApplyServerOptions
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
1 change: 1 addition & 0 deletions openapi/functions/claimServer/claimServerRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: ClaimServer
default: ClaimServer
example: ClaimServer
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
1 change: 1 addition & 0 deletions openapi/functions/createNewGame/createNewGameRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: CreateNewGame
default: CreateNewGame
example: CreateNewGame
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
1 change: 1 addition & 0 deletions openapi/functions/deleteSaveFile/deleteSaveFileRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: DeleteSaveFile
default: DeleteSaveFile
example: DeleteSaveFile
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: DeleteSaveSession
default: DeleteSaveSession
example: DeleteSaveSession
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: DownloadSaveGame
default: DownloadSaveGame
example: DownloadSaveGame
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ properties:
description: Name of the API function to execute.
const: EnumerateSessions
default: EnumerateSessions
example: EnumerateSessions
required:
- function
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ properties:
description: Name of the API function to execute.
const: GetAdvancedGameSettings
default: GetAdvancedGameSettings
example: GetAdvancedGameSettings
required:
- function
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ properties:
description: Name of the API function to execute.
const: GetServerOptions
default: GetServerOptions
example: GetServerOptions
required:
- function
1 change: 1 addition & 0 deletions openapi/functions/healthCheck/healthCheckRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: HealthCheck
default: HealthCheck
example: HealthCheck
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
1 change: 1 addition & 0 deletions openapi/functions/loadGame/loadGameRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: LoadGame
default: LoadGame
example: LoadGame
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
1 change: 1 addition & 0 deletions openapi/functions/passwordLogin/passwordLoginRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: PasswordLogin
default: PasswordLogin
example: PasswordLogin
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: PasswordlessLogin
default: PasswordlessLogin
example: PasswordlessLogin
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ properties:
description: Name of the API function to execute.
const: QueryServerState
default: QueryServerState
example: QueryServerState
required:
- function
1 change: 1 addition & 0 deletions openapi/functions/renameServer/renameServerRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: RenameServer
default: RenameServer
example: RenameServer
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
1 change: 1 addition & 0 deletions openapi/functions/runCommand/runCommandRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: RunCommand
default: RunCommand
example: RunCommand
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
1 change: 1 addition & 0 deletions openapi/functions/saveGame/saveGameRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: SaveGame
default: SaveGame
example: SaveGame
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: SetAdminPassword
default: SetAdminPassword
example: SetAdminPassword
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: SetAutoLoadSessionName
default: SetAutoLoadSessionName
example: SetAutoLoadSessionName
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ properties:
description: Name of the API function to execute.
const: SetClientPassword
default: SetClientPassword
example: SetClientPassword
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
1 change: 1 addition & 0 deletions openapi/functions/shutdown/shutdownRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ properties:
description: Name of the API function to execute.
const: Shutdown
default: Shutdown
example: Shutdown
required:
- function
1 change: 1 addition & 0 deletions openapi/functions/uploadSaveGame/uploadSaveGameRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ properties:
description: Name of the API function to execute.
const: UploadSaveGame
default: UploadSaveGame
example: UploadSaveGame
data:
type: object
description: Data to pass to the function to execute. Format of the object depends on the function being executed
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ properties:
description: Name of the API function to execute.
const: VerifyAuthenticationToken
default: VerifyAuthenticationToken
example: VerifyAuthenticationToken
required:
- function

0 comments on commit 33f8ddf

Please sign in to comment.