chore: update API specs (#62)

Author: leafty

pkg/renkuapi/session/api.spec.yaml

@@ -426,7 +426,7 @@ components:
             environment_kind:
               allOf:
                 - $ref: "#/components/schemas/EnvironmentKind"
-              default: custom
+              default: CUSTOM
           required:
             - environment_image_source
             - environment_kind
@@ -444,7 +444,7 @@ components:
             environment_kind:
               allOf:
                 - $ref: "#/components/schemas/EnvironmentKind"
-              default: custom
+              default: CUSTOM
           required:
             - build_parameters
             - environment_image_source
@@ -545,13 +545,13 @@ components:
         port:
           $ref: "#/components/schemas/EnvironmentPort"
         command:
-          $ref: "#/components/schemas/EnvironmentCommand"
+          $ref: "#/components/schemas/EnvironmentPatchCommand"
         args:
-          $ref: "#/components/schemas/EnvironmentArgs"
+          $ref: "#/components/schemas/EnvironmentPatchArgs"
         is_archived:
-          $ref: "#/components/schemas/IsArchived"
+          $ref: "#/components/schemas/IsArchivedPatch"
         strip_path_prefix:
-          $ref: "#/components/schemas/StripPathPrefix"
+          $ref: "#/components/schemas/StripPathPrefixPatch"
     SessionLaunchersList:
       description: A list of Renku session launchers
       type: array
@@ -648,6 +648,15 @@ components:
       minLength: 1
       maxLength: 99
       example: My Renku Session :)
+    BuildPlatforms:
+      description: The target runtime platforms of a session environment.
+      type: array
+      items:
+        $ref: "#/components/schemas/BuildPlatform"
+    BuildPlatform:
+      description: A runtime platform, e.g. "linux/amd64".
+      type: string
+      enum: ["linux/amd64", "linux/arm64"]
     BuilderVariant:
       description: Type of virtual environment manager when building custom environments.
       type: string
@@ -728,6 +737,8 @@ components:
       properties:
         repository:
           $ref: "#/components/schemas/Repository"
+        platforms:
+          $ref: "#/components/schemas/BuildPlatforms"
         builder_variant:
           $ref: "#/components/schemas/BuilderVariant"
         frontend_variant:
@@ -755,6 +766,8 @@ components:
       properties:
         repository:
           $ref: "#/components/schemas/Repository"
+        platforms:
+          $ref: "#/components/schemas/BuildPlatforms"
         builder_variant:
           $ref: "#/components/schemas/BuilderVariant"
         frontend_variant:
@@ -837,16 +850,33 @@ components:
         type: string
       description: The command that will be run i.e. will overwrite the image Dockerfile ENTRYPOINT, equivalent to command in Kubernetes
       minItems: 1
+    EnvironmentPatchCommand:
+      type: array
+      description: The command that will be run i.e. will overwrite the image Dockerfile ENTRYPOINT, equivalent to command in Kubernetes
+      items:
+        type: string
+      nullable: true
+      minItems: 1
     EnvironmentArgs:
       type: array
       items:
         type: string
       description: The arguments that will follow the command, i.e. will overwrite the image Dockerfile CMD, equivalent to args in Kubernetes
       minItems: 1
+    EnvironmentPatchArgs:
+      type: array
+      description: The arguments that will follow the command, i.e. will overwrite the image Dockerfile CMD, equivalent to args in Kubernetes
+      items:
+        type: string
+      nullable: true
+      minItems: 1
     IsArchived:
       type: boolean
       description: Whether this environment is archived and not for use in new projects or not
       default: false
+    IsArchivedPatch:
+      type: boolean
+      description: Whether this environment is archived and not for use in new projects or not
     Build:
       description: A container image build
       type: object
@@ -921,6 +951,21 @@ components:
         the server from the session that generated the HTML page needs to know
         what is the full base path (including the part that was stripped) so that
         it can make the URLs to such assets be reachable from the browser.
+    StripPathPrefixPatch:
+      type: boolean
+      description: |-
+        If set to true the default url and the base path where sessions are
+        served will be removed from all URL paths before the requests reach
+        the server running in the session. So the server in the session will
+        receive HTTP requests whose base path will be "/". However this will
+        not work unless the server running inside the session can be made
+        aware that paths are rewritten. For example, if the application/server
+        running in the session serves a HTML page that then loads javascript
+        and CSS, the path where these assets should be loaded from in the browser
+        will not be "/" but it has to include the prefix that was stripped. And
+        the server from the session that generated the HTML page needs to know
+        what is the full base path (including the part that was stripped) so that
+        it can make the URLs to such assets be reachable from the browser.
     BuildPatch:
       description: The requested update of a container image build
       type: object