Skjölun

Grunnskilgreining hugtaks er sett fram á YAML skrársniði. Þær upplýsingar sem fram koma á þessum síðum eru myndaðar sjálfkrafa út frá grunnskilgreiningum hugtakalíkana auk nánari útskýringum sem skrifaðar eru af sérfræðingum fagsviða..

Uppbygging skráningar

Hvert hugtak er skráð í sérstakri YAML-skrá. Efsti hluti skrárinnar lýsir hugtakinu sjálfu, en neðri hlutinn inniheldur lista yfir eigindi.

id: 92c13ab0-31ec-4f3c-806e-3cd4b2a679af
label: Bygging
name: Bygging
definition: Bygging er mannvirki með nýtanlegt rými ...
description: ""
abbreviation: BYG

properties:
  - id: f15fc5b6-b9c2-4050-8ed4-c352fed7a9c2
    label: Kerfisauðkenni
    name: ByggingId
    shortName: bygid
    ...

Útgáfustýring

Útgáfunúmer fylgja merkingarlegu kerfi á forminu (MAJOR.MINOR.PATCH):

  • MAJOR — Þegar skilgreining breytist á þann hátt að breyting veldur röskum sem krefst endurskoðunar á þeim afurðum sem byggja á skilgreiningunni.

  • MINOR — Nýtt hugtak eða nýr eiginleiki bætist við sem veldur ekki röskun á hugmyndafræði.

  • PATCH — Lagfæring eða skýring sem breytir ekki merkingu

Þrjú stig mynda stigveldi:

  • Útgáfa skjölunar — Heildarútgáfa skjölunar. Uppfærist þegar eitthvað umdæmi breytist, eða við aðrar lagfæringar á skjölun. Birt í fæti hverrar síðu.

  • Útgáfa umdæmis — útgáfa einstakra umdæma. Uppfærist þegar hugtak í umdæminu breytist.

  • Útgáfa hugtaks — útgáfa einstakra hugtaka. Uppfærist við hverja breytingu á hugtaki.

Uppfærsla berst upp á við: breyting á hugtaki uppfærir umdæmið, og uppfærsla á umdæmi uppfærir útgáfu skjölunar.

Vefþjónusta

Upplýsingar hugtakalíkans eru aðgengileg í gegnum vefþjónustu. Vefþjónustan leyfir tæknifólki og kerfum að fletta upp hugtökum og eiginleikum, sækja umdæmi á YAML sniði, og staðfesta skráningar á móti skema hugtakalíkana.

Uppfletting

Hægt er að fletta upp umdæmum, hugtökum og eiginleikum eftir nafni eða auðkenni:

  • GET /domain — listi yfir skráð umdæmi

  • GET /domain/{umdæmi} — lýsigögn umdæmis

  • GET /domain/{umdæmi}/concept — listi yfir hugtök umdæmis

  • GET /domain/{umdæmi}/concept/{hugtak} — skilar hugtaki eftir nafni eða UUID

  • GET /domain/{umdæmi}/concept/{hugtak}/property — skilar eiginleikum hugtaks

Niðurhal

Hægt er að sækja öll hugtak í umdæmi sem YAML- eða Excel-skrár:

  • GET /domain/{umdæmi}/export/yaml — ZIP-skrá með einni YAML-skrá fyrir hvert hugtak

  • GET /domain/{umdæmi}/export/xlsx — Excel-vinnubók með einum flipa fyrir hvert hugtak

Umbreyting

Stuðningur við Excel-vinnuluflæði — hlaða niður, breyta í Excel og umbreyta yfir í YAML snið:

  • POST /domain/convert/xlsx/yaml — Excel → staðfærðar YAML-skrár (ZIP)

  • POST /domain/convert/yaml/xlsx — YAML-skrár eða ZIP → Excel-vinnubók

Villuprófun og skemastaðfesting

  • POST /validate — sannreyna YAML-skrá á móti skema

  • GET /schema — skema sem grunnskránning hugtakalíkana á YAML sniði eru sannreyndar á móti

Ábendingar og breytingarbeiðnir

Spurningar og tillögur má sendar á hms@hms.is.