📝 Update Waypoint doc & SSE docstring

[cl0ete]

Refactor Webhooks.md into Waypoint.md

Update docstrings for the one SSE endpoint in app

[github-actions]

K8s Test Coverage

File	Stmts	Miss	Cover	Missing
app
main.py	78	2	97%	117–118
app/routes
jsonld.py	60	47	22%	23–93, 104–137
messaging.py	24	11	54%	43–52, 85–95
oob.py	46	28	39%	58–99, 131–144, 170–181
trust_registry.py	62	2	97%	52–53
verifier.py	139	33	76%	88–90, 95, 152–154, 159, 231, 239–241, 246, 288–293, 299–301, 362–364, 369, 406–408, 413, 449–451, 505–507
app/routes/wallet
credentials.py	77	52	32%	32–45, 54–66, 75–86, 95–109, 120–136, 148–162, 171–183, 192–203
jws.py	42	27	36%	35–60, 76–99
sd_jws.py	42	27	36%	36–61, 78–101
app/services
acapy_ledger.py	61	12	80%	110–111, 124–140, 196–197
acapy_wallet.py	40	4	90%	60–61, 98–99
revocation_registry.py	166	35	79%	118–160, 201–205, 360–364, 403–408, 441–445, 473–478, 527–528
app/services/issuer
acapy_issuer_v2.py	101	12	88%	63, 97–106, 110, 126–127, 173, 227–228, 255
app/services/onboarding
tenants.py	63	49	22%	30–103, 113–143
verifier.py	37	3	92%	67, 83–87
app/services/onboarding/util
register_issuer_did.py	86	3	97%	100–102
set_endorser_metadata.py	72	40	44%	28–30, 50–52, 76–78, 109–128, 140–151, 163–176, 189–203
app/services/trust_registry
actors.py	107	9	92%	95–100, 110, 209–210, 212–217, 282–285
schemas.py	54	9	83%	57–63, 89–99
app/services/trust_registry/util
actor.py	31	2	94%	26–27
issuer.py	23	4	83%	39–40, 48–49
app/tests/e2e
conftest.py	23	5	78%	46–54
test_connections.py	149	2	99%	281–282
test_jsonld.py	59	16	73%	134–169
test_proof_request_models.py	24	1	96%	101
test_tenants.py	421	15	96%	203, 247–248, 287, 789, 833–834, 843–844, 853–854, 866–867, 876–877
test_wallet_credentials.py	30	1	97%	55
test_wallet_dids.py	70	10	86%	101–116
app/tests/e2e/issuer
test_get_records_paginated.py	63	2	97%	65–66
test_save_exchange_record.py	72	1	99%	166
app/tests/e2e/verifier
test_get_records_paginated.py	62	2	97%	59–60
test_many_revocations.py	61	40	34%	31–107, 117–128, 139–214
test_proof_revoked_credential.py	44	12	73%	127–199
test_verifier.py	224	12	95%	661–731
app/tests/exception_handling
test_handle_model_with_validation.py	23	1	96%	22
app/tests/fixtures
credentials.py	120	37	69%	173, 268–348, 361–432
definitions.py	66	26	61%	29–50, 64–65, 94–124, 143–144
member_acapy_clients.py	36	4	89%	47–50, 73–74
member_connections.py	43	8	81%	80–91, 130–141
member_wallets.py	61	15	75%	29–34, 49–54, 69–74, 89–94, 111–118
app/tests/routes/issuer
test_create_offer.py	39	1	97%	145
test_send_credential.py	36	1	97%	125
app/tests/routes/wallet/dids
test_get_public_did.py	29	1	97%	40
app/tests/services
test_revocation_registry.py	141	2	99%	74, 105
app/tests/services/issuer
test_issuer.py	123	2	98%	281–285
app/tests/util
connections.py	87	29	67%	104–129, 138–155, 172–181, 236–256
ledger.py	50	10	80%	35, 43, 55, 63–67, 77, 83
regression_testing.py	35	17	51%	33, 41–68, 74–81
sse_listener.py	28	4	86%	51–56
trust_registry.py	29	3	90%	24, 27–28
webhooks.py	53	15	72%	19, 65–81, 88–90, 95, 119
app/util
acapy_verifier_utils.py	123	5	96%	81–84, 164–168, 245
assert_public_did.py	18	8	56%	17–33
credentials.py	14	2	86%	13, 18
retry_method.py	36	15	58%	20–35, 76–77, 91–103
tenants.py	45	17	62%	24–29, 44–45, 52–59, 90–91, 97, 124
transaction_acked.py	14	2	86%	31–32
endorser
main.py	37	1	97%	55
endorser/services
endorsement_processor.py	94	2	98%	110–111
endorser/tests
test_util_endorsement.py	144	5	97%	286, 291, 350–352
endorser/util
endorsement.py	68	7	90%	134–146
trustregistry
main.py	82	4	95%	46–48, 110
trustregistry/tests
test_main.py	137	1	99%	90
waypoint
main.py	48	1	98%	64
waypoint/tests/routers
test_waypoint_sse.py	83	5	94%	61–62, 119, 136, 171
waypoint/tests/services
test_nats_service.py	116	3	97%	45, 133, 155
TOTAL	12071	784	94%

Tests	Skipped	Failures	Errors	Time
796	5 💤	0 ❌	0 🔥	2m 44s ⏱️

[github-actions]

K8s Regression Test Coverage

