Custom assets management

Overview

In addition to APIs and packages, Developer Portal allows you to publish assets of your choice. This empowers providers to publish end-to-end development reference to their consumers.

As a provider, you can publish any kind of reference for your consumers using this feature.

You can add required asset types and define their properties. You can also create a gallery for the custom assets and display on the UI. Like APIs and packages, your end-users can view the custom assets and collaborate over them.

Custom asset publishing involves the following steps:

The following use cases demonstrate the process of publishing custom assets using an example. These use cases consider Microservices as custom assets and list the steps of publishing them to Developer Portal.

How do I configure the asset types to publish custom assets to Developer Portal?

Before publishing custom assets to Developer Portal, you must configure the asset type. You can add an asset type and configure its properties from the Manage asset type page.

This use case starts when you want to add a custom asset type and ends when you add the required asset type and configure its properties.

In this example, consider adding the asset type, Microservice with the following properties:

To add the asset type with the specified details

  1. Click the menu option icon from the title bar and click Administration.

  2. Click Manage asset types.

  3. Click Add type.

  4. Provide Microservice in the Name field.

  5. Provide a description in the Description field.

  6. Add the fields based on the information about custom assets that you want to publish.

    When you add an asset of the defined type, you must specify values for the configured properties.

    To add the Overview field:

    a. Click Add properties.

    b. Provide Overview in the Name field.

    c. Provide Microservice Overview in the Display name field.

    d. Select Rich text from the Select property type field.

    e. Click Add.

    To add the Microservice document field:

    a. Click Add properties.

    b. Provide Document in the Name field.

    c. Provide Microservice Document in the Display name field.

    d. Select File from the Select property type field.

    e. Click Add.

    To add the Published on field:

    a. Click Add properties.

    b. Provide Published On in the Name and Display name fields.

    c. Select Date from the Select property type field.

    d. Click Add.

    To add the Author field:

    a. Click Add properties.

    b. Provide Author in the Name field.

    c. Provide Author in the Display name field.

    d. Select String from the Select property type field.

    e. Turn the Required slider on.

    f. Click Add.

  7. Click Save.

    The asset type is added.

Alternative steps

Next steps

How do I add a custom asset to publish to Developer Portal?

After you have added the required asset type, you can add the custom assets of the configured type.

This use case starts when you want to add a custom asset and ends when you add the required assets.

In this example, consider adding an asset for the type, Microservice, that is already configured.

To add a custom asset

  1. Click the menu option icon from the title bar and click Administration.

  2. Click Manage assets.

  3. Click Microservice.

  4. Click Add Microservice.

  5. Provide information for the following default fields:

    a. Click Browse and select the logo file.

    b. Provide User registration in the Name field.

    c. Provide 1.0 in the Version field.

    d. Provide a summary for the asset.

    e. Provide sign in in the Tags field and press Enter.

  6. Provide information for the properties configured for the custom asset type:

    a. Provide an overview for the microservice in the Overview field.

    b. Click Browse from the Document field and select the required microservices document.

    c. Select a date and time from the Published On field.

    d. Provide an author name in the Author field.

  7. Click Save.

Next steps