Skip to content

Commit d1a5175

Browse files
weiivweiiv
authored
docs: revise status-list examples (#2342)
Signed-off-by: Ivan Wei <[email protected]>
1 parent 987547d commit d1a5175

File tree

8 files changed

+22
-27
lines changed

8 files changed

+22
-27
lines changed

‎oid4vc/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Documentation for the [Status List Plugin] (https://github.com/openwallet-founda
7676
```
7777
OID4VCI_STATUS_HANDLER: status_list.v1_0.status_handler
7878
STATUS_LIST_SIZE: 131072
79-
STATUS_LIST_SHARD_SIZE: 131072
79+
STATUS_LIST_SHARD_SIZE: 1024
8080
STATUS_LIST_PUBLIC_URI: https://localhost:8082/tenant/{tenant_id}/status/{list_number}
8181
STATUS_LIST_FILE_PATH: /tmp/bitstring/{tenant_id}/{list_number}
8282
```
@@ -90,8 +90,8 @@ Documentation for the [Status List Plugin] (https://github.com/openwallet-founda
9090
```
9191
{
9292
"issuer_did": "did....",
93+
"list_type": "w3c",
9394
"list_size": 131072,
94-
"list_type": "ietf",
9595
"shard_size": 1024,
9696
"status_message": [
9797
{
@@ -103,7 +103,7 @@ Documentation for the [Status List Plugin] (https://github.com/openwallet-founda
103103
"message": "revoked"
104104
},
105105
],
106-
"status_purpose": "revocation",
106+
"status_purpose": "message",
107107
"status_size": 1,
108108
"supported_cred_id": "string",
109109
"verification_method": "did...."

‎status_list/status_list/v1_0/controllers/status_list_def.py‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,6 @@ class CreateStatusListDefRequest(OpenAPISchema):
5151
"example": [
5252
{"status": "0x00", "message": "active"},
5353
{"status": "0x01", "message": "revoked"},
54-
{"status": "0x10", "message": "pending"},
55-
{"status": "0x11", "message": "suspended"},
5654
],
5755
},
5856
)
@@ -86,16 +84,15 @@ class CreateStatusListDefRequest(OpenAPISchema):
8684
required=False,
8785
metadata={
8886
"description": "Issuer DID for the status list",
89-
"example": "did:web:dev.lab.di.gov.on.ca",
87+
"example": "did:web:example.com",
9088
},
9189
)
9290
verification_method = fields.Str(
9391
required=False,
9492
metadata={
9593
"description": "Issuer DID for the status list",
9694
"example": (
97-
"did:web:dev.lab.di.gov.on.ca#"
98-
"z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"
95+
"did:web:example.com#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"
9996
),
10097
},
10198
)
@@ -316,16 +313,15 @@ class UpdateStatusListDefRequest(OpenAPISchema):
316313
required=False,
317314
metadata={
318315
"description": "Issuer DID for the status list",
319-
"example": "did:web:dev.lab.di.gov.on.ca",
316+
"example": "did:web:example.com",
320317
},
321318
)
322319
verification_method = fields.Str(
323320
required=False,
324321
metadata={
325322
"description": "Issuer DID for the status list",
326323
"example": (
327-
"did:web:dev.lab.di.gov.on.ca#"
328-
"z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"
324+
"did:web:example.com#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"
329325
),
330326
},
331327
)

‎status_list/status_list/v1_0/models.py‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,16 +233,15 @@ class Meta:
233233
required=False,
234234
metadata={
235235
"description": "Issuer DID for the status list",
236-
"example": "did:web:dev.lab.di.gov.on.ca",
236+
"example": "did:web:example.com",
237237
},
238238
)
239239
verification_method = fields.Str(
240240
required=False,
241241
metadata={
242242
"description": "Issuer DID for the status list",
243243
"example": (
244-
"did:web:dev.lab.di.gov.on.ca#"
245-
"z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"
244+
"did:web:example.com#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL"
246245
),
247246
},
248247
)

‎status_list/status_list/v1_0/tests/conftest.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def plugin_settings():
4444
"status_list": {
4545
"list_size": "131072",
4646
"shard_size": "1024",
47-
"public_uri": "https://status.di.gov.on.ca/tenants/{tenant_id}/status/{list_number}",
47+
"public_uri": "https://status.example.com/tenants/{tenant_id}/status/{list_number}",
4848
"file_path": "/tmp/bitstring/{tenant_id}/{list_number}",
4949
}
5050
}
@@ -92,7 +92,7 @@ async def init(context: AdminRequestContext):
9292
method=WEB,
9393
key_type=ED25519,
9494
seed="testseed000000000000000000000001",
95-
did="did:web:dev.lab.di.gov.on.ca",
95+
did="did:web:example.com",
9696
)
9797
yield
9898

@@ -108,8 +108,8 @@ def status_list_def():
108108
list_size=131072,
109109
list_number="0",
110110
next_list_number="0",
111-
issuer_did="did:web:dev.lab.di.gov.on.ca",
112-
verification_method="did:web:dev.lab.di.gov.on.ca#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL",
111+
issuer_did="did:web:example.com",
112+
verification_method="did:web:example.com#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL",
113113
id="definition_id",
114114
new_with_id=True,
115115
)
@@ -131,8 +131,8 @@ def status_list_def_msg():
131131
list_size=16,
132132
list_number="0",
133133
next_list_number="0",
134-
issuer_did="did:web:dev.lab.di.gov.on.ca",
135-
verification_method="did:web:dev.lab.di.gov.on.ca#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL",
134+
issuer_did="did:web:example.com",
135+
verification_method="did:web:example.com#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL",
136136
id="definition_msg_id",
137137
new_with_id=True,
138138
)

‎status_list/status_list/v1_0/tests/controllers/test_status_list_def.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ async def test_status_list_def_routes(
5252
{"status": "0x11", "message": "suspended"},
5353
],
5454
"supported_cred_id": "supported_cred_id",
55-
"list_type": "ietf",
56-
"issuer_did": "did:web:dev.lab.di.gov.on.ca",
57-
"verification_method": "did:web:dev.lab.di.gov.on.ca#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL",
55+
"list_type": "w3c",
56+
"issuer_did": "did:web:example.com",
57+
"verification_method": "did:web:example.com#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL",
5858
}
5959
await controller.create_status_list_def(request)
6060
async with context.profile.session() as session:

‎status_list/status_list/v1_0/tests/controllers/test_status_list_pub.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ async def test_status_list_pub_routes(context: AdminRequestContext, seed_db):
4444
headers={},
4545
json=AsyncMock(
4646
return_value={
47-
"did": "did:web:dev.lab.di.gov.on.ca",
48-
"verification_method": "did:web:dev.lab.di.gov.on.ca#3Dn1SJNPaCXcvvJvSbsFWP2xaCjMom3can8CQNhWrTRx",
47+
"did": "did:web:example.com",
48+
"verification_method": "did:web:example.com#3Dn1SJNPaCXcvvJvSbsFWP2xaCjMom3can8CQNhWrTRx",
4949
}
5050
),
5151
)

‎status_list/status_list/v1_0/tests/controllers/test_status_list_shard.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ async def test_get_status_list(context: AdminRequestContext, seed_db):
6363
request = MagicMock(
6464
app={},
6565
match_info={"def_id": "definition_id", "list_num": "0"},
66-
query={}, # {"issuer_did": "did:web:dev.lab.di.gov.on.ca"},
66+
query={}, # {"issuer_did": "did:web:example.com"},
6767
__getitem__=lambda _, k: request_dict[k],
6868
headers={},
6969
json={},

‎status_list/status_list/v1_0/tests/test_jwt.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ async def test_jwt(context):
1212
context.profile,
1313
headers=headers,
1414
payload=payload,
15-
verification_method="did:web:dev.lab.di.gov.on.ca#3Dn1SJNPaCXcvvJvSbsFWP2xaCjMom3can8CQNhWrTRx",
15+
verification_method="did:web:example.com#3Dn1SJNPaCXcvvJvSbsFWP2xaCjMom3can8CQNhWrTRx",
1616
)
1717
assert jwt

0 commit comments

Comments
 (0)