Struct OasDocument 

pub struct OasDocument {

    pub context: Vec<String>,
    pub id: String,
    pub controller: String,
    pub verification_method: Vec<VerificationMethod>,
    pub authentication: Vec<String>,
    pub assertion_method: Vec<String>,
    pub capability_invocation: Vec<String>,
    pub capability_delegation: Vec<String>,
    pub service: Vec<ServiceEndpoint>,
    pub oas_version: String,
    pub kind: String,
    pub name: Option<String>,
    pub description: Option<String>,
    pub lineage: Option<LineageSection>,
    pub governance: Option<GovernanceSection>,
    pub conformance_level: ConformanceLevel,
    pub lifecycle_status: Option<LifecycleStatus>,
    pub sequence: u64,
    pub metadata: DocumentMetadata,
    pub proof: Option<DocumentProof>,
    pub revoked: Option<bool>,
    pub revoked_at: Option<String>,
    pub profile: Option<ProfileSection>,
    pub contact: Option<ContactSection>,
    pub calendar: Option<CalendarSection>,
    pub operational: Option<OperationalSection>,
    pub pricing: Option<PricingSection>,
    pub interoperability: Option<InteroperabilitySection>,
    pub reputation: Option<ReputationSection>,
    pub compliance: Option<ComplianceSection>,
    pub relationships: Option<RelationshipsSection>,
}

An OAS Identity Document as defined in OAS Specification §5.

This is the canonical representation of an autonomous entity’s identity, extending the W3C DID Document with OAS-specific properties.

Examples

use oas_document::OasDocument;

let json = r#"{
  "@context": ["https://www.w3.org/ns/did/v1", "https://w3id.org/security/suites/ed25519-2020/v1", "https://openagent.id/ns/oas/v1"],
  "id": "did:oas:test:hmr:alice",
  "controller": "did:oas:test:hmr:alice",
  "verificationMethod": [{"id": "did:oas:test:hmr:alice#key-1", "type": "Ed25519VerificationKey2020", "controller": "did:oas:test:hmr:alice", "publicKeyMultibase": "zTest"}],
  "authentication": ["did:oas:test:hmr:alice#key-1"],
  "oasVersion": "1.0.0",
  "kind": "hmr",
  "conformanceLevel": "L1",
  "sequence": 1,
  "metadata": {"created": "2026-01-15T00:00:00Z"}
}"#;
let doc: OasDocument = serde_json::from_str(json).unwrap();
assert_eq!(doc.id, "did:oas:test:hmr:alice");

Fields

context: Vec<String>

JSON-LD contexts. MUST include the OAS context.

id: String

The did:oas identifier.

controller: String

DID of the controlling entity.

verification_method: Vec<VerificationMethod>

At least one Ed25519VerificationKey2020.

authentication: Vec<String>

References to keys authorized for authentication.

assertion_method: Vec<String>

References to keys authorized for assertions.

capability_invocation: Vec<String>

References to keys authorized for capability invocation.

capability_delegation: Vec<String>

References to keys authorized for capability delegation.

service: Vec<ServiceEndpoint>

Service endpoints.

oas_version: String

OAS specification version (currently "1.0.0").

kind: String

Entity kind from the taxonomy.

name: Option<String>

Human-readable name (max 256 chars).

description: Option<String>

Human-readable description (max 4096 chars).

lineage: Option<LineageSection>

Lineage information (required for L1+ non-root entities).

governance: Option<GovernanceSection>

Governance section (ENR entities only). Tracks which MHR governs this enterprise identity, epoch, and transition history.

conformance_level: ConformanceLevel

Conformance level: L0, L1, or L2.

lifecycle_status: Option<LifecycleStatus>

Lifecycle status.

sequence: u64

Monotonically increasing version counter (starting at 1).

metadata: DocumentMetadata

Document metadata.

proof: Option<DocumentProof>

Document proof (Ed25519Signature2020).

revoked: Option<bool>

Whether this identity has been revoked.

revoked_at: Option<String>

Timestamp of revocation.

profile: Option<ProfileSection>

Profile / presentation data (§5.8): avatar, tagline, categories.

contact: Option<ContactSection>

Contact directory (§5.9): phones, emails, socials, websites.

calendar: Option<CalendarSection>

Calendar & scheduling (§5.10): booking links, office hours.

operational: Option<OperationalSection>

Operational specification (§5.11): SLA, rate limits, formats.

pricing: Option<PricingSection>

Pricing & economics (§5.12): cost model, billing, free tier.

interoperability: Option<InteroperabilitySection>

Interoperability (§5.13): protocols, API schemas, auth methods.

reputation: Option<ReputationSection>

Reputation summary (§5.14): interactions, endorsements, uptime.

compliance: Option<ComplianceSection>

Compliance & jurisdiction (§5.15): certifications, policy URLs.

relationships: Option<RelationshipsSection>

Relationships & affiliations (§5.16): org structure, partnerships.

Implementations

impl OasDocument

pub fn default_context() -> Vec<String>

Returns the default JSON-LD context array for OAS documents.

pub fn is_root(&self) -> bool

Returns true if this document represents a root entity (HMR, MHR, or ENR).

pub fn is_revoked(&self) -> bool

Returns true if this document has been revoked.

pub fn primary_public_key_multibase(&self) -> Option<&str>

Returns the primary public key multibase string, if available.

Looks for the first verification method’s public key.

pub fn find_verification_method( &self, id_or_fragment: &str, ) -> Option<&VerificationMethod>

Finds a verification method by its full ID or fragment.

Trait Implementations

impl Clone for OasDocument

fn clone(&self) -> OasDocument

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OasDocument

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OasDocument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OasDocument

fn eq(&self, other: &OasDocument) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for OasDocument

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OasDocument