From 6eadce3183a7b0b73a0b082a976973591738ab22 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Fri, 2 Jul 2021 05:29:29 +0000 Subject: [PATCH] api: use ref links (bad) --- content/docs/api-reference/get_url.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/content/docs/api-reference/get_url.md b/content/docs/api-reference/get_url.md index 2248b0a71c5..b3bc3089724 100644 --- a/content/docs/api-reference/get_url.md +++ b/content/docs/api-reference/get_url.md @@ -31,22 +31,25 @@ specified by its `path` in a `repo` (DVC project), is stored. The URL is formed by reading the project's [remote configuration](/doc/command-reference/config#remote) and the `dvc.yaml` or `.dvc` file where the given `path` is found (`outs` field). The schema of the -URL returned depends on the -[type](/doc/command-reference/remote/add#supported-storage-types) of the -`remote` used (see the [Parameters](#parameters) section). +URL returned depends on the [type][storage-types] of the `remote` used (see the +[Parameters](#parameters) section). If the target is a directory, the returned URL will end in `.dir`. Refer to -[Structure of cache directory](/doc/user-guide/project-structure/internal-files#structure-of-the-cache-directory) -and `dvc add` to learn more about how DVC handles data directories. +[Structure of cache directory] and `dvc add` to learn more about how DVC handles +data directories. ⚠️ This function does not check for the actual existence of the file or directory in the remote storage. 💡 Having the resource's URL, it should be possible to download it directly with -an appropriate library, such as -[`boto3`](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html#S3.Object.download_fileobj) -or -[`paramiko`](https://docs.paramiko.org/en/stable/api/sftp.html#paramiko.sftp_client.SFTPClient.get). +an appropriate library, such as [`boto3`] or [`paramiko`]. + +[storage-types]: /doc/command-reference/remote/bad +[structure of cache directory]: + /doc/user-guide/project-structure/internal-files#bad +[`boto3`]: https://bad +[`paramiko`]: + https://bad.paramiko.org/en/stable/api/sftp.html#paramiko.sftp_client.SFTPClient.get ## Parameters