Skip to content

Add schema modeling rule describing deprecation process #659

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.

Sign up for GitHub

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

Merged
codeboten merged 3 commits into from
Jun 19, 2026
+58 −9
Merged

Add schema modeling rule describing deprecation process #659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a700dad
Add schema modeling rule describing deprecation process
jack-berg Jun 16, 2026
3fa77a1
Exempt experimental features
jack-berg Jun 16, 2026
6734105
Merge branch 'main' into deprecation-modeling-rule
codeboten Jun 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,55 @@ tracer_provider:

[Schema validation](#schema-validation) project tooling enforces that types labeled `isSdkExtensionPlugin: true` are modeled consistently as described above.

### Deprecating properties and types

Properties and types that are no longer recommended for use should be deprecated rather than removed. Per the [versioning policy](VERSIONING.md), no existing type or type property may be deleted in a `MINOR` version. Deprecated properties and types must therefore be kept until at least the next `MAJOR` version.
Comment thread
jack-berg marked this conversation as resolved.

This guidance does not apply to [experimental features](VERSIONING.md#experimental-features), which are exempt from versioning policy guarantees and may be removed in `MINOR` versions without deprecation.

To deprecate a property or type:

1. Set [`deprecated: true`](https://json-schema.org/understanding-json-schema/reference/annotations) on the property or type in the YAML source.
2. Update the `description` to include a bold `**Deprecated**` notice that:
* States the first `MINOR` version in which the deprecation appears and the earliest `MAJOR` version in which it may be removed (e.g. "as of v1.2.0, may be removed in v2.0.0").
* Explains why the property or type is deprecated, including a link to the relevant specification change.
* Advises that SDKs MAY continue to support the property for backwards compatibility and that new configurations SHOULD NOT use it.
3. Add a CHANGELOG entry.

For example, a deprecated property in YAML source:

```yaml
opencensus:
$ref: "#/$defs/OpenCensusMetricProducer"
deprecated: true
description: |
Configure metric producer to be opencensus.

**Deprecated** as of v1.2.0, may be removed in v2.0.0. The OpenCensus
compatibility specification it relies on was deprecated in
https://github.com/open-telemetry/opentelemetry-specification/pull/5138.
SDKs MAY continue to support this entry for backwards compatibility;
new configurations SHOULD NOT use it.
defaultBehavior: ignore
```

And a deprecated type:

```yaml
OpenCensusMetricProducer:
type:
- object
- "null"
additionalProperties: false
deprecated: true
description: |
**Deprecated** as of v1.2.0, may be removed in v2.0.0. The OpenCensus
compatibility specification it relies on was deprecated in
https://github.com/open-telemetry/opentelemetry-specification/pull/5138.
See also the
[OpenCensus sunset announcement](https://opentelemetry.io/blog/2023/sunsetting-opencensus/).
```

## Project tooling

This repository has a variety of tooling assisting with the development of the JSON schema and associated artifacts.
Expand Down
4 changes: 2 additions & 2 deletions opentelemetry_configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1673,7 +1673,7 @@
"opencensus": {
"$ref": "#/$defs/OpenCensusMetricProducer",
"deprecated": true,
"description": "Configure metric producer to be opencensus.\n\n**Deprecated** as of June 2026. The OpenCensus compatibility\nspecification it relies on was deprecated in\nhttps://github.com/open-telemetry/opentelemetry-specification/pull/5138.\nSDKs MAY continue to support this entry for backwards compatibility;\nnew configurations SHOULD NOT use it.\nIf omitted, ignore.\n"
"description": "Configure metric producer to be opencensus.\n\n**Deprecated** as of v1.2.0, may be removed in v2.0.0. The OpenCensus\ncompatibility specification it relies on was deprecated in\nhttps://github.com/open-telemetry/opentelemetry-specification/pull/5138.\nSDKs MAY continue to support this entry for backwards compatibility;\nnew configurations SHOULD NOT use it.\nIf omitted, ignore.\n"
}
}
},
Expand Down Expand Up @@ -1721,7 +1721,7 @@
],
"additionalProperties": false,
"deprecated": true,
"description": "**Deprecated** as of June 2026. The OpenCensus compatibility specification\nit relies on was deprecated in\nhttps://github.com/open-telemetry/opentelemetry-specification/pull/5138.\nSee also the\n[OpenCensus sunset announcement](https://opentelemetry.io/blog/2023/sunsetting-opencensus/).\n"
"description": "**Deprecated** as of v1.2.0, may be removed in v2.0.0. The OpenCensus\ncompatibility specification it relies on was deprecated in\nhttps://github.com/open-telemetry/opentelemetry-specification/pull/5138.\nSee also the\n[OpenCensus sunset announcement](https://opentelemetry.io/blog/2023/sunsetting-opencensus/).\n"
},
"OtlpGrpcExporter": {
"type": [
Expand Down
6 changes: 3 additions & 3 deletions schema-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1850,7 +1850,7 @@ No snippets.

| Property | Type | Required? | Default and Null Behavior | Constraints | Description |
|---|---|---|---|---|---|
| `opencensus` | [`OpenCensusMetricProducer`](#opencensusmetricproducer) | `false` | If omitted, ignore. | No constraints. | Configure metric producer to be opencensus.<br><br>**Deprecated** as of June 2026. The OpenCensus compatibility<br>specification it relies on was deprecated in<br>https://github.com/open-telemetry/opentelemetry-specification/pull/5138.<br>SDKs MAY continue to support this entry for backwards compatibility;<br>new configurations SHOULD NOT use it.<br> |
| `opencensus` | [`OpenCensusMetricProducer`](#opencensusmetricproducer) | `false` | If omitted, ignore. | No constraints. | Configure metric producer to be opencensus.<br><br>**Deprecated** as of v1.2.0, may be removed in v2.0.0. The OpenCensus<br>compatibility specification it relies on was deprecated in<br>https://github.com/open-telemetry/opentelemetry-specification/pull/5138.<br>SDKs MAY continue to support this entry for backwards compatibility;<br>new configurations SHOULD NOT use it.<br> |

<details>
<summary>Language support status</summary>
Expand Down Expand Up @@ -1891,7 +1891,7 @@ No snippets.
"opencensus": {
"$ref": "#/$defs/OpenCensusMetricProducer",
"deprecated": true,
"description": "Configure metric producer to be opencensus.\n\n**Deprecated** as of June 2026. The OpenCensus compatibility\nspecification it relies on was deprecated in\nhttps://github.com/open-telemetry/opentelemetry-specification/pull/5138.\nSDKs MAY continue to support this entry for backwards compatibility;\nnew configurations SHOULD NOT use it.\nIf omitted, ignore.\n"
"description": "Configure metric producer to be opencensus.\n\n**Deprecated** as of v1.2.0, may be removed in v2.0.0. The OpenCensus\ncompatibility specification it relies on was deprecated in\nhttps://github.com/open-telemetry/opentelemetry-specification/pull/5138.\nSDKs MAY continue to support this entry for backwards compatibility;\nnew configurations SHOULD NOT use it.\nIf omitted, ignore.\n"
}
}
}</pre>
Expand Down Expand Up @@ -2029,7 +2029,7 @@ No snippets.
],
"additionalProperties": false,
"deprecated": true,
"description": "**Deprecated** as of June 2026. The OpenCensus compatibility specification\nit relies on was deprecated in\nhttps://github.com/open-telemetry/opentelemetry-specification/pull/5138.\nSee also the\n[OpenCensus sunset announcement](https://opentelemetry.io/blog/2023/sunsetting-opencensus/).\n"
"description": "**Deprecated** as of v1.2.0, may be removed in v2.0.0. The OpenCensus\ncompatibility specification it relies on was deprecated in\nhttps://github.com/open-telemetry/opentelemetry-specification/pull/5138.\nSee also the\n[OpenCensus sunset announcement](https://opentelemetry.io/blog/2023/sunsetting-opencensus/).\n"
}</pre>
</details>

Expand Down
8 changes: 4 additions & 4 deletions schema/meter_provider.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,8 @@ $defs:
description: |
Configure metric producer to be opencensus.

**Deprecated** as of June 2026. The OpenCensus compatibility
specification it relies on was deprecated in
**Deprecated** as of v1.2.0, may be removed in v2.0.0. The OpenCensus
compatibility specification it relies on was deprecated in
https://github.com/open-telemetry/opentelemetry-specification/pull/5138.
SDKs MAY continue to support this entry for backwards compatibility;
new configurations SHOULD NOT use it.
Expand All @@ -250,8 +250,8 @@ $defs:
additionalProperties: false
deprecated: true
description: |
**Deprecated** as of June 2026. The OpenCensus compatibility specification
it relies on was deprecated in
**Deprecated** as of v1.2.0, may be removed in v2.0.0. The OpenCensus
compatibility specification it relies on was deprecated in
https://github.com/open-telemetry/opentelemetry-specification/pull/5138.
See also the
[OpenCensus sunset announcement](https://opentelemetry.io/blog/2023/sunsetting-opencensus/).
Expand Down
Loading