openapi/statuslist-management-components.yml at develop · Sphereon-Opensource/openapi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
openapi: 3.0.4
info:
  title: Status List Management API Components
  version: 0.1.0
  description: Entity schemas, enums, and path parameters for the Status List Management REST API.
paths: {}
components:
  parameters:
    StatusListId:
      name: id
      in: path
      required: true
      description: Technical id of the status list.
      schema:
        type: string

  schemas:
    StatusListSpec:
      type: string
      description: The credential status-list specification.
      enum: [token_status_list, bitstring_status_list]

    StatusProofFormat:
      type: string
      description: Proof envelope securing the status-list token.
      enum: [jwt, cwt, vc+jwt]

    StatusPurpose:
      type: string
      description: Status purpose carried by the list.
      enum: [revocation, suspension, message, refresh]

    StatusListSummary:
      type: object
      description: Lightweight projection for list endpoints (no embedded token).
      required:
        - id
        - correlationId
        - spec
        - purposes
        - proofFormat
        - bitsPerStatus
        - length
        - issuedCount
        - remainingCapacity
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        correlationId:
          type: string
        spec:
          $ref: '#/components/schemas/StatusListSpec'
        purposes:
          type: array
          items:
            $ref: '#/components/schemas/StatusPurpose'
        proofFormat:
          $ref: '#/components/schemas/StatusProofFormat'
        bitsPerStatus:
          type: integer
        length:
          type: integer
        issuedCount:
          type: integer
        remainingCapacity:
          type: integer
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time

    StatusListEntry:
      type: object
      description: A single allocated entry within a status list.
      required: [statusListId, statusListIndex, value, purpose]
      properties:
        statusListId:
          type: string
        statusListIndex:
          type: integer
        entryCorrelationId:
          type: string
          nullable: true
        credentialId:
          type: string
          nullable: true
        credentialHash:
          type: string
          nullable: true
        value:
          type: integer
          description: Current status value (0 = VALID, 1 = INVALID, 2 = SUSPENDED).
        purpose:
          $ref: '#/components/schemas/StatusPurpose'