Skip to content

Commit

Permalink
Remove "canonical" adjective from Status Code (#1081)
Browse files Browse the repository at this point in the history
* Remove "canonical" adjective from Status Code

Resolves: #1069

* Address PR comments
  • Loading branch information
tigrannajaryan authored Oct 14, 2020
1 parent f8ff8c3 commit f3c1b44
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ release.

New:

- Rename "Canonical status code" to "Status code"
([#1081](https://github.com/open-telemetry/opentelemetry-specification/pull/1081))
- Add Metadata for Baggage entries, and clarify W3C Baggage Propagator implementation
([#1066](https://github.com/open-telemetry/opentelemetry-specification/pull/1066))
- Change Status to be consistent with Link and Event
Expand Down
10 changes: 5 additions & 5 deletions specification/trace/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -508,10 +508,10 @@ status, which is `Unset`.

`Status` is structurally defined by the following properties:

- `StatusCanonicalCode` that represents the canonical set of `Status` codes.
- `StatusCode`, one of the values listed below.
- Optional `Description` that provides a descriptive message of the `Status`.

`StatusCanonicalCode` has the following values:
`StatusCode` is one of the following values:

- `Unset`
- The default status.
Expand All @@ -524,9 +524,9 @@ status, which is `Unset`.
The Span interface MUST provide:

- An API to set the `Status`. This SHOULD be called `SetStatus`.
This API takes the `StatusCanonicalCode`, and optional `Description`,
either as individual parameters or as an immutable object encapsulating them,
whichever is most appropriate for the language.
This API takes the `StatusCode`, and an optional `Description`, either as
individual parameters or as an immutable object encapsulating them, whichever
is most appropriate for the language.

The status code SHOULD remain unset, except for the following circumstances:

Expand Down

0 comments on commit f3c1b44

Please sign in to comment.