Schemas / BIM / OpenBIM

rig.bim.comment

v0.31.0 · draft 5 fields 2 required

Fields

FieldTypeMeaning
topic entity required Parent rig.bim.topic
body string required Comment text
author string optional Optional. Author; absent = unset
createdAt string optional Optional. Creation time (ISO-8601); absent = unset
viewpoint entity optional Optional. Linked rig.bim.viewpoint; absent = none

BCF comment on a topic. Format when present.

JSON Schema

Resolves at https://rig.works/schemas/rig.bim.comment.schema.jsonraw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.bim.comment.schema.json",
  "title": "rig.bim.comment",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "topic": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "body": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "author": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "createdAt": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "viewpoint": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    }
  },
  "required": [
    "topic",
    "body"
  ]
}

Seen in

bim-bcf.json