Replace version in definition schema with file_format by lmolkova · Pull Request #1154 · open-telemetry/weaver

lmolkova · 2026-01-23T23:12:28Z

Align definition schema marker with resolved schema introduced in #1136

Extracted from #1106

codecov · 2026-01-23T23:23:23Z

Codecov Report

❌ Patch coverage is 84.69388% with 15 lines in your changes missing coverage. Please review.
✅ Project coverage is 80.4%. Comparing base (8b71168) to head (df096eb).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
crates/weaver_semconv/src/semconv.rs	88.2%	10 Missing ⚠️
crates/weaver_resolver/src/loader.rs	50.0%	5 Missing ⚠️

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #1154   +/-   ##
=====================================
  Coverage   80.4%   80.4%           
=====================================
  Files        110     110           
  Lines       9009    9021   +12     
=====================================
+ Hits        7245    7258   +13     
+ Misses      1764    1763    -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

crates/weaver_forge/data/registry/http.yaml

crates/weaver_semconv/src/semconv.rs

jsuereth

Overall looks good, two major questions:

One on errors and what they look like wrapped now
Another on whether we should update the file format error message

crates/weaver_semconv/src/lib.rs

Copilot

Pull request overview

This PR replaces the version field with file_format in the definition schema to align with the resolved schema introduced in PR #1136. This is a breaking change that affects how version 2 semantic convention files are identified.

Changes:

Updated field name from version: "2" to file_format: definition/2 for v2 schema files
Added backward compatibility support to accept the deprecated version field with a warning
Updated JSON schema from draft-07 to draft 2020-12 with modern syntax ($defs instead of definitions, const instead of single-value enum)
Split schema validators to handle v1 and v2 separately for better error messages

Reviewed changes

