api: updated Display class to contain a video type reference

Added VideoType as an extra parameter in the display, opens opportunity to alter/view the video type used by an object.
Added documentation to VmGraphicsConsolesService.

Signed-off-by: Jasper Berton <[email protected]>

Author: JasperB-TeamBlue

src/main/java/services/InstanceTypeGraphicsConsoleService.java

@@ -35,9 +35,14 @@ public interface InstanceTypeGraphicsConsoleService {
     /**
      * Gets graphics console configuration of the instance type.
      *
+     * ```http
+     * GET /ovirt-engine/api/instancetypes/123/graphicsconsoles HTTP/1.1
+     * ```
+     *
      * @author Ondra Machacek <[email protected]>
-     * @date 31 Oct 2016
-     * @status added
+     * @author Jasper Berton <[email protected]>
+     * @date 18 March 2025
+     * @status updated_by_docs
      */
     interface Get extends Follow {
         /**

src/main/java/services/VmGraphicsConsolesService.java

@@ -38,9 +38,27 @@ public interface VmGraphicsConsolesService {
     /**
      * Add new graphics console to the virtual machine.
      *
+     * For example, to add a new graphics console to the virtual machine `123` send a request as follows:
+     *
+     * ```http
+     * POST /ovirt-engine/api/vms/123/graphicsconsoles HTTP/1.1
+     * ```
+     *
+     * With a request body as follows:
+     *
+     * ```xml
+     * <graphics_console> <protocol>type</protocol> </graphics_console>
+     * ```
+     *
+     * Where `type` can be spice or vnc.
+     *
+     * IMPORTANT: Currently there is no check if the protocol is supported by the operating system the engine is running on.
+     * 
+     *
      * @author Ondra Machacek <[email protected]>
-     * @date 31 Oct 2016
-     * @status added
+     * @author Jasper Berton <[email protected]>
+     * @date 18 Apr 2025
+     * @status updated_by_docs
      */
     interface Add {
         @InputDetail

src/main/java/services/VmService.java

@@ -822,6 +822,7 @@ default void inputDetail() {
             optional(vm().display().singleQxlPci());
             optional(vm().display().smartcardEnabled());
             optional(vm().display().type());
+            optional(vm().display().videoType());
             optional(vm().domain().name());
             optional(vm().externalHostProvider().id());
             optional(vm().highAvailability().enabled());
@@ -1263,6 +1264,7 @@ default void inputDetail() {
             optional(vm().customCpuModel());
             optional(vm().customEmulatedMachine());
             optional(vm().display().type());
+            optional(vm().display().videoType());
             optional(vm().domain().name());
             optional(vm().domain().user().password());
             optional(vm().domain().user().userName());

src/main/java/services/VmsService.java

@@ -368,6 +368,7 @@ default void inputDetail() {
             optional(vm().display().monitors());
             optional(vm().display().smartcardEnabled());
             optional(vm().display().type());
+            optional(vm().display().videoType());
             optional(vm().domain().name());
             optional(vm().highAvailability().enabled());
             optional(vm().highAvailability().priority());

src/main/java/types/Display.java

@@ -24,23 +24,35 @@
 import org.ovirt.api.metamodel.annotations.Type;
 
 /**
- * Represents a graphic console configuration.
+ * Represents the configuration of the used display.
  *
  * @author Sharon Gratch <[email protected]>
- * @date 24 Apr 2017
- * @status added
+ * @author Jasper Berton <[email protected]>
+ * @date 17 April 2025
+ * @status updated
  */
 @Type
 public interface Display {
     /**
-     * The graphic console protocol type.
+     * Returns SPICE or VNC based on the current Display type.
      *
      * @author Sharon Gratch <[email protected]>
-     * @date 24 Apr 2017
-     * @status added
+     * @author Jasper Berton <[email protected]>
+     * @date 17 April 2025
+     * @status updated
      */
+    @Deprecated
     DisplayType type();
 
+    /** 
+     * Returns the video type used for the display.
+     * 
+     * @author Jasper Berton <[email protected]>
+     * @date 17 April 2025
+     * @status added
+     */
+    VideoType videoType();
+
     /**
      * The IP address of the guest to connect the graphic console client to.
      *

src/main/java/types/VideoType.java

@@ -0,0 +1,74 @@
+/*
+The oVirt Project - oVirt Engine Api Model
+
+Copyright oVirt Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+A copy of the Apache License, Version 2.O is included with the program
+in the files ASL2.
+*/
+
+package types;
+
+import org.ovirt.api.metamodel.annotations.Type;
+
+/**
+ * Represents the video type that is currently configured.
+ * 
+ * @author Jasper Berton <[email protected]>
+ * @date 17 April 2025
+ * @status added
+*/
+@Type
+public enum VideoType {
+
+    /**
+     * Display of the type BOCHS
+     * 
+     * @author Jasper Berton <[email protected]>
+     * @date 17 April 2025
+     * @status added
+     */
+    BOCHS,
+
+    /**
+     * Display of the type CIRRUS
+     * 
+     * @author Jasper Berton <[email protected]>
+     * @date 17 April 2025
+     * @status added
+    */
+    @Deprecated
+    CIRRUS,
+
+    /**
+     * Display of the type VGA
+     * 
+     * @author Jasper Berton <[email protected]>
+     * @date 17 April 2025
+     * @status added
+    */
+    VGA,
+
+    /**
+     * Display of the type QXL
+     * 
+     * @author Jasper Berton <[email protected]>
+     * @date 17 April 2025
+     * @status added
+     */
+    @Deprecated
+    QXL;
+    
+}