VirtualBox

Changeset 106218 in vbox


Ignore:
Timestamp:
Oct 4, 2024 7:06:55 AM (4 months ago)
Author:
vboxsync
Message:

REST API small improvements. Replaced plural to singular. Actions to action, methods to method.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Main/idl/VirtualBox.xidl

    r106217 r106218  
    20732073    </method>
    20742074    <method name="start">
    2075       <rest request="post" path="/natnetworks/{networkid}/actions/"/>
     2075      <rest request="post" path="/natnetworks/{networkid}/action/"/>
    20762076    </method>
    20772077    <method name="stop">
    2078       <rest request="post" path="/natnetworks/{networkid}/actions/"/>
     2078      <rest request="post" path="/natnetworks/{networkid}/action/"/>
    20792079    </method>
    20802080  </interface>
    … …  
    24012401
    24022402    <method name="start">
    2403       <rest request="post" path="/dhcpservers/{serverid}/actions/"/>
     2403      <rest request="post" path="/dhcpservers/{serverid}/action/"/>
    24042404      <desc>
    24052405        Starts DHCP server process.
    … …  
    24212421
    24222422    <method name="stop">
    2423       <rest request="post" path="/dhcpservers/{serverid}/actions/"/>
     2423      <rest request="post" path="/dhcpservers/{serverid}/action/"/>
    24242424      <desc>
    24252425        Stops DHCP server process.
    … …  
    24312431
    24322432    <method name="restart">
    2433       <rest request="post" path="/dhcpservers/{serverid}/actions/"/>
     2433      <rest request="post" path="/dhcpservers/{serverid}/action/"/>
    24342434      <desc>
    24352435        Restart running DHCP server process.
    … …  
    29862986
    29872987    <method name="composeMachineFilename">
    2988       <rest request="get" path="/server/methods/"/>
     2988      <rest request="get" path="/server/method/"/>
    29892989      <desc>
    29902990        Returns a recommended full path of the settings file name for a new virtual
    … …  
    31863186
    31873187    <method name="openMachine">
    3188       <rest name="open" request="post" path="/vms/{vmid}/actions/"/>
     3188      <rest name="open" request="post" path="/vms/{vmid}/action/"/>
    31893189      <desc>
    31903190        Opens a virtual machine from the existing settings file.
    … …  
    32323232
    32333233    <method name="registerMachine">
    3234       <rest name="register" request="post" path="/vms/{vmid}/actions/"/>
     3234      <rest name="register" request="post" path="/vms/{vmid}/action/"/>
    32353235      <desc>
    32363236
    … …  
    32793279
    32803280    <method name="getMachinesByGroups">
    3281       <rest request="get" path="/server/methods/"/>
     3281      <rest request="get" path="/server/method/"/>
    32823282      <desc>
    32833283        Gets all machine references which are in one of the specified groups.
    … …  
    32943294
    32953295    <method name="getMachineStates">
    3296       <rest request="get" path="/server/methods/"/>
     3296      <rest request="get" path="/server/method/"/>
    32973297      <desc>
    32983298        Gets the state of several machines in a single operation.
    … …  
    33193319
    33203320    <method name="createUnattendedInstaller">
    3321       <rest request="post" path="/server/methods/"/>
     3321      <rest request="post" path="/server/method/"/>
    33223322      <desc>
    33233323        Creates a new <link to="IUnattended"/> guest installation object.  This can be used to
    … …  
    34103410
    34113411    <method name="openMedium">
    3412       <rest request="post" path="/server/methods/"/>
     3412      <rest request="post" path="/server/method/"/>
    34133413      <desc>
    34143414        Finds existing media or opens a medium from an existing storage location.
    … …  
    35073507
    35083508    <method name="getGuestOSType">
    3509       <rest request="get" path="/server/methods/"/>
     3509      <rest request="get" path="/server/method/"/>
    35103510      <desc>
    35113511        Returns an object describing the specified guest OS type.
    … …  
    35403540
    35413541    <method name="getGuestOSSubtypesByFamilyId">
    3542       <rest request="get" path="/server/methods/"/>
     3542      <rest request="get" path="/server/method/"/>
    35433543      <desc>
    35443544        Returns a list of guest OS family subtypes for a corresponding
    … …  
    35663566
    35673567    <method name="getGuestOSDescsBySubtype">
    3568       <rest request="get" path="/server/methods/"/>
     3568      <rest request="get" path="/server/method/"/>
    35693569      <desc>
    35703570        Returns a list of guest OS family descriptions for a corresponding
    … …  
    36413641
    36423642    <method name="getExtraDataKeys">
    3643       <rest request="get" path="/server/methods/"/>
     3643      <rest request="get" path="/server/method/"/>
    36443644      <desc>
    36453645        Returns an array representing the global extra data keys which currently
    … …  
    36523652
    36533653    <method name="getExtraData">
    3654       <rest request="get" path="/server/methods/"/>
     3654      <rest request="get" path="/server/method/"/>
    36553655      <desc>
    36563656        Returns associated global extra data.
    … …  
    36763676
    36773677    <method name="setExtraData">
    3678       <rest request="put" path="/server/methods/"/>
     3678      <rest request="put" path="/server/method/"/>
    36793679      <desc>
    36803680        Sets associated global extra data.
    … …  
    39143914
    39153915    <method name="checkFirmwarePresent">
    3916       <rest request="get" path="/server/methods/"/>
     3916      <rest request="get" path="/server/method/"/>
    39173917      <desc>
    39183918        Check if this VirtualBox installation has a firmware
    … …  
    44184418
    44194419    <method name="read">
    4420       <rest request="post" path="/appliances/{applianceid}/actions/"/>
     4420      <rest request="post" path="/appliances/{applianceid}/action/"/>
    44214421      <desc>
    44224422        Reads an OVF file into the appliance object.
    … …  
    44384438
    44394439    <method name="interpret">
    4440       <rest request="post" path="/appliances/{applianceid}/actions/"/>
     4440      <rest request="post" path="/appliances/{applianceid}/action/"/>
    44414441      <desc>
    44424442        Interprets the OVF data that was read when the appliance was constructed. After
    … …  
    44564456
    44574457    <method name="importMachines">
    4458       <rest request="post" path="/appliances/{applianceid}/actions/"/>
     4458      <rest request="post" path="/appliances/{applianceid}/action/"/>
    44594459      <desc>
    44604460        Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
    … …  
    44964496
    44974497    <method name="write">
    4498       <rest request="post" path="/appliances/{applianceid}/actions/"/>
     4498      <rest request="post" path="/appliances/{applianceid}/action/"/>
    44994499      <desc>
    45004500          Writes the contents of the appliance exports into a new OVF file.
    … …  
    82148214
    82158215    <method name="lockMachine">
    8216       <rest name="lock" request="post" path="/vms/{vmid}/actions/"/>
     8216      <rest name="lock" request="post" path="/vms/{vmid}/action/"/>
    82178217      <desc>
    82188218        Locks the machine for the given session to enable the caller
    … …  
    83148314
    83158315    <method name="launchVMProcess">
    8316       <rest name="launch" request="post" path="/vms/{vmid}/actions/"/>
     8316      <rest name="launch" request="post" path="/vms/{vmid}/action/"/>
    83178317      <desc>
    83188318        Spawns a new process that will execute the virtual machine and obtains a shared
    … …  
    89798979
    89808980    <method name="unmountMedium">
    8981       <rest name="unmount" request="post" path="/vms/{vmid}/media/actions/"/>
     8981      <rest name="unmount" request="post" path="/vms/{vmid}/media/action/"/>
    89828982      <desc>
    89838983        Unmounts any currently mounted medium (<link to="IMedium" />,
    … …  
    90329032
    90339033    <method name="mountMedium">
    9034       <rest name="mount" request="post" path="/vms/{vmid}/media/actions/"/>
     9034      <rest name="mount" request="post" path="/vms/{vmid}/media/action/"/>
    90359035      <desc>
    90369036        Mounts a medium (<link to="IMedium" />, identified
    … …  
    95749574
    95759575    <method name="unregister" wrap-hint-server="limitedcaller,passcaller">
    9576       <rest request="post" path="/vms/{vmid}/actions/"/>
     9576      <rest request="post" path="/vms/{vmid}/action/"/>
    95779577      <desc>
    95789578        Unregisters a machine previously registered with
    … …  
    97099709
    97109710    <method name="exportTo">
    9711       <rest name="export" request="post" path="/vms/{vmid}/actions/"/>
     9711      <rest name="export" request="post" path="/vms/{vmid}/action/"/>
    97129712      <desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
    97139713            steps required to export VirtualBox machines to OVF.
    … …  
    97509750
    97519751    <method name="createSharedFolder">
    9752       <rest request="post" path="/vms/{vmid}/methods/"/>
     9752      <rest request="post" path="/vms/{vmid}/method/"/>
    97539753      <desc>
    97549754        Creates a new permanent shared folder by associating the given logical
    … …  
    97879787
    97889788    <method name="removeSharedFolder">
    9789       <rest request="delete" path="/vms/{vmid}/methods/"/>
     9789      <rest request="delete" path="/vms/{vmid}/method/"/>
    97909790      <desc>
    97919791        Removes the permanent shared folder with the given name previously
    … …  
    1029310293
    1029410294    <method name="cloneTo">
    10295       <rest name="clone" request="post" path="/vms/{vmid}/actions/"/>
     10295      <rest name="clone" request="post" path="/vms/{vmid}/action/"/>
    1029610296      <desc>
    1029710297        Creates a clone of this machine, either as a full clone (which means
    … …  
    1032910329
    1033010330    <method name="moveTo">
    10331       <rest name="move" request="post" path="/vms/{vmid}/actions/"/>
     10331      <rest name="move" request="post" path="/vms/{vmid}/action/"/>
    1033210332      <desc>
    1033310333        Move machine on to new place/folder
    … …  
    1035610356
    1035710357    <method name="saveState">
    10358       <rest name="save" request="post" path="/vms/{vmid}/actions/"/>
     10358      <rest name="save" request="post" path="/vms/{vmid}/action/"/>
    1035910359      <desc>
    1036010360        Saves the current execution state of a running virtual machine
    … …  
    1043010430
    1043110431    <method name="discardSavedState">
    10432       <rest request="post" path="/vms/{vmid}/actions/"/>
     10432      <rest request="post" path="/vms/{vmid}/action/"/>
    1043310433      <desc>
    1043410434        Forcibly resets the machine to "Powered Off" state if it is
    … …  
    1045810458
    1045910459    <method name="takeSnapshot">
    10460       <rest request="put" path="/vms/{vmid}/actions/"/>
     10460      <rest request="put" path="/vms/{vmid}/action/"/>
    1046110461      <desc>
    1046210462        Saves the current execution state
    … …  
    1050610506
    1050710507    <method name="deleteSnapshot">
    10508       <rest request="delete" path="/vms/{vmid}/actions/"/>
     10508      <rest request="delete" path="/vms/{vmid}/action/"/>
    1050910509      <desc>
    1051010510        Starts deleting the specified snapshot asynchronously.
    … …  
    1057810578
    1057910579    <method name="deleteSnapshotAndAllChildren">
    10580       <rest request="post" path="/vms/{vmid}/actions/"/>
     10580      <rest request="post" path="/vms/{vmid}/action/"/>
    1058110581      <desc>
    1058210582        Starts deleting the specified snapshot and all its children
    … …  
    1061210612
    1061310613    <method name="deleteSnapshotRange">
    10614       <rest request="post" path="/vms/{vmid}/actions/"/>
     10614      <rest request="post" path="/vms/{vmid}/action/"/>
    1061510615      <desc>
    1061610616        Starts deleting the specified snapshot range. This is limited to
    … …  
    1065110651
    1065210652    <method name="restoreSnapshot">
    10653       <rest request="post" path="/vms/{vmid}/actions/"/>
     10653      <rest request="post" path="/vms/{vmid}/action/"/>
    1065410654      <desc>
    1065510655        Starts resetting the machine's current state to the state contained
    … …  
    1118411184
    1118511185    <method name="powerUp">
    11186       <rest request="post" path="/vms/{vmid}/console/actions/"/>
     11186      <rest request="post" path="/vms/{vmid}/console/action/"/>
    1118711187      <desc>
    1118811188        Starts the virtual machine execution using the current machine
    … …  
    1123711237
    1123811238    <method name="powerUpPaused">
    11239       <rest request="post" path="/vms/{vmid}/console/actions/"/>
     11239      <rest request="post" path="/vms/{vmid}/console/action/"/>
    1124011240      <desc>
    1124111241        Identical to powerUp except that the VM will enter the
    … …  
    1126011260
    1126111261    <method name="powerDown">
    11262       <rest request="post" path="/vms/{vmid}/console/actions/"/>
     11262      <rest request="post" path="/vms/{vmid}/console/action/"/>
    1126311263      <desc>
    1126411264        Initiates the power down procedure to stop the virtual machine
    … …  
    1127811278
    1127911279    <method name="reset">
    11280       <rest request="post" path="/vms/{vmid}/console/actions/"/>
     11280      <rest request="post" path="/vms/{vmid}/console/action/"/>
    1128111281      <desc>Resets the virtual machine.
    1128211282        <result name="VBOX_E_INVALID_VM_STATE">
    … …  
    1129011290
    1129111291    <method name="pause">
    11292       <rest request="post" path="/vms/{vmid}/console/actions/"/>
     11292      <rest request="post" path="/vms/{vmid}/console/action/"/>
    1129311293      <desc>Pauses the virtual machine execution.
    1129411294        <result name="VBOX_E_INVALID_VM_STATE">
    … …  
    1130211302
    1130311303    <method name="resume">
    11304       <rest request="post" path="/vms/{vmid}/console/actions/"/>
     11304      <rest request="post" path="/vms/{vmid}/console/action/"/>
    1130511305      <desc>Resumes the virtual machine execution.
    1130611306        <result name="VBOX_E_INVALID_VM_STATE">
    … …  
    1131411314
    1131511315    <method name="powerButton">
    11316       <rest request="post" path="/vms/{vmid}/console/actions/"/>
     11316      <rest request="post" path="/vms/{vmid}/console/action/"/>
    1131711317      <desc>Sends the ACPI power button event to the guest.
    1131811318        <result name="VBOX_E_INVALID_VM_STATE">
    … …  
    1132611326
    1132711327    <method name="sleepButton">
    11328       <rest request="post" path="/vms/{vmid}/console/actions/"/>
     11328      <rest request="post" path="/vms/{vmid}/console/action/"/>
    1132911329      <desc>Sends the ACPI sleep button event to the guest.
    1133011330        <result name="VBOX_E_INVALID_VM_STATE">
    … …  
    1147211472
    1147311473    <method name="createSharedFolder">
    11474       <rest request="post" path="/vms/{vmid}/console/methods/"/>
     11474      <rest request="post" path="/vms/{vmid}/console/method/"/>
    1147511475      <desc>
    1147611476        Creates a transient new shared folder by associating the given logical
    … …  
    1150811508
    1150911509    <method name="removeSharedFolder">
    11510       <rest request="post" path="/vms/{vmid}/console/methods/"/>
     11510      <rest request="post" path="/vms/{vmid}/console/method/"/>
    1151111511      <desc>
    1151211512        Removes a transient shared folder with the given name previously
    … …  
    1156511565
    1156611566    <method name="addEncryptionPassword">
    11567       <rest request="post" path="/vms/{vmid}/console/methods/"/>
     11567      <rest request="post" path="/vms/{vmid}/console/method/"/>
    1156811568      <desc>
    1156911569        Adds a password used for encryption/decryption.
    … …  
    1159211592
    1159311593    <method name="addEncryptionPasswords">
    11594       <rest request="post" path="/vms/{vmid}/console/methods/"/>
     11594      <rest request="post" path="/vms/{vmid}/console/method/"/>
    1159511595      <desc>
    1159611596        Adds a password used for encryption/decryption.
    … …  
    1161911619
    1162011620    <method name="removeEncryptionPassword">
    11621       <rest request="post" path="/vms/{vmid}/console/methods/"/>
     11621      <rest request="post" path="/vms/{vmid}/console/method/"/>
    1162211622      <desc>
    1162311623        Removes a password used for hard disk encryption/decryption from
    … …  
    1163511635
    1163611636    <method name="clearAllEncryptionPasswords">
    11637       <rest request="post" path="/vms/{vmid}/console/methods/"/>
     11637      <rest request="post" path="/vms/{vmid}/console/method/"/>
    1163811638      <desc>Clears all provided supplied encryption passwords.</desc>
    1163911639    </method>
    … …  
    1818918189
    1819018190    <method name="waitForCompletion">
    18191       <rest request="post" path="/progresses/{progressid}/actions/"/>
     18191      <rest request="post" path="/progresses/{progressid}/action/"/>
    1819218192      <desc>
    1819318193          Waits until the task is done (including all sub-operations)
    … …  
    1821518215
    1821618216    <method name="waitForOperationCompletion">
    18217       <rest request="post" path="/progresses/{progressid}/actions/"/>
     18217      <rest request="post" path="/progresses/{progressid}/action/"/>
    1821818218      <desc>
    1821918219          Waits until the given operation is done with a given timeout in
    … …  
    1824118241
    1824218242    <method name="cancel">
    18243       <rest request="post" path="/progresses/{progressid}/actions/"/>
     18243      <rest request="post" path="/progresses/{progressid}/action/"/>
    1824418244      <desc>
    1824518245        Cancels the task.
    … …  
    1959719597
    1959819598    <method name="close" wrap-hint-server="passcaller">
    19599       <rest request="post" path="/media/{mediumid}/actions/"/>
     19599      <rest request="post" path="/media/{mediumid}/action/"/>
    1960019600      <desc>
    1960119601        Closes this medium.
    … …  
    1975819758
    1975919759    <method name="createBaseStorage">
    19760       <rest request="post" path="/media/{mediumid}/actions/"/>
     19760      <rest request="post" path="/media/{mediumid}/action/"/>
    1976119761      <desc>
    1976219762        Starts creating a hard disk storage unit (fixed/dynamic, according
    … …  
    1979319793
    1979419794    <method name="deleteStorage">
    19795       <rest request="post" path="/media/{mediumid}/actions/"/>
     19795      <rest request="post" path="/media/{mediumid}/action/"/>
    1979619796      <desc>
    1979719797        Starts deleting the storage unit of this medium.
    … …  
    1984019840
    1984119841    <method name="createDiffStorage" wrap-hint-server="passcaller">
    19842       <rest request="post" path="/media/{mediumid}/actions/"/>
     19842      <rest request="post" path="/media/{mediumid}/action/"/>
    1984319843      <desc>
    1984419844        Starts creating an empty differencing storage unit based on this
    … …  
    1987819878
    1987919879    <method name="mergeTo">
    19880       <rest request="post" path="/media/{mediumid}/actions/"/>
     19880      <rest request="post" path="/media/{mediumid}/action/"/>
    1988119881      <desc>
    1988219882        Starts merging the contents of this medium and all intermediate
    … …  
    1996119961
    1996219962    <method name="cloneTo">
    19963       <rest request="post" path="/media/{mediumid}/actions/"/>
     19963      <rest request="post" path="/media/{mediumid}/action/"/>
    1996419964      <desc>
    1996519965        Starts creating a clone of this medium in the format and at the
    … …  
    2001120011
    2001220012    <method name="cloneToBase">
    20013       <rest request="post" path="/media/{mediumid}/actions/"/>
     20013      <rest request="post" path="/media/{mediumid}/action/"/>
    2001420014    <desc>
    2001520015    Starts creating a clone of this medium in the format and at the
    … …  
    2005920059
    2006020060    <method name="moveTo" wrap-hint-server="passcaller">
    20061       <rest request="post" path="/media/{mediumid}/actions/"/>
     20061      <rest request="post" path="/media/{mediumid}/action/"/>
    2006220062      <desc>
    2006320063        Changes the location of this medium. Some medium types may support
    … …  
    2009620096
    2009720097    <method name="compact">
    20098       <rest request="post" path="/media/{mediumid}/actions/"/>
     20098      <rest request="post" path="/media/{mediumid}/action/"/>
    2009920099      <desc>
    2010020100        Starts compacting of this medium. This means that the medium is
    … …  
    2012320123
    2012420124    <method name="resize">
    20125       <rest request="post" path="/media/{mediumid}/actions/"/>
     20125      <rest request="post" path="/media/{mediumid}/action/"/>
    2012620126      <desc>
    2012720127        Starts resizing this medium. This means that the nominal size of the
    … …  
    2015520155
    2015620156    <method name="reset" wrap-hint-server="passcaller">
    20157       <rest request="post" path="/media/{mediumid}/actions/"/>
     20157      <rest request="post" path="/media/{mediumid}/action/"/>
    2015820158      <desc>
    2015920159        Starts erasing the contents of this differencing medium.
    … …  
    2018220182
    2018320183    <method name="changeEncryption">
    20184       <rest request="post" path="/media/{mediumid}/actions/"/>
     20184      <rest request="post" path="/media/{mediumid}/action/"/>
    2018520185      <desc>
    2018620186        Starts encryption of this medium. This means that the stored data in the
    … …  
    2027620276
    2027720277    <method name="resizeAndCloneTo">
    20278       <rest request="post" path="/media/{mediumid}/actions/"/>
     20278      <rest request="post" path="/media/{mediumid}/action/"/>
    2027920279
    2028020280      <desc>
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette