Skip to content

Add "self" link to point to the path of devfile in index schema #297

@GeekArthur

Description

@GeekArthur

Is your feature request related to a problem? Please describe.
According to this thread, for index server REST APIs, http://{registry host}/devfiles/{stack} is a convention we define in our spec, the proposal is we can add "self" field to point to the path of the devfile in index schema so that consumer can use http://{registry host}/{self} (where {self} is devfiles/{stack}) to get the content of the devfile at the time of getting the index.

Describe the solution you'd like
To make the change, I think the URL of the REST API design is still http://{registry host}/devfiles/{stack}, but if we do need a "self" as the shortcut for users we can the following things:

  • Change the current "self" field to "image" or "stack"
  • Add the "self" field to point to devfiles/{stack}
  • Update index schema and index generator
  • Update index server REST APIs

Which means the main URL definition is http://{registry host}/devfiles/{stack}, users can use either use http://{registry host}/devfiles/{stack} or http://{registry host}/{self} to get the content of the devfile, so that we can both provide a clear URL definition to users with RESTful design and let users get the devfile content with self placeholder without worrying about the structure.

CC @amisevsk

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/registryDevfile registry for stacks and infrastructurelifecycle/rottenRotten items. These items have been stale for 60 days and are now closed.lifecycle/staleStale items. These items have not been updated for 90 days.

    Type

    No type

    Projects

    Status

    Done ✅

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions