search

alps-io / spec

ALPS Specification documents.
59 stars 13 forks source link

add TYPE property to EXT element #90

Closed mamund closed 3 years ago

mamund commented 3 years ago

i've found a handful of times that i need to mark EXT elements with TYPE information to help reader/writer tooling. This will be a single string property that can contain any valid string text. the meaning of that value can be documented when documenting the EXT element itself.

<ext id="hatSize" type="enum" value="large medium small really-big" />

this may also help with issue #8

filip26 commented 3 years ago

If type value range is not defined by the specification then it adds just a little value, because it is expected that a client/processor 'knows' but if a client knows then it has to know an unspecified type attribute as well.

if the type value range is defined then I'm thinking maybe introducing other elements could be more readable.

e.g.

<enum id="hatSize" value="...."/>

I personally like keeping the spec simple. Let's discuss it.

mamund commented 3 years ago

we can discuss this in the weekly AOOH. I'm OK w/ dropping the TYPE element for EXT if it complicates things.

mamund commented 3 years ago

decided to not add this right now. not a wide need and we can address late, if needed.

mamund commented 3 years ago

closed out