search

eiffel-community / eiffel

The Eiffel framework vocabulary, descriptions, guides and schemas along with links to relevant implementation repositories.
Apache License 2.0
121 stars 59 forks source link

Generate a list of allowed link types from the yml files #374

Open e-backmark-ericsson opened 9 months ago

e-backmark-ericsson commented 9 months ago

Description

As described in TC on Nov 16

Should the ER lookup spec (PR) include references to link types? No, allow any UPPERCASE_WITH_UNDERSCORES strings, including the magic “ALL” value. The help text can still contain a list of all link types. By doing this we allow custom events to be used and the API spec won’t be as dependent on the events. We’ll write an issue in the protocol repo to add an autogenerated documentation page containing all link types.

The should be an auto-generated md file showing the available link types for a certain Eiffel protocol edition. This doc would be possible to use as a target for Eiffel event producers/consumer to show what link types are available in the protocol, for example when performing queries towards an event repository.

Motivation

Usability

Exemplification

A table of link types and in what event types they are allowed

Benefits

Usability

Possible Drawbacks

None

e-backmark-ericsson commented 6 months ago

Good if the resulting file is also machine readable, preferably yaml