Sunshine/api/paths/confighttp/apps/apps.yml

---
get:
  summary: Get the list of available applications.
  description: |
    Get the list of available applications.
  operationId: getApps
  tags:
    - Apps
  responses:
    '200':
      description: A list of available applications.
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "../../../components/schemas/app.yml"
          example:
            - name: "Example App"
              output: "/path/to/output.log"
              cmd: "example-command"
              exclude-global-prep-cmd: false
              elevated: false
              auto-detach: true
              wait-all: false
              exit-timeout: 30
              image-path: "/path/to/image.png"
              working-dir: "/path/to/working-dir"
              prep-cmd:
                - do: "prep-command-1"
                  undo: "undo-command-1"
                  elevated: false
              detached:
                - "detached-command-1"
    '401':
      $ref: "../../../components/responses/401.yml"
    '403':
      $ref: "../../../components/responses/403.yml"

post:
  summary: Save an application.
  description: |
    Save an application.
    To save a new application the index must be `-1`.
    To update an existing application, you must provide the current index of the application.
  operationId: postApps
  tags:
    - Apps
  parameters:
    - name: index
      in: query
      description: The index of the application to update. If the index is -1, a new application will be created.
      required: true
      schema:
        type: integer
        format: int32
    - name: name
      in: query
      description: Application Name
      required: false
      schema:
        type: string
    - name: output
      in: query
      description: Log Output Path
      required: false
      schema:
        type: string
    - name: cmd
      in: query
      description: Command to run the application
      required: false
      schema:
        $ref: "../../../components/schemas/cmd.yml"
    - name: exclude-global-prep-cmd
      in: query
      description: Enable/Disable the execution of Global Prep Commands for this application.
      required: false
      schema:
        type: boolean
    - name: elevated
      in: query
      description: Run the application as an elevated process.
      required: false
      schema:
        type: boolean
    - name: auto-detach
      in: query
      description: Continue streaming if the application exits quickly
      required: false
      schema:
        type: boolean
    - name: wait-all
      in: query
      description: Continue streaming until all app processes exit
      required: false
      schema:
        type: boolean
    - name: exit-timeout
      in: query
      description: Number of seconds to wait for all app processes to gracefully exit when requested to quit.
      required: false
      schema:
        type: integer
        format: int32
    - name: prep-cmd
      in: query
      description: Commands to run before the main application
      required: false
      schema:
        type: array
        items:
          $ref: "../../../components/schemas/prep-cmd.yml"
    - name: detached
      in: query
      description: Commands to run in detached processes
      required: false
      schema:
        type: array
        items:
        $ref: "../../../components/schemas/cmd.yml"
    - name: image-path
      in: query
      description: Full path to the application image. Must be a png file.
      required: false
      schema:
        type: string
    - name: working-dir
      in: query
      description: The working directory that should be passed to the process.
      required: false
      schema:
        type: string
  responses:
    '200':
      description: The application was saved successfully.
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
          example:
            status: true
    '400':
      $ref: "../../../components/responses/400.yml"
    '401':
      $ref: "../../../components/responses/401.yml"
    '403':
      $ref: "../../../components/responses/403.yml"