Assumption

EntityDraftv1.0.0-rc.2

An assumption: a fact that an evaluation takes as true without evidence, such as an operating state or the weather, with the reason for it.

https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Assumption.json

Fields

Every entity also has the fields of the Entity base. The first row lists them.

From the Entity baseidnamedescriptionidentifierslinkscreatedAtupdatedAt
  • idRequired
    textnot empty

    The record's id: unique within the document. Fields that point at the record hold this id.

  • name
    text

    The name people use for the record.

  • description
    text

    What the record is, in words.

  • identifiers
    List ofDatatypeIdentifier

    Ids the record has in other systems.

  • links
    List ofDatatypeLink

    Open-ended links to other records.

  • createdAt
    date-time (RFC 3339)

    When the record was created, in its producer's system.

  • updatedAt
    date-time (RFC 3339)

    When the record last changed, in its producer's system.

  • subject
    Id ofany record

    The id of the record the assumption is about.

  • properties
    List ofPartProperty

    The facts assumed.

  • state
    Id ofOperating state

    The operating state assumed.

  • basis
    text

    Why the assumption holds.

  • citation
    DatatypeCitation

    The published work that allows the assumption.

Links

Points at Records whose ids this record holds, with the field that holds each.

Held by Records that embed this one, with their field that holds it.

Pointed at by Records that hold this one's id, with their field that holds it.

Examples

An id that another example defines opens that record.

Full example

{
  "id": "assumption-downwind",
  "name": "Downwind at night",
  "subject": "feature-dwelling",
  "properties": [
    {
      "type": "wind_speed",
      "value": {
        "amount": 2,
        "unit": "m/s"
      }
    }
  ],
  "basis": "The directive asks for the worst case, which is downwind with a light wind.",
  "citation": {
    "title": "Directive 038: Noise Control",
    "section": "Appendix 2"
  }
}
Show 1 more example

Minimal example: the required fields only

{
  "id": "assumption-1"
}

Changes and file

Changes

  1. 0.1.0 First version.

Schema file

Show the JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Assumption.json",
  "title": "Assumption",
  "description": "An assumption: a fact that an evaluation takes as true without evidence, such as an operating state or the weather, with the reason for it.",
  "$ref": "Entity.json",
  "type": "object",
  "properties": {
    "subject": {
      "type": "string",
      "description": "The id of the record the assumption is about.",
      "minLength": 1,
      "x-ods-ref": "*"
    },
    "properties": {
      "type": "array",
      "items": {
        "$ref": "Property.json"
      },
      "description": "The facts assumed."
    },
    "state": {
      "type": "string",
      "minLength": 1,
      "x-ods-ref": "OperatingState",
      "description": "The operating state assumed."
    },
    "basis": {
      "type": "string",
      "description": "Why the assumption holds."
    },
    "citation": {
      "$ref": "Citation.json",
      "description": "The published work that allows the assumption."
    }
  },
  "patternProperties": {
    "^x-": {}
  },
  "unevaluatedProperties": false,
  "examples": [
    {
      "id": "assumption-1"
    },
    {
      "id": "assumption-downwind",
      "name": "Downwind at night",
      "subject": "feature-dwelling",
      "properties": [
        {
          "type": "wind_speed",
          "value": {
            "amount": 2,
            "unit": "m/s"
          }
        }
      ],
      "basis": "The directive asks for the worst case, which is downwind with a light wind.",
      "citation": {
        "title": "Directive 038: Noise Control",
        "section": "Appendix 2"
      }
    }
  ],
  "x-ods-status": "draft",
  "x-ods-kind": "entity",
  "x-ods-module": "core",
  "x-ods-changes": {
    "0.1.0": "First version."
  }
}