Copilot reviewed 25 out of 25 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
tests/v2_forge/model/test.yaml	Updated to use `file_format: definition/2`
tests/v2_check_before_resolution/test.yaml	Updated to use `file_format: definition/2`, removed trailing whitespace
tests/v2_check_baseline/next/test.yaml	Updated to use `file_format: definition/2`, removed trailing whitespace
tests/v2_check_baseline/base/test.yaml	Updated to use `file_format: definition/2`, removed trailing whitespace
tests/v2_check/model/test.yaml	Updated to use `file_format: definition/2`, removed trailing whitespace
schemas/semconv.schema.v2.json	Updated to JSON Schema draft 2020-12, modernized syntax with `$defs` and `const`
schemas/semconv-syntax.v2.md	Updated documentation to reflect `file_format: definition/2` usage
schemas/semconv-syntax.md	Minor formatting improvements in table of contents
crates/weaver_semconv/src/semconv.rs	Core logic for handling both old and new format, deprecation warnings, and custom deserialization
crates/weaver_semconv/src/registry.rs	Updated to use separate validators for v1 and v2
crates/weaver_semconv/src/lib.rs	Added new error types for deprecated field and invalid format
crates/weaver_semconv/src/json_schema.rs	Removed `new_versioned()`, exposed `new_for()` as public
crates/weaver_semconv/README.md	Updated terminology from "YAML language" to "Definition language"
crates/weaver_resolver/src/registry.rs	Updated test to ignore new deprecation warning
crates/weaver_resolver/src/loader.rs	Updated to use separate validators for v1 and v2
crates/weaver_resolver/data/registry-test-v2-3-both-version/registry/*.yaml	Updated test files to use `file_format: definition/2`
crates/weaver_resolver/data/registry-test-v2-2-multifile/registry/*.yaml	Updated test files to use `file_format: definition/2`
crates/weaver_resolver/data/registry-test-v2-1-everything/registry/http.yaml	Updated test file to use `file_format: definition/2`
crates/weaver_resolver/data/registry-test-16-attr-conflict/registry/test-16.yaml	Updated test file to use `file_format: definition/2`
crates/weaver_forge/data/registry/http.yaml	Still uses deprecated `version: "2"` - may be intentional for backward compatibility testing
CHANGELOG.md	Added breaking change entry (contains a typo)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

CHANGELOG.md

crates/weaver_semconv/src/semconv.rs

crates/weaver_forge/data/registry/http.yaml

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

jsuereth

Still rust structural concerns. I'm going to check this out locally and take a look, then come back with any hard suggestions (or a PR against your PR).

crates/weaver_semconv/src/semconv.rs

jsuereth · 2026-02-23T21:31:24Z

:edited: Add main as of today.

Overall, I'm not happy with the error messages here, example:

ℹ No registry manifest found: dummy-repo/registry_manifest.yaml

Diagnostic report:

  × "Missing required property: \"type\".\n\nMissing required property: \"brief\".\n\nMissing required property: \"stability\".\n\nMissing required property: \"instrument\".
  │ \n\nMissing required property: \"unit\".\n\nMissing required property: \"brief\".\n\nMissing required property: \"stability\"."

Here's main:

Diagnostic report:

  × Value {"attributes":[{"key":"Hello"}],"metrics":[{"attributes":[{"ref":"Hello"}],"name":"test"}],"version":"2"} does not match any schema in a 'oneOf' group; it must match
  │ exactly one.
  │ (Variant 1):
  │ - Value "2" does not match the required constant: "1".
  │ - Object contains unexpected properties: attributes, metrics. These properties are not defined in the schema.
  │ (Variant 2):
  │ - Missing required property: "type".
  │ - Missing required property: "brief".
  │ - Missing required property: "stability".
  │ - Missing required property: "instrument".
  │ - Missing required property: "unit".
  │ - Missing required property: "brief".
  │ - Missing required property: "stability".

…weaver into definition-file-format

lmolkova · 2026-02-24T16:58:17Z

@jsuereth I refactored it quite a bit now, but I did not solve messages problem. I also don't believe I made it worse and it seems to produce the same as the released version. Mind sharing the tyaml you're running?

I don't mind fixing it at all, but if it's not introduced in this PR, I'd rather do it separately :)

jsuereth · 2026-02-24T19:26:28Z

@lmolkova I'll take a look, and the formatting I was able to confirm head vs. this PR that this PR was the cause as of yesterday. I'll re-evaluate the updates, thanks for taking a look!

crates/weaver_resolver/src/loader.rs

crates/weaver_semconv/src/json_schema.rs

jsuereth

I'm good with this as an interim state we'll clean up.

I'm not super happy with creating temp files, but it's just for tests. That could be cleaned up, but we can do so later.
The code is a LOT easier to read now, thank you. Think we should be able to maintain this for the time it takes to migrate to v2.

crates/weaver_semconv/src/semconv.rs

CHANGELOG.md

lmolkova requested a review from a team as a code owner January 23, 2026 23:12

lmolkova requested a review from a team as a code owner January 23, 2026 23:31

lmolkova mentioned this pull request Jan 24, 2026

Add doc summarizing info on v2 schemas #1106

Open

jsuereth reviewed Jan 25, 2026

View reviewed changes

crates/weaver_forge/data/registry/http.yaml Outdated Show resolved Hide resolved

jsuereth reviewed Jan 25, 2026

View reviewed changes

crates/weaver_semconv/src/semconv.rs Outdated Show resolved Hide resolved

lmolkova added 5 commits February 9, 2026 14:54

Change version -> file_format: definition/2.0.0

5ce7e02

changelog

fe0cdbe

up

2379e6c

regenerate v2 json schema

9cad2e0

definition/2.0.0 -> definition/2, semver does not make sense

3b3e3c2

lmolkova force-pushed the definition-file-format branch from f400877 to 3b3e3c2 Compare February 9, 2026 23:22

lmolkova added 2 commits February 12, 2026 17:35

support version: 2 as well

b369d9a

cleanup

9e5e2dd

jsuereth reviewed Feb 18, 2026

View reviewed changes

crates/weaver_semconv/src/semconv.rs Outdated Show resolved Hide resolved

lmolkova added this to OTel Weaver Project Feb 18, 2026

lmolkova moved this to To consider for the next release in OTel Weaver Project Feb 18, 2026

jsuereth moved this from To consider for the next release to Next Release in OTel Weaver Project Feb 18, 2026

jsuereth reviewed Feb 19, 2026

View reviewed changes

crates/weaver_semconv/src/lib.rs Outdated Show resolved Hide resolved

lmolkova added 3 commits February 21, 2026 11:05

Merge branch 'main' into definition-file-format

16a4fb6

add warning for version

973d80f

merge deserialization and from file logic

b492683

lmolkova requested a review from Copilot February 22, 2026 00:14

Copilot started reviewing on behalf of lmolkova February 22, 2026 00:15 View session

Copilot AI reviewed Feb 22, 2026

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

crates/weaver_semconv/src/semconv.rs Show resolved Hide resolved

crates/weaver_forge/data/registry/http.yaml Show resolved Hide resolved

Update CHANGELOG.md

94409f6

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

jsuereth reviewed Feb 23, 2026

View reviewed changes

crates/weaver_semconv/src/semconv.rs Outdated Show resolved Hide resolved

crates/weaver_semconv/src/semconv.rs Outdated Show resolved Hide resolved

crates/weaver_semconv/src/semconv.rs Outdated Show resolved Hide resolved

lmolkova added 2 commits February 23, 2026 19:14

Merge branch 'main' into definition-file-format

081cc59

make SemConvSpec not deserializeable, refactor

a8f7ddd

lmolkova added 2 commits February 24, 2026 08:19

Merge branch 'definition-file-format' of https://github.com/lmolkova/…

2a09a95

…weaver into definition-file-format

refactor more: remove SemConvSpec - not needed

b35d598

github-advanced-security bot found potential problems Feb 24, 2026

View reviewed changes

crates/weaver_resolver/src/loader.rs Fixed Show fixed Hide fixed

crates/weaver_resolver/src/loader.rs Fixed Show fixed Hide fixed

a bit more cleanup

86df809

lmolkova force-pushed the definition-file-format branch from 60a70c1 to 86df809 Compare February 24, 2026 21:07

lmolkova added 2 commits February 24, 2026 13:07

Merge branch 'main' into definition-file-format

708e716

don't escape formatted compound error message

9649a7c

github-advanced-security bot found potential problems Feb 24, 2026

View reviewed changes

lint

6c6c36b

jsuereth approved these changes Feb 25, 2026

View reviewed changes

crates/weaver_semconv/src/semconv.rs Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

lmolkova added 2 commits February 25, 2026 10:35

Merge branch 'main' into definition-file-format

b14e1e2

comments and changelog

a778a09

jsuereth enabled auto-merge (squash) February 25, 2026 20:10

jsuereth and others added 2 commits February 25, 2026 15:10

Merge branch 'main' into definition-file-format

8626f50

Merge branch 'main' into definition-file-format

df096eb

jsuereth merged commit 28f8003 into open-telemetry:main Feb 26, 2026
22 checks passed

github-project-automation bot moved this from Next Release to Done in OTel Weaver Project Feb 26, 2026

Conversation

lmolkova commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jsuereth left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jsuereth left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jsuereth commented Feb 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lmolkova commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jsuereth commented Feb 24, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jsuereth left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lmolkova commented Jan 23, 2026 •

edited

Loading

codecov bot commented Jan 23, 2026 •

edited

Loading

jsuereth commented Feb 23, 2026 •

edited

Loading

lmolkova commented Feb 24, 2026 •

edited

Loading