@metalabel/dfos-protocol 0.0.2 → 0.1.0

package/openapi.yaml

@@ -1,376 +0,0 @@
-openapi: 3.1.0
-info:
-  title: DFOS Protocol Registry
-  version: 0.1.0
-  description: |
-    Minimal registry API for the DFOS Protocol. Provides chain submission,
-    resolution, and paginated operation history for identity chains and content
-    chains. Linear chain enforcement — accepts same or longer chains, rejects forks.
-
-    This spec defines the interoperability surface. Any implementation serving
-    these endpoints with these semantics is a compatible DFOS registry.
-
-servers:
-  - url: /
-    description: Registry root
-
-# ---------------------------------------------------------------------------
-
-paths:
-  /identities:
-    post:
-      operationId: submitIdentityChain
-      summary: Submit or extend an identity chain
-      description: |
-        Verifies the chain, derives the DID from the genesis CID, and stores it.
-        - 201: chain accepted (new or extended)
-        - 200: chain already stored (noop)
-        - 400: invalid chain (verification failed)
-        - 409: chain conflicts with stored chain (fork)
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/SubmitChainRequest'
-      responses:
-        '201':
-          description: Chain accepted
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/IdentityState'
-        '200':
-          description: Chain already stored (noop)
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/IdentityState'
-        '400':
-          description: Invalid chain
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        '409':
-          description: Fork conflict
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-
-  /identities/{did}:
-    get:
-      operationId: resolveIdentity
-      summary: Resolve current identity state
-      parameters:
-        - $ref: '#/components/parameters/did'
-      responses:
-        '200':
-          description: Verified identity state
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/IdentityState'
-        '404':
-          description: Identity not found
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-
-  /identities/{did}/operations:
-    get:
-      operationId: listIdentityOperations
-      summary: List identity chain operations (newest-first, paginated)
-      parameters:
-        - $ref: '#/components/parameters/did'
-        - $ref: '#/components/parameters/cursor'
-        - $ref: '#/components/parameters/limit'
-      responses:
-        '200':
-          description: Paginated operation list
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/PaginatedOperations'
-        '404':
-          description: Identity not found
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-
-  /entities:
-    post:
-      operationId: submitContentChain
-      summary: Submit or extend a content chain
-      description: |
-        Verifies the chain (resolving signing keys from stored identity chains),
-        derives the entity ID from the genesis CID, and stores it.
-        Same status code semantics as identity submission.
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/SubmitChainRequest'
-      responses:
-        '201':
-          description: Chain accepted
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/EntityState'
-        '200':
-          description: Chain already stored (noop)
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/EntityState'
-        '400':
-          description: Invalid chain
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        '409':
-          description: Fork conflict
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-
-  /entities/{entityId}:
-    get:
-      operationId: resolveEntity
-      summary: Resolve current entity state
-      parameters:
-        - $ref: '#/components/parameters/entityId'
-      responses:
-        '200':
-          description: Entity state
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/EntityState'
-        '404':
-          description: Entity not found
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-
-  /entities/{entityId}/operations:
-    get:
-      operationId: listEntityOperations
-      summary: List content chain operations (newest-first, paginated)
-      parameters:
-        - $ref: '#/components/parameters/entityId'
-        - $ref: '#/components/parameters/cursor'
-        - $ref: '#/components/parameters/limit'
-      responses:
-        '200':
-          description: Paginated operation list
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/PaginatedOperations'
-        '404':
-          description: Entity not found
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-
-  /operations/{cid}:
-    get:
-      operationId: resolveOperation
-      summary: Resolve a single operation by CID
-      parameters:
-        - $ref: '#/components/parameters/cid'
-      responses:
-        '200':
-          description: Operation found
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Operation'
-        '404':
-          description: Operation not found
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-
-# ---------------------------------------------------------------------------
-
-components:
-  parameters:
-    did:
-      name: did
-      in: path
-      required: true
-      schema:
-        type: string
-        pattern: '^did:dfos:[2346789acdefhknrtvz]{22}$'
-      example: 'did:dfos:e3vvtck42d4eacdnzvtrn6'
-
-    entityId:
-      name: entityId
-      in: path
-      required: true
-      schema:
-        type: string
-        pattern: '^[2346789acdefhknrtvz]{22}$'
-      example: '67t27rzc83v7c22n9t6z7c'
-
-    cid:
-      name: cid
-      in: path
-      required: true
-      schema:
-        type: string
-      example: 'bafyreieseogefhfjajtkzqq6ssq63nnt7bslwca7d5wbrfbdlhld5jos6i'
-
-    cursor:
-      name: cursor
-      in: query
-      required: false
-      description: Opaque pagination cursor (CID of last item on previous page)
-      schema:
-        type: string
-
-    limit:
-      name: limit
-      in: query
-      required: false
-      description: Page size (1-100, default 25)
-      schema:
-        type: integer
-        minimum: 1
-        maximum: 100
-        default: 25
-
-  schemas:
-    SubmitChainRequest:
-      type: object
-      required: [chain]
-      properties:
-        chain:
-          type: array
-          minItems: 1
-          items:
-            type: string
-            description: JWS compact token
-          description: |
-            Ordered array of JWS compact tokens, genesis-first.
-            The registry verifies the chain and either accepts (same or longer
-            than stored) or rejects (fork or invalid).
-
-    MultikeyPublicKey:
-      type: object
-      required: [id, type, publicKeyMultibase]
-      properties:
-        id:
-          type: string
-          example: 'key_ref_controller_01'
-        type:
-          type: string
-          enum: [Multikey]
-        publicKeyMultibase:
-          type: string
-          description: W3C Multikey encoded Ed25519 public key (z6Mk... prefix)
-          example: 'z6MkveUvhr2oyjZGmP4kHgsPSSa6t9mG9pWuPsYoGn2CzQ6o'
-
-    IdentityState:
-      type: object
-      required: [did, isDeleted, authKeys, assertKeys, controllerKeys]
-      properties:
-        did:
-          type: string
-          example: 'did:dfos:e3vvtck42d4eacdnzvtrn6'
-        isDeleted:
-          type: boolean
-        authKeys:
-          type: array
-          items:
-            $ref: '#/components/schemas/MultikeyPublicKey'
-        assertKeys:
-          type: array
-          items:
-            $ref: '#/components/schemas/MultikeyPublicKey'
-        controllerKeys:
-          type: array
-          items:
-            $ref: '#/components/schemas/MultikeyPublicKey'
-
-    EntityState:
-      type: object
-      required: [entityId, isDeleted, currentDocumentCID, genesisCID, headCID]
-      properties:
-        entityId:
-          type: string
-          example: '67t27rzc83v7c22n9t6z7c'
-        isDeleted:
-          type: boolean
-        currentDocumentCID:
-          type: string
-          nullable: true
-          description: CID of current document (null if cleared or deleted)
-        genesisCID:
-          type: string
-          description: CID of the genesis operation
-        headCID:
-          type: string
-          description: CID of the most recent operation
-
-    OperationEntry:
-      type: object
-      required: [cid, jwsToken, createdAt]
-      properties:
-        cid:
-          type: string
-          description: dag-cbor CID of the operation payload
-        jwsToken:
-          type: string
-          description: JWS compact token (the signed operation)
-        createdAt:
-          type: string
-          format: date-time
-          description: ISO 8601 timestamp from the operation payload
-
-    PaginatedOperations:
-      type: object
-      required: [operations, nextCursor]
-      properties:
-        operations:
-          type: array
-          items:
-            $ref: '#/components/schemas/OperationEntry'
-          description: Operations ordered newest-first
-        nextCursor:
-          type: string
-          nullable: true
-          description: |
-            Opaque cursor for the next page. Null when there are no more pages.
-            Pass as ?cursor=xxx on the next request.
-
-    Operation:
-      type: object
-      required: [cid, jwsToken]
-      properties:
-        cid:
-          type: string
-        jwsToken:
-          type: string
-
-    Error:
-      type: object
-      required: [error, message]
-      properties:
-        error:
-          type: string
-          enum: [BAD_REQUEST, NOT_FOUND, CONFLICT]
-        message:
-          type: string

package/schemas/document-envelope.v1.json

@@ -1,37 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://schemas.dfos.com/document-envelope/v1",
-  "title": "Document Envelope",
-  "description": "Standard wrapper for content committed to by content chains. The documentCID in a content chain operation is CID(dagCborEncode(envelope)).",
-  "type": "object",
-  "required": ["content", "baseDocumentCID", "createdByDID", "createdAt"],
-  "properties": {
-    "content": {
-      "type": "object",
-      "required": ["$schema"],
-      "properties": {
-        "$schema": {
-          "type": "string",
-          "format": "uri",
-          "description": "URI identifying the JSON Schema that validates this content."
-        }
-      },
-      "description": "Application-defined content payload. Opaque to chains — validated by the schema identified in $schema."
-    },
-    "baseDocumentCID": {
-      "type": ["string", "null"],
-      "description": "CID of the previous document version (edit lineage), or null for the first version."
-    },
-    "createdByDID": {
-      "type": "string",
-      "pattern": "^did:",
-      "description": "DID of the identity that created this document version."
-    },
-    "createdAt": {
-      "type": "string",
-      "format": "date-time",
-      "description": "ISO 8601 timestamp of document creation."
-    }
-  },
-  "additionalProperties": false
-}