-
Notifications
You must be signed in to change notification settings - Fork 888
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
Align entity and parameter descriptions in Trace API #850
Comments
@open-telemetry/technical-committee Should we add a label "editorial" or "documentation" for issues/PRs intended to improve documentation without changing any meaning? |
A "documentation" label sounds good to me. |
I think the API spec cannot prescribe an actual entity model as in prescribing what data should actually be stored. It only describes the API. And if an API implementation decides to throw away some (or all in the case of no-op SDK) information, that should be OK. |
@Oberon00 I agree that the API spec cannnot prescribe an entity model but consumers need to know what data they can expect when writing exporters, for example. Given that implementations are free to discard any data passed by users to the API, this would indeed go better into the SDK spec. @bogdandrutu I explained extensively on #839 (comment) why I removed the inconsistent and wrong wording there:
To stay consistent with what we seem to agree here - that the API cannot prescribe an entity model - the mentions saying "An Event has the following properties" and the like should be removed from the spec since this does exactly that, prescribing an entity model. It should only say "There MUST be an API Note that I do, however, think it is legitimate for the API spec to prescribe which values are used if optional parameters are left out, so specifying that the current time at calling the API is applied if no timestamp is provided is fine IMHO. This is something often seen in interface definitions which, for example, say calling |
In specification/trace/api.md, some API definitions list parameters with Required/Optional as a prefix while others only mention this in the prose.
Furthermore, it is not always clear what's a required property of an entity in the model (i.e., always present, like the start or end timestamp of a span or an event timestamp) yet optional in the API since default values are defined (e.g., since implementations have to set the time of calling the API as a timestamp if no custom one is provided as an argument).
The text was updated successfully, but these errors were encountered: