core/software-1.0.0

Describes a software package.

Description

General-purpose description of a software package.

Outline

Schema Definitions

This type is an object with the following properties:
  • name
    stringRequired
    The name of the application or library.

    No length restriction
  • author
    string
    The author (or institution) that produced the software package.

    No length restriction
  • homepage
    string
    A URI to the homepage of the software.

    No length restriction
  • version
    stringRequired
    The version of the software used. It is recommended, but not required, that this follows the (Semantic Versioning Specification)[http://semver.org/spec/v2.0.0.html].

    No length restriction

Original Schema

%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://stsci.edu/schemas/asdf/core/software-1.0.0"
title: |
  Describes a software package.
description: |
  General-purpose description of a software package.

type: object
properties:
  name:
    description: |
      The name of the application or library.
    type: string

  author:
    description: |
      The author (or institution) that produced the software package.
    type: string

  homepage:
    description: |
      A URI to the homepage of the software.
    type: string
    format: uri

  version:
    description: |
      The version of the software used.  It is recommended, but not
      required, that this follows the (Semantic Versioning
      Specification)[http://semver.org/spec/v2.0.0.html].
    type: string

required: [name, version]
additionalProperties: true
...