Flatten schema pkg

CHANGELOG.md

@@ -10,13 +10,22 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ### Added
 
+- The `Parse` and `ParseFile` functions are added to `go.opentelemetry.io/otel/schema` to replace the ones formerly found in `go.opentelemetry.io/otel/schema/v1.0` and `go.opentelemetry.io/otel/schema/v1.1`. (#4538)
+- The `Schema` and its related types are added to `go.opentelemetry.io/otel/schema` to replace the ones formerly found in `go.opentelemetry.io/otel/schema/v1.0` and `go.opentelemetry.io/otel/schema/v1.1`. (#4538)
 - Add `WithEndpointURL` option to the `exporters/otlp/otlpmetric/otlpmetricgrpc`, `exporters/otlp/otlpmetric/otlpmetrichttp`, `exporters/otlp/otlptrace/otlptracegrpc` and `exporters/otlp/otlptrace/otlptracehttp` packages. (#4808)
 
 ### Fixed
 
 - Fix `ContainerID` resource detection on systemd when cgroup path has a colon. (#4449)
 - Fix `go.opentelemetry.io/otel/sdk/metric` to cache instruments to avoid leaking memory when the same instrument is created multiple times. (#4820)
 
+### Removed
+
+- The `go.opentelemetry.io/otel/schema/v1.0` package.
+  Use the similar functions and types added to `go.opentelemetry.io/otel/schema` instead. (#4538)
+- The `go.opentelemetry.io/otel/schema/v1.1` package.
+  Use the equivalent functions and types added to `go.opentelemetry.io/otel/schema` instead. (#4538)
+
 ## [1.23.0-rc.1] 2024-01-18
 
 This is a release candidate for the v1.23.0 release.

schema/v1.0/types/types.go → schema/example_test.go

@@ -12,16 +12,24 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package types // import "go.opentelemetry.io/otel/schema/v1.0/types"
+package schema
 
-// TelemetryVersion is a version number key in the schema file (e.g. "1.7.0").
-type TelemetryVersion string
+import (
+	"fmt"
+	"log"
+)
 
-// SpanName is span name string.
-type SpanName string
+const path = "./testdata/valid-example.yaml"
 
-// EventName is an event name string.
-type EventName string
+func ExampleParseFile() {
+	s, err := ParseFile(path)
+	if err != nil {
+		log.Fatal(err)
+	}
 
-// MetricName is a metric name string.
-type MetricName string
+	fmt.Println("file format:", s.FileFormat)
+	fmt.Println("schema URL:", s.SchemaURL)
+	// Output:
+	// file format: 1.1.0
+	// schema URL: https://opentelemetry.io/schemas/1.1.0
+}

schema/parser.go

@@ -0,0 +1,56 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Package schema provides types and utilities used to interact with
+// [OpenTelemetry schema files].
+//
+// [OpenTelemetry schema files]: https://github.com/open-telemetry/opentelemetry-specification/blob/007f415120090972e22a90afd499640321f160f3/specification/schemas/file_format_v1.1.0.md
+package schema // import "go.opentelemetry.io/otel/schema"
+
+import (
+	"io"
+	"os"
+
+	"gopkg.in/yaml.v3"
+)
+
+// ParseFile parses a Schema from the schema file found at path.
+func ParseFile(path string) (*Schema, error) {
+	file, err := os.Open(path)
+	if err != nil {
+		return nil, err
+	}
+	return Parse(file)
+}
+
+// Parse parses a Schema read from r.
+//
+// If r contains a Schema with a file format version outside FileFormatRange,
+// an error will be returned.
+//
+// If r contains an invalid schema URL an error will be returned.
+func Parse(r io.Reader) (*Schema, error) {
+	d := yaml.NewDecoder(r)
+	d.KnownFields(true)
+
+	var s Schema
+	if err := d.Decode(&s); err != nil {
+		return nil, err
+	}
+
+	if err := s.validate(); err != nil {
+		return nil, err
+	}
+	return &s, nil
+}