Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...


Warning
titleDeprecation notice (applicable for Markdown from a URL macro):

Please note that the URL user and URL password parameters are deprecated and will be removed on March 31, 2022. We recommend using profiles to access your data from remote locations.

Description

This article illustrates how to create a profile in the Markdown from a URL macro using a URL. 

Info

Before you begin:

  • Before you enter the URL for a repository, ensure that it is a raw URL.
    A raw URL is defined as the part of the URL following the domain information and includes the query string, if present. For example, in the URL string http://www.contoso.com/articles/recent.aspx, the raw URL is /articles/recent.aspx

    Tip
    titleHow to identify if a file is valid for the macro?

    Paste the file link into your browser's address bar. If the actual code is displayed in the browser, it is considered to be invalid or in an incorrect format. If the file downloads to your system, the macro can process the file and its contents.


  • Know what is a complete URL.
    • A typical path for the raw file on GitLab looks like:
      /projects/:id/repository/files/:file_path/raw
    • Since the host address begins with:
      https://gitlab.com/api/v4
    • The complete URL, in this example, looks like: 
      https://gitlab.com/api/v4/projects/:id/repository/files/:file_path/raw?ref=master

  • For illustrative purposes, a public Bitbucket public repository is usedUse URLs to add to profiles and in macros as per your requirement and your instance. The process for adding a profile and using it in macros remains the same for other repositories and external sources. 

    Note
    titleFor private Bitbucket repositories (from third party applications):

    Use the following URL path to connect to a private Bitbucket repository if logging in from third party applications such as Google:

    https://api.bitbucket.org/2.0/repositories/$workspace/$repo/src/$commit/$filepath

    The path to be specified in the URL parameter of a profile looks like the following example:

    https://api.bitbucket.org/2.0/repositories/appfire/ac-app-dist/src/17f199444d1386c543ac642e9155b396aaeca403/README.md


...