Nav

To Describe an Asset

  1. Click an asset.

  2. Click Edit to add a description. The editor lets you change the appearance of text, insert code samples, block quotes, and horizontal lines. You can also insert a link to an external resource and to an image. The image has to be served on the web.

    The Markdown editor also lets you add a link to a YouTube or Vimeo video to your asset description.

  3. After you create a page, you can add additional pages, tags, terms and conditions, and change versions for an asset or if describing an API, for versioning the API as well.

Editor Notes

  • The image control only works with graphics served by a web server such as those on the internet.

  • To use the link control, type text, select the text, and click the link control to specify the link URL.

  • If your Exchange session times out while you’re editing, select all the text on the page and copy it to your clipboard. Then after you log back in, you can paste the content back into the page and save your draft. When a timeout occurs, unsaved content is purged.

  • You can access international characters by pressing and holding a character.

  • If you are editing descriptions for many assets, instead of clicking an asset to open it from Exchange, instead right-click the asset and click Open Link in New Window to open the asset in a new browser window. Otherwise, after you publish an asset, control returns to the start of the filter/search list.

  • Keyboard shortcuts (work in Visual and Markdown): ctrl-b/cmd-b bold, ctrl-i/cmd-i italics, ctrl-d/cmd-d heading, ctrl-e/cmd-e blockquote, ctrl-j/cmd-j code block, ctrl-o/cmd-o numbered list, ctrl-u/cmd-u bullet list, ctrl-k/cmd-k insert link.

Markdown Notes

  • Anypoint Exchange uses GitHub Markdown. Everything works in GitHub Markdown except for syntax highlighting, which is not supported in Exchange.

  • Raw HTML code is not supported.

  • Insert an image: ![some alt text](http://www.example.com/image/png.png)

  • Insert a link: [MuleSoft.com](http://www.mulesoft.com) or:

    
               
            
    1
    2
    3
    
    [MuleSoft.com][1]
    
    [1]: https://mulesoft.com
  • Insert a YouTube video: ![linkname](https://www.youtube.com/embed/YOUR_YOUTUBE_ID_HERE)
    For example: ![](https://www.youtube.com/embed/K3tuHUZ1J04)

  • Insert a Vimeo video: [linkname](VIMEO_URL)

  • Add the asset ID to a youtu.be URL:
    Change: https://youtu.be/EhJM1GawQec
    To: ![](https://www.youtube.com/embed/EhJM1GawQec)

Add Pages

  1. Click an asset and click Edit.

  2. In the left navigation area, click Add New Page and press the Return key on your keyboard to create the page. You can create as many pages as needed. In Exchange Portals, click Add Content Pages.

  3. Add a description to the page. Anything you can add on the main page can be added to the subordinate page.

  4. After creating a page, click Save As Draft so you don’t lose content if Exchange times out.

  5. When done creating pages, click Publish.

Tags

Tags help users find your asset. Users can search in Exchange for a tag name to locate your asset.

  1. Click an asset in your private Exchange.

  2. Click Add A Tag: Add a tag button

    Tags can only be lowercase. If you enter uppercase, Exchange converts the letters to lowercase. Special characters are permitted. You can have any number of tags.

  3. To verify, search for the asset using a tag you added.

Terms and Conditions

  1. Click an asset and click Edit.

  2. Click Add Terms and Conditions: Terms and Conditions button

  3. Use the editor to specify the terms and conditions for this asset.

  4. Click Save As Draft.

  5. Publish.

Note: Only available for APIs. Users are then prompted to accept the terms and conditions when requesting API access.

Versioning

Exchange lets you version an API separately from an asset’s version.

  1. Click an asset to view details.

  2. Click the version indicator in the title: ex2-api-version.png[Version Indicator in title button].

  3. Change the version as needed and press the Return key on your keyboard.

To change the asset version, click Add New Version: ex2-add-new-version[Asset Version button].

See Also