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
CONSUMERConsumer. (OBSP 0.1 §3)- Conformance profile
OBSP-CONSUMERApplication reading products. In this profile, correct here means subscribing to and honouring correction notices (OBSP 0.1 §7.1)- Technology domains
- Data, pipelines and exchange, GIS, maps and twins
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)
| Interface | Binding | Sources |
|---|---|---|
| Exchange | OpenAPI 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) |
| Events | CloudEvents 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
product-manifestProductManifestcorrection-noticeCorrectionNoticeevent-envelopeEventEnvelopeprovenanceProvenance
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)
| Clause | Stage | In OBSP-CONSUMER | Contract |
|---|---|---|---|
| §5.1 | Join | No | Contracted |
| §5.2 | Admit | No | Contracted |
| §5.3 | Describe | No | Contracted |
| §5.4 | Time | No | Contracted |
| §5.5 | Observe | No | Contracted |
| §5.6 | Qualify | No | Contracted |
| §5.7 | Federate | No | Open gap G-FED-1 |
| §5.8 | Orchestrate | No | Open gap G-ORCH-1 |
| §5.9 | Correct | Yes | Contracted |
| §5.10 | Exchange | Yes | Open gap G-EXCH-1 |
| §5.11 | Prove | No | Open gap G-PROVE-1 |
| §5.12 | Exit and decommission | No | Contracted |
Conformance cases that apply
| Case | What it tests | Kind | Evidence |
|---|---|---|---|
| CT-CONSUMER-001 | Exchange: the products read are described by product manifests | schema | product-manifest |
| CT-CONSUMER-002 | Correct: correction notices received are well formed | invariant | correction-notice |
| CT-CONSUMER-003 | Correct: the application honours correction notices | manual |
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)
- OpenAPI 3.1OpenAPI Specification 3.1.0(OpenAPI 3.1)
- OGC APIOGC API family of standards(OGC API)
- OGC SensorThings APIOGC SensorThings API(OGC SensorThings API)
- STACSpatioTemporal Asset Catalog specification(STAC)
- WMO WIS 2.0WMO Information System(WMO WIS 2.0)
- CloudEvents 1.0CloudEvents specification(CloudEvents 1.0)
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-1Observation, 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.
- 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
- Index
- Country risk indicators that observations with provenance and quality can inform.risksindex.com
- Academy
- Training for implementers and operators of observing systems.risksacademy.com
- Reports
- 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.
- OBSP 0.1 §3: Participant roles Observatory Protocol 0.1 (draft), CC BY 4.0.
- OBSP 0.1 §5.9: Correct Observatory Protocol 0.1 (draft), CC BY 4.0.
- OBSP 0.1 §5.10: Exchange Observatory Protocol 0.1 (draft), CC BY 4.0.
- OBSP 0.1 §7.1: Profiles Observatory Protocol 0.1 (draft), CC BY 4.0.
- OBSP 0.1 §6: Wire bindings Observatory Protocol 0.1 (draft), CC BY 4.0.
- OpenAPI 3.1 OpenAPI Specification 3.1.0 spec.openapis.org/oas/v3.1.0 Checked
- OGC API OGC API family of standards ogcapi.ogc.org/ Checked
- OGC SensorThings API OGC SensorThings API www.ogc.org/standards/sensorthings/ Checked
- STAC SpatioTemporal Asset Catalog specification stacspec.org/ Checked
- WMO WIS 2.0 WMO Information System community.wmo.int/en/activity-areas/wis Checked
- CloudEvents 1.0 CloudEvents specification cloudevents.io/ Checked
- AsyncAPI 3.0 AsyncAPI specification 3.0.0 www.asyncapi.com/docs/reference/specification/v3.0.0 Checked
- JSON Schema 2020-12 JSON Schema draft 2020-12 json-schema.org/draft/2020-12 Checked
- OBSP 0.1 §4.3: Request context Observatory Protocol 0.1 (draft), CC BY 4.0.
- OBSP 0.1 §7.2: Conformance levels Observatory Protocol 0.1 (draft), CC BY 4.0.
- OBSP 0.1 §8: Security model Observatory Protocol 0.1 (draft), CC BY 4.0.
- OBSP 0.1 §13: Sovereign deployment for every operator and environment Observatory Protocol 0.1 (draft), CC BY 4.0.
- OBSP 0.1 §9: Gaps register Observatory Protocol 0.1 (draft), CC BY 4.0.