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

Use normative key words for Asynchronous and Synchronous API parameters #3074

Merged
merged 13 commits into from
Jan 30, 2023

Conversation

MrAlias
Copy link
Contributor

@MrAlias MrAlias commented Jan 4, 2023

Communicate the which parameters are absolute requirement for the Synchronous and Asynchronous instrument APIs to accept and the other parameters which are truly optional by using key words adopted by this specification and defined in BCP-14.

Communicate the which parameters are absolute requirement for the
Synchronous and Asynchronous instrument APIs to accept and the other
parameters which are truly optional by using key words adopted by this
specification and defined in BCP-14.
@MrAlias MrAlias added spec:metrics Related to the specification/metrics directory editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. labels Jan 4, 2023
@MrAlias MrAlias requested review from a team January 4, 2023 22:23
specification/metrics/api.md Outdated Show resolved Hide resolved
specification/metrics/api.md Outdated Show resolved Hide resolved
MrAlias and others added 2 commits January 18, 2023 15:46
Co-authored-by: Tristan Sloughter <[email protected]>
Co-authored-by: Tristan Sloughter <[email protected]>
@jmacd jmacd merged commit f35892a into open-telemetry:main Jan 30, 2023
@MrAlias MrAlias deleted the norm-specify-inst-params branch January 30, 2023 17:08
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
…rs (open-telemetry#3074)

* Use normative key words for inst API params

Communicate the which parameters are absolute requirement for the
Synchronous and Asynchronous instrument APIs to accept and the other
parameters which are truly optional by using key words adopted by this
specification and defined in BCP-14.

* Update specification/metrics/api.md

Co-authored-by: Joao Grassi <[email protected]>

* Restructure based on PR feedback

* Update specification/metrics/api.md

Co-authored-by: Tristan Sloughter <[email protected]>

* Update specification/metrics/api.md

Co-authored-by: Tristan Sloughter <[email protected]>

* Recommend no validation instead of requiring

---------

Co-authored-by: Joao Grassi <[email protected]>
Co-authored-by: Tristan Sloughter <[email protected]>
Co-authored-by: Joshua MacDonald <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. spec:metrics Related to the specification/metrics directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants