how to discover API labels

[dret]

how do we want to make API label documents discoverable? here are two options:

• define a labels link relation type to be specifically defined for associating labels (could be used for other labeling schemes as well).

• recommend the use of the existing link relation type describedby to be used for linking to an API labels document.

[dret]

it may also be worth to talk about discovery from formats that are relevant but have no built-in way to use typed links. OpenAPI comes to mind...

[dret]

wondering whether while you're working of the landscape viewer and the set of labels it is using, @u1i, there is some input for this issue just from the implementation point of view?

[dret]

for now (i.e., the API days paris presentation), http://dret.net/lectures/api-days-paris-2019/#api-to-labels is saying that we're going the describedby route.

[ioggstream]

Integrating API labels and OAS could be interesting.

Related to OAI/OpenAPI-Specification#1973

[dret]

On 2020-01-16 08:04, Roberto Polli wrote: Integrating API labels and OAS could be interesting.

yes, it definitely would be useful. sadly, OpenAPI has no way to register extensions, but that's how it is. the etiketo spec maybe should define a way to do it, and possibly for other description formations as well.

[ioggstream]

this is a simplistic approach, though it's something. Clearly those are not expected to overlap with other info attributes.

info:
  ....
  x-draft-labels:
    labels:
       maturity: stable
       "https://foo.it#bar": baz
 

Let me know if you have another proposal. We aim at populating api catalogs based just on OAS spec and that's one of the missing links to achieve the goal.