Contract and client context

Operation: update_entry · HTTP: PUT /v1/entries/{did}

Use an operator-supplied registry base URL. Request execution is disabled in this documentation explorer. Generated request snippets are templates, not signed or authorized submissions.

Exact operation definition

{
  "operationId": "update_entry",
  "parameters": [
    {
      "description": "OAS DID of the entry",
      "in": "path",
      "name": "did",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "Required route-scoped idempotency key",
      "in": "header",
      "name": "Idempotency-Key",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/MarsEntry"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MarsEntry"
          }
        }
      },
      "description": "Entry updated"
    },
    "400": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Entry validation failed"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "SIWS session missing or invalid"
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Session publisher mismatch"
    },
    "404": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Entry not found"
    },
    "409": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Sequence or lifecycle conflict"
    },
    "429": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ErrorResponse"
          }
        }
      },
      "description": "Write rate limit exceeded"
    }
  },
  "security": [
    {
      "siwsSession": []
    },
    {
      "siwsCookie": []
    }
  ],
  "tags": [
    "entries"
  ]
}

Resolve schema references against the complete OpenAPI document. Standalone schemas and hashes are generated from the same checked-in source.

PUT/v1/entries/{did}

Authorization

AuthorizationBearer <token>

Opaque capability-bearing MARS session issued by an enabled authentication profile.

In: header

Header Parameters

Idempotency-Key*string

Required route-scoped idempotency key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A complete MARS registry entry (MARS Specification Section 5).

This is the canonical on-wire and at-rest representation of every artifact registered in the MARS ecosystem. Required fields are always present; optional fields are omitted from JSON when None or empty.

Validation

Call validate to check structural invariants before signing or persisting.

Examples

use mars_protocol::entry::{MarsEntry, EntryType};let entry: MarsEntry = serde_json::from_str(r#"{ ... }"#)?;entry.validate()?;# Ok::<(), Box<dyn std::error::Error>>(())

accessPolicy?null|

anchorState?AnchorState

Registry-managed anchor projection for the current immutable snapshot.

This field is excluded from the publisher signing payload and can only be advanced by the registry's durable anchor outbox.

Value in

"unanchored"
"pending"
"submitted"
"confirmed"
"failed"
"abandoned"

bondReference?null|

customMetadata?|

Arbitrary extension metadata.

description?|

Human-readable description (max 4096 characters).

entryDid*string

The OAS DID uniquely identifying this entry.

entryType*EntryType

The primary entry type (one of 10 OAS kinds).

Value in

"AgentDefinition"
"ToolDefinition"
"SkillDefinition"
"WorkflowDefinition"
"ModelDefinition"
"DatasetDefinition"
"ServiceDefinition"
"OrganizationDefinition"
"HumanRootRecord"
"MultiHumanRootRecord"
"MapPlugin"
"MapPluginRelease"
"MapIntegrationSchema"
"MapPluginCollection"

itemData*unknown

The entry payload conforming to item_schema_uri.

itemDataHash*string

Content hash of item_data in sha256:<hex> format.

itemSchemaUri*string

URI of the JSON Schema that item_data conforms to.

lifecycleStatus?LifecycleStatus

Current lifecycle status (defaults to Active).

Value in

"draft"
"active"
"deprecated"
"archived"
"revoked"
"experimental"

lineageReference?null|

marsVersion*string

MARS protocol version. Must be "1.0.0".

name*string

Human-readable name (max 256 characters).

publishedAt*string

Timestamp of initial publication.

Formatdate-time

publisherDid*string

DID of the publishing entity.

relationships?array<>

Typed relationships to other entries.

semanticAnnotations?array<>

RDF-style semantic annotations.

sequence?integer

Monotonically increasing counter for replay protection.

Formatint64

Range0 <= value

serviceEndpoints?array<>

Service endpoints for OpenAgent resolution.

Per the MARS/OpenAgent Endpoint Contract (v1.0.0), entries MAY declare transport endpoints. Day-one clients consume only https endpoints; weave and wss entries are stored for forward compatibility.

shardAssignment?|

MARS shard assignment (from gal topology map).

signature*

Cryptographic signature over the canonical entry content.

tags?array<string>

Discovery tags.

updatedAt?|

Timestamp of the most recent update.

Formatdate-time

verifiableAttestations?array<unknown>

Verifiable attestations (opaque JSON; validated at a higher layer).

version*string

Semantic version of this entry.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/entries/string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "entryDid": "string",    "entryType": "AgentDefinition",    "itemData": null,    "itemDataHash": "string",    "itemSchemaUri": "string",    "marsVersion": "string",    "name": "string",    "publishedAt": "2019-08-24T14:15:22Z",    "publisherDid": "string",    "signature": {      "algorithm": "string",      "keyId": "string",      "value": "string"    },    "version": "string"  }'

{  "accessPolicy": null,  "anchorState": "unanchored",  "bondReference": null,  "customMetadata": {    "property1": null,    "property2": null  },  "description": "string",  "entryDid": "string",  "entryType": "AgentDefinition",  "itemData": null,  "itemDataHash": "string",  "itemSchemaUri": "string",  "lifecycleStatus": "draft",  "lineageReference": null,  "marsVersion": "string",  "name": "string",  "publishedAt": "2019-08-24T14:15:22Z",  "publisherDid": "string",  "relationships": [    {      "label": "string",      "relationshipType": "dependsOn",      "targetDid": "string"    }  ],  "semanticAnnotations": [    {      "objectLiteral": "string",      "objectUri": "string",      "predicateUri": "string"    }  ],  "sequence": 0,  "serviceEndpoints": [    {      "id": "string",      "priority": 0,      "properties": {        "property1": null,        "property2": null      },      "type": "string",      "url": "string"    }  ],  "shardAssignment": "string",  "signature": {    "algorithm": "string",    "created": "string",    "keyId": "string",    "value": "string"  },  "tags": [    "string"  ],  "updatedAt": "2019-08-24T14:15:22Z",  "verifiableAttestations": [    null  ],  "version": "string"}

Update entry

Contract and client context

Authorization

Path Parameters

Header Parameters

Request Body

Validation

Examples

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Update entry

Contract and client context

Authorization

Path Parameters

Header Parameters

Request Body

Validation

Examples

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`