File	Stmts	Miss	Cover	Missing
app
main.py	78	2	97%	117–118
app/routes
jsonld.py	60	47	22%	23–93, 104–137
messaging.py	24	11	54%	43–52, 85–95
oob.py	46	28	39%	58–99, 131–144, 170–181
trust_registry.py	62	2	97%	52–53
verifier.py	139	33	76%	88–90, 95, 152–154, 159, 231, 239–241, 246, 288–293, 299–301, 362–364, 369, 406–408, 413, 449–451, 505–507
app/routes/wallet
credentials.py	77	52	32%	32–45, 54–66, 75–86, 95–109, 120–136, 148–162, 171–183, 192–203
jws.py	42	27	36%	35–60, 76–99
sd_jws.py	42	27	36%	36–61, 78–101
app/services
acapy_ledger.py	61	19	69%	43–49, 79, 110–111, 124–140, 146–149, 196–197
acapy_wallet.py	40	12	70%	49–64, 98–99
revocation_registry.py	166	46	72%	118–160, 201–205, 360–364, 403–408, 441–445, 463–478, 484–493, 527–528
app/services/issuer
acapy_issuer_v2.py	101	12	88%	63, 97–106, 110, 126–127, 173, 227–228, 255
app/services/onboarding
tenants.py	63	49	22%	30–103, 113–143
verifier.py	37	3	92%	67, 83–87
app/services/onboarding/util
register_issuer_did.py	86	3	97%	100–102
set_endorser_metadata.py	72	40	44%	28–30, 50–52, 76–78, 109–128, 140–151, 163–176, 189–203
app/services/trust_registry
actors.py	107	9	92%	95–100, 110, 209–210, 212–217, 282–285
schemas.py	54	9	83%	57–63, 89–99
app/services/trust_registry/util
actor.py	31	2	94%	26–27
issuer.py	23	4	83%	39–40, 48–49
app/tests/e2e
conftest.py	23	5	78%	46–54
test_connections.py	149	2	99%	281–282
test_definitions.py	79	51	35%	33–56, 68–80, 92–106, 118–146, 164–209
test_jsonld.py	59	16	73%	134–169
test_proof_request_models.py	24	1	96%	101
test_revocation.py	111	73	34%	27–77, 90–107, 118–144, 156–181, 193–207, 219–256, 267–293, 305–335, 346–349
test_tenants.py	421	364	14%	29–73, 84–117, 128–172, 185–254, 265–316, 329–459, 468–520, 529–565, 574–623, 632–681, 692–734, 746–795, 806–877, 886–993
test_wallet_dids.py	70	15	79%	101–116, 128–139
app/tests/e2e/issuer
test_get_records_paginated.py	63	52	17%	25–161
test_save_exchange_record.py	72	1	99%	166
app/tests/e2e/verifier
test_get_credentials_by_proof_id.py	25	12	52%	27–81
test_get_records_paginated.py	62	49	21%	27–155
test_many_revocations.py	61	40	34%	31–107, 117–128, 139–214
test_proof_revoked_credential.py	44	11	75%	37–113
test_verifier_oob.py	69	23	67%	134–240
app/tests/exception_handling
test_handle_model_with_validation.py	23	1	96%	22
app/tests/fixtures
credentials.py	120	56	53%	130–204, 213–221, 231–253, 287–346, 381–430
definitions.py	66	10	85%	41–48, 57–63, 114–121, 134–139
member_acapy_clients.py	36	4	89%	47–50, 73–74
member_async_clients.py	50	2	96%	32–33
member_connections.py	43	4	91%	73, 91, 123, 141
member_wallets.py	61	15	75%	23–27, 43–47, 63–67, 83–87, 103–109
app/tests/routes/issuer
test_create_offer.py	39	1	97%	145
test_send_credential.py	36	1	97%	125
app/tests/routes/wallet/dids
test_get_public_did.py	29	1	97%	40
app/tests/services
test_revocation_registry.py	141	2	99%	74, 105
app/tests/services/issuer
test_issuer.py	123	2	98%	281–285
app/tests/util
connections.py	87	19	78%	154–155, 169, 181, 191–223, 251–256
ledger.py	50	26	48%	34–59, 63–67, 73–86
regression_testing.py	35	9	74%	33, 60–68, 74–81
sse_listener.py	28	4	86%	51–56
tenants.py	24	12	50%	10, 16–17, 21–26, 30–35, 39–44, 48–53, 57
trust_registry.py	29	7	76%	20–28
webhooks.py	53	15	72%	19, 65–81, 88–90, 95, 119
app/util
acapy_verifier_utils.py	123	5	96%	81–84, 164–168, 245
assert_public_did.py	18	12	33%	14–34
check_endorser_connection.py	10	4	60%	14–24
credentials.py	14	2	86%	13, 18
retry_method.py	36	30	17%	15–36, 68–114
string.py	15	4	73%	15–16, 20, 24
tenants.py	45	17	62%	24–29, 44–45, 52–59, 90–91, 97, 124
transaction_acked.py	14	7	50%	18–36
endorser
main.py	37	1	97%	55
endorser/services
endorsement_processor.py	94	2	98%	110–111
endorser/tests
test_util_endorsement.py	144	5	97%	286, 291, 350–352
endorser/util
endorsement.py	68	7	90%	134–146
trustregistry
main.py	82	4	95%	46–48, 110
trustregistry/tests
test_main.py	137	1	99%	90
TOTAL	11636	1444	88%

Tests	Skipped	Failures	Errors	Time
796	39 💤	0 ❌	0 🔥	3m 39s ⏱️

[ff137]

Docstring changes are good, but the Webhooks.md should get highlight the fact that webhook events are fired on record creation or state changes, and that we recommend using NATS Jetstream first and foremost. Then waypoint is a subheading, explaining it is an SSE option for waiting for specific/expected events on known thread or connection ids.

[ff137]

Minor grammatical changes

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud