Skip to content

Commit

Permalink
Replace slashes in xrefs with hyphens
Browse files Browse the repository at this point in the history
  • Loading branch information
apinnick authored and oliel committed Jul 4, 2022
1 parent 16bfe73 commit b7f1893
Show file tree
Hide file tree
Showing 65 changed files with 162 additions and 162 deletions.
16 changes: 8 additions & 8 deletions src/main/java/services/AttachedStorageDomainDiskService.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
*
* IMPORTANT: Since version 4.2 of the engine this service is intended only to list disks available in the storage
* domain, and to register unregistered disks. All the other operations, like copying a disk, moving a disk, etc, have
* been deprecated and will be removed in the future. To perform those operations use the xref:services/disks[service that manages all the disks of the system]
* or the xref:services/disk[service that manages a specific disk].
* been deprecated and will be removed in the future. To perform those operations use the xref:services-disks[service that manages all the disks of the system]
* or the xref:services-disk[service that manages a specific disk].
*
* @author Juan Hernandez <juan.hernandez@redhat.com>
* @date 4 Nov 2016
Expand All @@ -43,7 +43,7 @@ public interface AttachedStorageDomainDiskService extends MeasurableService {
* Copies a disk to the specified storage domain.
*
* IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards
* compatibility. It will be removed in the future. To copy a disk use the xref:services/disk/methods/copy[copy]
* compatibility. It will be removed in the future. To copy a disk use the xref:services-disk-methods-copy[copy]
* operation of the service that manages that disk.
*
* @author Juan Hernandez <juan.hernandez@redhat.com>
Expand Down Expand Up @@ -76,7 +76,7 @@ interface Copy {
*
* IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards
* compatibility. It will be removed in the future. To update a disk use the
* xref:services/disk/methods/update[update] operation of the service that manages that disk.
* xref:services-disk-methods-update[update] operation of the service that manages that disk.
*
* @author Juan Hernandez <juan.hernandez@redhat.com>
* @date 4 Jan 2017
Expand All @@ -98,7 +98,7 @@ interface Update {
* Exports a disk to an export storage domain.
*
* IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards
* compatibility. It will be removed in the future. To export a disk use the xref:services/disk/methods/export[export]
* compatibility. It will be removed in the future. To export a disk use the xref:services-disk-methods-export[export]
* operation of the service that manages that disk.
*
* @author Juan Hernandez <juan.hernandez@redhat.com>
Expand Down Expand Up @@ -138,7 +138,7 @@ interface Get extends Follow {
* Moves a disk to another storage domain.
*
* IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards
* compatibility. It will be removed in the future. To move a disk use the xref:services/disk/methods/move[move]
* compatibility. It will be removed in the future. To move a disk use the xref:services-disk-methods-move[move]
* operation of the service that manages that disk.
*
* @author Juan Hernandez <juan.hernandez@redhat.com>
Expand Down Expand Up @@ -170,7 +170,7 @@ interface Move {
* Removes a disk.
*
* IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards
* compatibility. It will be removed in the future. To remove a disk use the xref:services/disk/methods/remove[remove]
* compatibility. It will be removed in the future. To remove a disk use the xref:services-disk-methods-remove[remove]
* operation of the service that manages that disk.
*
* @author Juan Hernandez <juan.hernandez@redhat.com>
Expand All @@ -184,7 +184,7 @@ interface Remove {
* Sparsify the disk.
*
* IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards
* compatibility. It will be removed in the future. To remove a disk use the xref:services/disk/methods/remove[remove]
* compatibility. It will be removed in the future. To remove a disk use the xref:services-disk-methods-remove[remove]
* operation of the service that manages that disk.
*
* @author Juan Hernandez <juan.hernandez@redhat.com>
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/services/AttachedStorageDomainDisksService.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ public interface AttachedStorageDomainDisksService {
* Adds or registers a disk.
*
* IMPORTANT: Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards
* compatibility. It will be removed in the future. To add a new disk use the xref:services/disks/methods/add[add]
* compatibility. It will be removed in the future. To add a new disk use the xref:services-disks-methods-add[add]
* operation of the service that manages the disks of the system. To register an unregistered disk use the
* xref:services/attached_storage_domain_disk/methods/register[register] operation of the service that manages
* xref:services-attached_storage_domain_disk-methods-register[register] operation of the service that manages
* that disk.
*
* @author Juan Hernandez <juan.hernandez@redhat.com>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/services/ClusterEnabledFeatureService.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public interface ClusterEnabledFeatureService {
* GET /ovirt-engine/api/clusters/123/enabledfeatures/456
* ----
*
* That will return a xref:types/cluster_feature[ClusterFeature] object containing the name:
* That will return a xref:types-cluster_feature[ClusterFeature] object containing the name:
*
* [source,xml]
* ----
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/services/ClusterFeatureService.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public interface ClusterFeatureService {
* GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures/456
* ----
*
* That will return a xref:types/cluster_feature[ClusterFeature] object containing the name:
* That will return a xref:types-cluster_feature[ClusterFeature] object containing the name:
*
* [source,xml]
* ----
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/services/ClusterLevelService.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import types.ClusterLevel;

/**
* Provides information about a specific cluster level. See the xref:services/cluster_levels[ClusterLevels] service for
* Provides information about a specific cluster level. See the xref:services-cluster_levels[ClusterLevels] service for
* more information.
*/
@Service
Expand All @@ -38,7 +38,7 @@ public interface ClusterLevelService {
* GET /ovirt-engine/api/clusterlevels/3.6
* ----
*
* That will return a xref:types/cluster_level[ClusterLevel] object containing the supported CPU types, and other
* That will return a xref:types-cluster_level[ClusterLevel] object containing the supported CPU types, and other
* information which describes the cluster level:
*
* [source,xml]
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/services/DiskAttachmentsService.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

/**
* This service manages the set of disks attached to a virtual machine. Each attached disk is represented by a
* xref:types/disk_attachment[DiskAttachment], containing the bootable flag, the disk interface and the reference to
* xref:types-disk_attachment[DiskAttachment], containing the bootable flag, the disk interface and the reference to
* the disk.
*/
@Service
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/services/DiskService.java
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,7 @@ interface Sparsify {
* Refreshing a direct LUN disk is useful when:
*
* - The LUN was added using the API without the host parameter, and therefore does not contain
* any information from the storage (see xref:services/disks/methods/add[DisksService::add]).
* any information from the storage (see xref:services-disks-methods-add[DisksService::add]).
* - New information about the LUN is available on the storage and you want to update the LUN with it.
*
* To refresh direct LUN disk `123` using host `456`, send the following request:
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/services/DisksService.java
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ public interface DisksService {
*
* *Adding a new image disk:*
*
* When creating a new floating image xref:types/disk[Disk], the API requires the `storage_domain`, `provisioned_size`
* When creating a new floating image xref:types-disk[Disk], the API requires the `storage_domain`, `provisioned_size`
* and `format` attributes.
*
* Note that block storage domains (i.e. storage domains with the xref:types/storage_type[storage type] of iSCSI or
* Note that block storage domains (i.e. storage domains with the xref:types-storage_type[storage type] of iSCSI or
* FCP) don't support the combination of the raw `format` with `sparse=true`, so `sparse=false` must be stated
* explicitly.
*
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/services/ExternalTemplateImportsService.java
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public interface ExternalTemplateImportsService {
* POST /externaltemplateimports
* ----
*
* With request body of type xref:types/external_template_import[ExternalTemplateImport], for example:
* With request body of type xref:types-external_template_import[ExternalTemplateImport], for example:
*
* [source,xml]
* ----
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/services/ExternalVmImportsService.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public interface ExternalVmImportsService {
* POST /externalvmimports
* ----
*
* With request body of type xref:types/external_vm_import[ExternalVmImport], for example:
* With request body of type xref:types-external_vm_import[ExternalVmImport], for example:
*
* [source,xml]
* ----
Expand Down
14 changes: 7 additions & 7 deletions src/main/java/services/HostService.java
Original file line number Diff line number Diff line change
Expand Up @@ -192,10 +192,10 @@ default void inputDetail() {
* ----
*
* IMPORTANT: Since {engine-name} 4.3, it is possible to also specify `commit_on_success` in
* the xref:services/host/methods/setup_networks[setupnetworks] request, in which case the new
* the xref:services-host-methods-setup_networks[setupnetworks] request, in which case the new
* configuration is automatically saved in the {hypervisor-name} upon completing the setup and
* re-establishing connectivity between the {hypervisor-name} and {engine-name}, and without
* waiting for a separate xref:services/host/methods/commit_net_config[commitnetconfig] request.
* waiting for a separate xref:services-host-methods-commit_net_config[commitnetconfig] request.
*
* @author Juan Hernandez <juan.hernandez@redhat.com>
* @author Martin Mucha <mmucha@redhat.com>
Expand Down Expand Up @@ -1004,7 +1004,7 @@ default void inputDetail() {
* Check if there are upgrades available for the host. If there are upgrades available an icon will be displayed
* next to host status icon in the Administration Portal. Audit log messages are also added to indicate the
* availability of upgrades. The upgrade can be started from the webadmin or by using the
* xref:services/host/methods/upgrade[upgrade] host action.
* xref:services-host-methods-upgrade[upgrade] host action.
*
* @author Ravi Nori <rnori@redhat.com>
* @author Megan Lewis <melewis@redhat.com>
Expand Down Expand Up @@ -1246,13 +1246,13 @@ interface Remove {
* ----
*
* IMPORTANT: To make sure that the network configuration has been saved in the host, and that it will be applied
* when the host is rebooted, remember to call xref:services/host/methods/commit_net_config[commitnetconfig].
* when the host is rebooted, remember to call xref:services-host-methods-commit_net_config[commitnetconfig].
*
* IMPORTANT: Since {engine-name} 4.3, it is possible to also specify `commit_on_success` in
* the xref:services/host/methods/setup_networks[setupnetworks] request, in which case the new
* the xref:services-host-methods-setup_networks[setupnetworks] request, in which case the new
* configuration is automatically saved in the {hypervisor-name} upon completing the setup and
* re-establishing connectivity between the {hypervisor-name} and {engine-name}, and without
* waiting for a separate xref:services/host/methods/commit_net_config[commitnetconfig] request.
* waiting for a separate xref:services-host-methods-commit_net_config[commitnetconfig] request.
*
*
* @author Megan Lewis <melewis@redhat.com>
Expand Down Expand Up @@ -1307,7 +1307,7 @@ default void inputDetail() {
/**
* Specifies whether to automatically save the configuration in the {hypervisor-name} upon completing
* the setup and re-establishing connectivity between the {hypervisor-name} and {engine-name},
* and without waiting for a separate xref:services/host/methods/commit_net_config[commitnetconfig]
* and without waiting for a separate xref:services-host-methods-commit_net_config[commitnetconfig]
* request.
* The default value is `false`, which means that the configuration will not be
* saved automatically.
Expand Down
24 changes: 12 additions & 12 deletions src/main/java/services/ImageTransferService.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

/**
* This service provides a mechanism to control an image transfer. The client will have
* to create a transfer by using xref:services/image_transfers/methods/add[add]
* of the xref:services/image_transfers[image transfers] service, stating the image to transfer
* to create a transfer by using xref:services-image_transfers-methods-add[add]
* of the xref:services-image_transfers[image transfers] service, stating the image to transfer
* data to/from.
*
* After doing that, the transfer is managed by this service.
Expand Down Expand Up @@ -65,7 +65,7 @@
* ----
*
* If the user wishes to download a disk rather than upload, he/she should specify
* `download` as the xref:types/image_transfer_direction[direction] attribute of the transfer.
* `download` as the xref:types-image_transfer_direction[direction] attribute of the transfer.
* This will grant a read permission from the image, instead of a write permission.
*
* E.g:
Expand All @@ -86,11 +86,11 @@
* Transfers have phases, which govern the flow of the upload/download.
* A client implementing such a flow should poll/check the transfer's phase and
* act accordingly. All the possible phases can be found in
* xref:types/image_transfer_phase[ImageTransferPhase].
* xref:types-image_transfer_phase[ImageTransferPhase].
*
* After adding a new transfer, its phase will be xref:types/image_transfer_phase[initializing].
* After adding a new transfer, its phase will be xref:types-image_transfer_phase[initializing].
* The client will have to poll on the transfer's phase until it changes.
* When the phase becomes xref:types/image_transfer_phase[transferring],
* When the phase becomes xref:types-image_transfer_phase[transferring],
* the session is ready to start the transfer.
*
* For example:
Expand All @@ -103,14 +103,14 @@
* transfer = transfer_service.get()
* ----
*
* At that stage, if the transfer's phase is xref:types/image_transfer_phase[paused_system], then the session was
* At that stage, if the transfer's phase is xref:types-image_transfer_phase[paused_system], then the session was
* not successfully established. One possible reason for that is that the ovirt-imageio-daemon is not running
* in the host that was selected for transfer.
* The transfer can be resumed by calling xref:services/image_transfer/methods/resume[resume]
* The transfer can be resumed by calling xref:services-image_transfer-methods-resume[resume]
* of the service that manages it.
*
* If the session was successfully established - the returned transfer entity will
* contain the xref:types/image_transfer[transfer_url] and xref:types/image_transfer[proxy_url] attributes,
* contain the xref:types-image_transfer[transfer_url] and xref:types-image_transfer[proxy_url] attributes,
* which the client needs to use in order to transfer the required data. The client can choose whatever
* technique and tool for sending the HTTPS request with the image's data.
*
Expand All @@ -137,7 +137,7 @@
* http://ovirt.github.io/ovirt-imageio/images.html
*
* When finishing the transfer, the user should call
* xref:services/image_transfer/methods/finalize[finalize]. This will make the
* xref:services-image_transfer-methods-finalize[finalize]. This will make the
* final adjustments and verifications for finishing the transfer process.
*
* For example:
Expand All @@ -148,9 +148,9 @@
* ----
*
* In case of an error, the transfer's phase will be changed to
* xref:types/image_transfer_phase[finished_failure], and
* xref:types-image_transfer_phase[finished_failure], and
* the disk's status will be changed to `Illegal`. Otherwise it will be changed to
* xref:types/image_transfer_phase[finished_success], and the disk will be ready
* xref:types-image_transfer_phase[finished_success], and the disk will be ready
* to be used. In both cases, the transfer entity will be removed shortly after.
*
*
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/services/ImageTransfersService.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

/**
* This service manages image transfers, for performing Image I/O API in {product-name}.
* Please refer to xref:services/image_transfer[image transfer] for further
* Please refer to xref:services-image_transfer[image transfer] for further
* documentation.
*
* @author Amit Aviram <aaviram@redhat.com>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/services/NetworkFiltersService.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
* Represents a readonly network filters sub-collection.
*
* The network filter enables to filter packets send to/from the VM's nic according to defined rules.
* For more information please refer to xref:services/network_filter[NetworkFilter] service documentation
* For more information please refer to xref:services-network_filter[NetworkFilter] service documentation
*
* Network filters are supported in different versions, starting from version 3.0.
*
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/services/NetworkService.java
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ default void inputDetail() {
* NOTE: To remove an external logical network, the network has to be removed directly from its provider by
* link:https://developer.openstack.org/api-ref/network[OpenStack Networking API].
* The entity representing the external network inside {product-name} is removed automatically,
* if xref:types/open_stack_network_provider/attributes/auto_sync[`auto_sync`] is enabled for the provider,
* if xref:types-open_stack_network_provider-attributes-auto_sync[`auto_sync`] is enabled for the provider,
* otherwise the entity has to be removed using this method.
*
* @author Martin Mucha <mmucha@redhat.com>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/services/PermitsService.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
@Area("Infrastructure")
public interface PermitsService {
/**
* Adds a permit to the role. The permit name can be retrieved from the xref:services/cluster_levels[cluster_levels] service.
* Adds a permit to the role. The permit name can be retrieved from the xref:services-cluster_levels[cluster_levels] service.
*
* For example to assign a permit `create_vm` to the role with id `123` send a request like this:
*
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/services/RoleService.java
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ interface Remove {
/**
* Updates a role. You are allowed to update `name`, `description` and `administrative` attributes after role is
* created. Within this endpoint you can't add or remove roles permits you need to use
* xref:services/permits[service] that manages permits of role.
* xref:services-permits[service] that manages permits of role.
*
* For example to update role's `name`, `description` and `administrative` attributes send a request like this:
*
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/services/SnapshotsService.java
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ public interface SnapshotsService {
* [IMPORTANT]
* ====
* When a snapshot is created, the default value for the
* xref:types/snapshot/attributes/persist_memorystate[persist_memorystate] attribute is `true`. That means that the content of the memory of the virtual
* xref:types-snapshot-attributes-persist_memorystate[persist_memorystate] attribute is `true`. That means that the content of the memory of the virtual
* machine will be included in the snapshot, and it also means that the virtual machine will be paused
* for a longer time. That can negatively affect applications that are very sensitive to timing (NTP
* servers, for example). In those cases make sure that you set the attribute to `false`:
Expand Down
Loading

0 comments on commit b7f1893

Please sign in to comment.