Skip to content

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

Open
@e-backmark-ericsson

Description

@e-backmark-ericsson

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions