meta

README

SDK metadata schemas

This directory contains JSON schemas for metadata files added to SDKs. These schemas are included in SDKs under //meta/schemas.

Versioning

In order to help consumers of the SDK adjust to metadata changes, each SDK embeds an opaque version number for its metadata schema. This version number is specified in version.gni and can be found in SDKs in //meta/manifest.json.

Changes to schemas that require some consumer action should be accompanied by an increment of this version number. Such changes include:

• adding a new property;
• changing a property from required to optional;
• renaming a property;
• changing a property's type;
• adding a schema for a new SDK element type.

Testing

Run unit tests with:

fx test host_x64/sdk_metadata_lib_test

Documentation

Index

• Constants
• func ValidateProductBundleContainer(pbmContainer ProductBundleContainer) error
• type Data
• type ProductBundleContainer

Constants

const (
	PBMContainerSchemaID = "http://fuchsia.com/schemas/sdk/" + pbmContainerFileName
)

Functions

func ValidateProductBundleContainer

func ValidateProductBundleContainer(pbmContainer ProductBundleContainer) error

ValidateProductBundleContainer validates that the data is a valid based on product_bundle_container-76a5c104.json schema.

Types

type Data

type Data struct {
	Bundles []artifactory.ProductBundle `json:"bundles"`
	Type    string                      `json:"type"`
	Name    string                      `json:"name"`
}

type ProductBundleContainer

type ProductBundleContainer struct {
	SchemaID string `json:"schema_id"`
	Data     Data   `json:"data"`
}