Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
e-backmark-ericsson opened this issue Nov 28, 2023 · 1 comment
Open

Comments

@e-backmark-ericsson
Copy link
Member

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
Copy link
Member Author

e-backmark-ericsson commented Mar 7, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

1 participant