iscc-schema 0.3.1

OpenAPI representation of the ISCC data model

ISCC - Schema

OpenAPI representation of the ISCC data model

Introduction

This repository hosts all schema definitions of the ISCC. Schemas are defined in OpenAPI v3.1.0 format and serve as a single source of truth for auto-generated JSON Schema definitions, JSON-LD contexts, and other schema related artifacts.

Documentation

Documentation is hosted at schema.iscc.codes

Status

Under development. Expect breaking changes until we reach a version 1.0 release.

Generated files

The source of code generation are the files at iscc_schema/models/*. The outputs produced when running poe build are:

• docs/schema/iscc.json - JSON Schema for ISCC Metadata
• docs/schema/index.md - JSON Schema Markdown documentation
• docs/context/iscc.jsonld - JSON-LD context for ISCC Metadata
• docs/terms/index.md - ISCC Metadata Vocabulary documentation
• iscc_schema/schema.py - Pydantic models for ISCC Metadata
• iscc_schema/generator.py - Pydantic models for Generator Service API

Published files

The generated files are published under the following canonical URLs:

• http://purl.org/iscc/schema - JSON Schema latest version
• http://purl.org/iscc/context - JSON-LD Context latest version
• http://purl.org/iscc/terms - ISCC Metadata Vocabulary latest version
• http://pypi.org/project/iscc-schema - Python package with pydantic models

OpenAPI Docs

• ISCC Generator Service

OpenAPI Extensions

The OpenAPI Specification allows for extending the specification with custom fields. Extensions must start with x-. All ISCC extensions start with x-iscc-:

• x-iscc-context - for documenting JSON-LD contexts.
• x-iscc-schema-doc - for original descriptions from schema.org.
• x-iscc-embed - for information on how to embed fields into media assets.

Changelog

0.3.1 - 2022-02-10

• Fixed packaging error

0.3.0 - 2022-02-10

• Added draft API for ISCC Generator Service
• Added new collection schema
• Updated dependencies
• Added new terms: verify, original, redirect

0.2.1 - 2022-01-19

• Tweak code generator
• Cleanup dependencies

0.2.0 - 2022-01-17

• Added generator field
• Changed properties field to support base64
• Changed iscc validation to support Semantic-Code

0.1.0 - 2022-01-05

• Initial release