Skip to content

Observatory ProtocolNode registryData consumer application

Data consumer application

An application or person reading governed products through the exchange plane, and honouring correction notices on what it has read.

Version
0.1.0-draft
Status
Draft specification
Specification
CC BY 4.0
Code
Apache-2.0
Steward
GCRI Canada
Source
obsp-0.1-foundation

Role

Consumer role. (OBSP 0.1 §3) Consumers subscribed to a product MUST receive the correction notice. (OBSP 0.1 §5.9) The exchange plane is read-only toward sites. (OBSP 0.1 §5.10)

Class
Data consumers
Applications and people that read governed products.
Protocol role
CONSUMER Consumer. (OBSP 0.1 §3)
Conformance profile
OBSP-CONSUMER Application reading products. In this profile, correct here means subscribing to and honouring correction notices (OBSP 0.1 §7.1)

Interfaces

The planes and bindings this type uses. Bindings are normative for OBSP 0.1; radio and link layers follow their own standards. (OBSP 0.1 §6)

InterfaceBindingSources
ExchangeOpenAPI 3.1, OGC API, SensorThings, STAC and WIS 2.0(OBSP 0.1 §6; OpenAPI 3.1; OGC API; OGC SensorThings API; STAC; WMO WIS 2.0)
EventsCloudEvents 1.0; channels in AsyncAPI 3(OBSP 0.1 §6; CloudEvents 1.0; AsyncAPI 3.0)

Schemas it emits and accepts

Each document is a JSON Schema 2020-12 contract. Open one in the schema explorer. (JSON Schema 2020-12) Every request, command and event also carries a request context. (OBSP 0.1 §4.3)

Emits

None in OBSP 0.1.

Accepts

Lifecycle and conformance

OBSP-CONSUMER 2 of 12 functions. (OBSP 0.1 §7.1) A level is reached only with the evidence it names. (OBSP 0.1 §7.2)

5.1Join5.2Admit5.3Describe5.4Time5.5Observe5.6Qualify5.7Federate5.8Orchestrate5.9Correct5.10Exchange5.11Prove5.12Exit and decommission
The twelve stages of the lifecycle. The stages in the type's profile are marked.

Conformance cases that apply

CaseWhat it testsKindEvidence
CT-CONSUMER-001Exchange: the products read are described by product manifestsschemaproduct-manifest
CT-CONSUMER-002Correct: correction notices received are well formedinvariantcorrection-notice
CT-CONSUMER-003Correct: the application honours correction noticesmanual

Run these cases in the onboarding check

Levels

Declared
Signed self-declaration naming profile, version and scope.
Self-tested
Conformance report (obsp conformance run) produced by the participant, with digests of the tested artifacts.
Lab-tested
Conformance report (obsp conformance run) and lab test record from a qualified lab.
Qualified
Lab report plus field observation for the declared scope and a qualification-record.
Suspended
Suspension notice with reason.
Withdrawn
Withdrawal notice.

Identity, attestation and security

Requirements of the security model that apply to this role. (OBSP 0.1 §8)

Architecture
Zero trust (NIST SP 800-207): every request is authenticated, authorised and logged; network position grants nothing (OBSP 0.1 §8)
Workload identity
SPIFFE-style SVIDs, rotated; no shared secrets (OBSP 0.1 §8)
Supply chain
SBOM, SLSA provenance, signed artifacts, TUF update metadata, SUIT for firmware (OBSP 0.1 §8)
Privacy
Observation data that can identify a person is a declared data class with its own policy; default is not to collect it (OBSP 0.1 §8)

Interoperability profile and standards

The primary standards this type draws on. Alignment with a standard is stated as alignment. It is not an approval by the standards body. (OBSP 0.1 §13)

Not yet defined

What the protocol does not define for this type in version 0.1, stated as the specification states it. Nothing here is filled in from elsewhere.

  • Read APIs and OGC endpoints are an open gap in OBSP 0.1 (G-EXCH-1). (OBSP 0.1 §9)
  • G-EXCH-1 Observation, product and catalogue read APIs and OGC endpoints (Exchange). (OBSP 0.1 §9)

Across the consortium

Related pages on the consortium's other networks, in their own words.

StandardsNexus Standards
Open standards to identify, describe, verify and cite risk information, which observations bound by the protocol can carry.Early Warning and Anticipatory ActionHazards and Disaster Risk ReductionCommunities, Learning and ContributionIndustry, Trade and Supply ChainsData and EvidenceClimate and Earth SystemsEnergy and Critical Infrastructure
IndexThe Global Risks Index
Country risk indicators that observations with provenance and quality can inform.risksindex.com
AcademyRisk Academy
Training for implementers and operators of observing systems.risksacademy.com
ReportsReports at Nexus Standards
Published evidence with provenance, citation and corrections.nexustandards.com/nexus-reports

References

Sources cited on this page, in order of first citation. Addresses were last checked on the date shown.

  1. OBSP 0.1 §3: Participant roles Observatory Protocol 0.1 (draft), CC BY 4.0.
  2. OBSP 0.1 §5.9: Correct Observatory Protocol 0.1 (draft), CC BY 4.0.
  3. OBSP 0.1 §5.10: Exchange Observatory Protocol 0.1 (draft), CC BY 4.0.
  4. OBSP 0.1 §7.1: Profiles Observatory Protocol 0.1 (draft), CC BY 4.0.
  5. OBSP 0.1 §6: Wire bindings Observatory Protocol 0.1 (draft), CC BY 4.0.
  6. OpenAPI 3.1 OpenAPI Specification 3.1.0 spec.openapis.org/oas/v3.1.0 Checked
  7. OGC API OGC API family of standards ogcapi.ogc.org/ Checked
  8. OGC SensorThings API OGC SensorThings API www.ogc.org/standards/sensorthings/ Checked
  9. STAC SpatioTemporal Asset Catalog specification stacspec.org/ Checked
  10. WMO WIS 2.0 WMO Information System community.wmo.int/en/activity-areas/wis Checked
  11. CloudEvents 1.0 CloudEvents specification cloudevents.io/ Checked
  12. AsyncAPI 3.0 AsyncAPI specification 3.0.0 www.asyncapi.com/docs/reference/specification/v3.0.0 Checked
  13. JSON Schema 2020-12 JSON Schema draft 2020-12 json-schema.org/draft/2020-12 Checked
  14. OBSP 0.1 §4.3: Request context Observatory Protocol 0.1 (draft), CC BY 4.0.
  15. OBSP 0.1 §7.2: Conformance levels Observatory Protocol 0.1 (draft), CC BY 4.0.
  16. OBSP 0.1 §8: Security model Observatory Protocol 0.1 (draft), CC BY 4.0.
  17. OBSP 0.1 §13: Sovereign deployment for every operator and environment Observatory Protocol 0.1 (draft), CC BY 4.0.
  18. OBSP 0.1 §9: Gaps register Observatory Protocol 0.1 (draft), CC BY 4.0.