Add more information regarding starterProjects in the devfile spec and in the REST API

[schultzp2020]

Which area this feature is related to?

/area api /area registry

Which functionality do you think we should add?

Detailed description:

1. Starter projects should have a display name property.
2. More information regarding starter projects should be returned using the REST API.

Why is this needed? Is your feature request related to a problem?

1. Starter project names displayed on the registry viewer would look nicer.
2. The registry viewer would not need to parse the devfile YAML to access the display name and description properties.

Describe the solution you'd like

Add a display name property to each starter project.

Devfile Spec Example

starterProjects:
  - name: flask-example
    displayName: Flask Example
    description:
      'Flask is a web framework, it’s a Python module that lets you develop web applications easily.
      It’s has a small and easy-to-extend core: it’s a microframework that doesn’t include an ORM (Object Relational Manager) or such features.'
    git:
      remotes:
        origin: https://github.com/devfile-samples/python-ex

Return more information regarding starter projects in the REST API

• name
• displayName
• description
• Potentially more fields?

[
  ...
    {
    "name": "python",
    "version": "2.0.1",
    "displayName": "Python",
    ...
    "starterProjects": [
      {
        "name": "flask-example",
        "displayName": "Flask Example",
        "description": "..."
      },
    ],
    "provider": "Red Hat"
  },
  ...
]

Describe alternatives you've considered

N/A

Additional context

N/A

[callmetushar123]

Hello @schultzp2020 , can you point out in which file I have to make changes for the REST API? I understood the first part and would make changes accordingly

[schultzp2020]

@callmetushar123 For now, this issue cannot proceed because this requires changes to the devfile spec and we are waiting for the 2.2.0 release. Once that is complete, roughly 1-2 weeks, this issue can proceed. In the meantime, here is where the registry server is located.

[callmetushar123]

@schultzp2020 If I am not wrong this is where I need to make changes in the API right after the 2.2.0 release?

[schultzp2020]

@callmetushar123 it's located here

[callmetushar123]

@schultzp2020 please put assign tag to me. I would like to try it after the latest release

[callmetushar123]

Hello I would like to try this issue this year, please don't remove me

[Jdubrick]

Hello @callmetushar123 , would you like to still be attached to this issue?

[callmetushar123]

Hi @Jdubrick , Please give it to someone else