Skip to content

Conversation

@ff137
Copy link
Collaborator

@ff137 ff137 commented Feb 14, 2025

🚚 Moves openapi specs to docs/openapi

✨ and adds scripts/download-specs.sh to auto download and format the specs (assist with consistency of json formatting for better diff tracking)

🎨 Sneaks in a couple trivial code scan fixes

Doing this before merging #1303 - so we have better change detection for the next acapy upgrade

@ff137 ff137 self-assigned this Feb 14, 2025
@ff137 ff137 added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 14, 2025
@ff137 ff137 requested a review from rblaine95 February 14, 2025 08:59
@github-actions
Copy link

Coverage

K8s Test Coverage
FileStmtsMissCoverMissing
app
Β  Β main.py80298%121–122
app/models
Β  Β wallet.py36489%100–105
app/routes
Β  Β jsonld.py604722%23–93, 104–137
Β  Β messaging.py241154%43–52, 85–95
Β  Β oob.py462839%58–99, 131–144, 170–181
Β  Β trust_registry.py62297%52–53
Β  Β verifier.py1393376%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.py805334%57–70, 96–108, 129–140, 166–180, 216–232, 266–283, 309–321, 342–353
app/services
Β  Β acapy_ledger.py631281%111–112, 125–141, 200–201
Β  Β acapy_wallet.py40490%60–61, 98–99
Β  Β revocation_registry.py1663579%118–160, 201–205, 360–364, 403–408, 441–445, 473–478, 527–528
app/services/issuer
Β  Β acapy_issuer_v2.py971288%63, 97–106, 110, 126–127, 172, 225–226, 252
app/services/onboarding
Β  Β tenants.py634922%30–103, 113–143
Β  Β verifier.py37392%67, 83–87
app/services/onboarding/util
Β  Β register_issuer_did.py95595%100–102, 276–281
Β  Β set_endorser_metadata.py724044%32–34, 58–60, 85–87, 118–137, 149–160, 172–185, 198–212
app/services/trust_registry
Β  Β actors.py107992%95–100, 110, 209–210, 212–217, 282–285
Β  Β schemas.py54983%57–63, 89–99
app/services/trust_registry/util
Β  Β actor.py31294%26–27
Β  Β issuer.py23483%39–40, 48–49
app/util
Β  Β acapy_verifier_utils.py123596%81–84, 164–168, 245
Β  Β assert_public_did.py18856%17–33
Β  Β credentials.py14286%13, 18
Β  Β retry_method.py361558%20–35, 76–77, 91–103
Β  Β save_exchange_record.py13192%29
Β  Β tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
Β  Β transaction_acked.py14286%34–35
shared
Β  Β log_config.py532062%41–94, 103–110, 152, 161–173
shared/models
Β  Β connection_record.py24196%47
Β  Β credential_exchange.py43784%85–88, 101–104
Β  Β endorsement.py866920%36–70, 92–122, 132–181
Β  Β presentation_exchange.py40978%54–56, 62–64, 82, 87, 91
Β  Β protocol.py10190%18
Β  Β trustregistry.py63789%22, 44, 75–83
shared/services
Β  Β nats_jetstream.py36489%56, 60, 64, 68
shared/util
Β  Β api_router.py14193%17
Β  Β mock_agent_controller.py55689%23, 74–78
trustregistry
Β  Β main.py84495%49–51, 113
waypoint
Β  Β main.py50198%67
waypoint/services
Β  Β nats_service.py112397%73–75
TOTAL496054789%Β 

Tests Skipped Failures Errors Time
895 6 πŸ’€ 0 ❌ 0 πŸ”₯ 4m 36s ⏱️

@github-actions
Copy link

Coverage

K8s Regression Test Coverage
FileStmtsMissCoverMissing
app
Β  Β main.py80298%121–122
app/models
Β  Β wallet.py36489%100–105
app/routes
Β  Β jsonld.py604722%23–93, 104–137
Β  Β messaging.py241154%43–52, 85–95
Β  Β oob.py462839%58–99, 131–144, 170–181
Β  Β trust_registry.py62297%52–53
Β  Β verifier.py1393376%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.py805334%57–70, 96–108, 129–140, 166–180, 216–232, 266–283, 309–321, 342–353
app/services
Β  Β acapy_ledger.py631970%44–50, 80, 111–112, 125–141, 147–150, 200–201
Β  Β acapy_wallet.py40490%60–61, 98–99
Β  Β revocation_registry.py1664672%118–160, 201–205, 360–364, 403–408, 441–445, 463–478, 484–493, 527–528
app/services/issuer
Β  Β acapy_issuer_v2.py971288%63, 97–106, 110, 126–127, 172, 225–226, 252
app/services/onboarding
Β  Β tenants.py634922%30–103, 113–143
Β  Β verifier.py37392%67, 83–87
app/services/onboarding/util
Β  Β register_issuer_did.py95595%100–102, 276–281
Β  Β set_endorser_metadata.py724044%32–34, 58–60, 85–87, 118–137, 149–160, 172–185, 198–212
app/services/trust_registry
Β  Β actors.py107992%95–100, 110, 209–210, 212–217, 282–285
Β  Β schemas.py54983%57–63, 89–99
app/services/trust_registry/util
Β  Β actor.py31294%26–27
Β  Β issuer.py23483%39–40, 48–49
app/util
Β  Β acapy_verifier_utils.py123596%81–84, 164–168, 245
Β  Β assert_public_did.py181233%14–34
Β  Β check_endorser_connection.py10460%14–24
Β  Β credentials.py14286%13, 18
Β  Β retry_method.py363017%15–36, 68–114
Β  Β save_exchange_record.py13192%29
Β  Β string.py15473%15–16, 20, 24
Β  Β tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
Β  Β transaction_acked.py14750%21–39
shared
Β  Β log_config.py532062%41–94, 103–110, 152, 161–173
shared/models
Β  Β connection_record.py24196%47
Β  Β credential_exchange.py43784%85–88, 101–104
Β  Β endorsement.py866920%36–70, 92–122, 132–181
Β  Β presentation_exchange.py40978%54–56, 62–64, 82, 87, 91
Β  Β protocol.py10190%18
Β  Β trustregistry.py63789%22, 44, 75–83
shared/services
Β  Β nats_jetstream.py36489%56, 60, 64, 68
shared/util
Β  Β api_router.py14193%17
Β  Β mock_agent_controller.py55689%23, 74–78
trustregistry
Β  Β main.py84495%49–51, 113
waypoint
Β  Β main.py50198%67
waypoint/services
Β  Β nats_service.py112397%73–75
TOTAL496059788%Β 

Tests Skipped Failures Errors Time
895 46 πŸ’€ 0 ❌ 0 πŸ”₯ 4m 8s ⏱️

@ff137 ff137 requested a review from cl0ete February 14, 2025 09:02
@ff137 ff137 changed the title πŸ“ Update openapi specs πŸššπŸ“ Update and move openapi specs Feb 14, 2025
@github-actions
Copy link

Coverage

K8s Test Coverage
FileStmtsMissCoverMissing
app
Β  Β main.py80298%121–122
app/models
Β  Β wallet.py36489%100–105
app/routes
Β  Β jsonld.py604722%23–93, 104–137
Β  Β messaging.py241154%43–52, 85–95
Β  Β oob.py462839%58–99, 131–144, 170–181
Β  Β trust_registry.py62297%52–53
Β  Β verifier.py1393376%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.py805334%57–70, 96–108, 129–140, 166–180, 216–232, 266–283, 309–321, 342–353
app/services
Β  Β acapy_ledger.py631281%111–112, 125–141, 200–201
Β  Β acapy_wallet.py40490%60–61, 98–99
Β  Β revocation_registry.py1663579%118–160, 201–205, 360–364, 403–408, 441–445, 473–478, 527–528
app/services/issuer
Β  Β acapy_issuer_v2.py971288%63, 97–106, 110, 126–127, 172, 225–226, 252
app/services/onboarding
Β  Β tenants.py634922%30–103, 113–143
Β  Β verifier.py37392%67, 83–87
app/services/onboarding/util
Β  Β register_issuer_did.py95595%100–102, 276–281
Β  Β set_endorser_metadata.py724044%32–34, 58–60, 85–87, 118–137, 149–160, 172–185, 198–212
app/services/trust_registry
Β  Β actors.py107992%95–100, 110, 209–210, 212–217, 282–285
Β  Β schemas.py54983%57–63, 89–99
app/services/trust_registry/util
Β  Β actor.py31294%26–27
Β  Β issuer.py23483%39–40, 48–49
app/util
Β  Β acapy_verifier_utils.py123596%81–84, 164–168, 245
Β  Β assert_public_did.py18856%17–33
Β  Β credentials.py14286%13, 18
Β  Β retry_method.py361558%20–35, 76–77, 91–103
Β  Β save_exchange_record.py13192%29
Β  Β tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
Β  Β transaction_acked.py14286%34–35
shared
Β  Β log_config.py532062%41–94, 103–110, 152, 161–173
shared/models
Β  Β connection_record.py24196%47
Β  Β credential_exchange.py43784%85–88, 101–104
Β  Β endorsement.py866920%36–70, 92–122, 132–181
Β  Β presentation_exchange.py40978%54–56, 62–64, 82, 87, 91
Β  Β protocol.py10190%18
Β  Β trustregistry.py63789%22, 44, 75–83
shared/services
Β  Β nats_jetstream.py36489%56, 60, 64, 68
shared/util
Β  Β api_router.py14193%17
Β  Β mock_agent_controller.py55689%23, 74–78
trustregistry
Β  Β main.py84495%49–51, 113
waypoint
Β  Β main.py50198%67
waypoint/services
Β  Β nats_service.py112397%73–75
TOTAL496054789%Β 

Tests Skipped Failures Errors Time
895 6 πŸ’€ 0 ❌ 0 πŸ”₯ 4m 30s ⏱️

@github-actions
Copy link

Coverage

K8s Regression Test Coverage
FileStmtsMissCoverMissing
app
Β  Β main.py80298%121–122
app/models
Β  Β wallet.py36489%100–105
app/routes
Β  Β jsonld.py604722%23–93, 104–137
Β  Β messaging.py241154%43–52, 85–95
Β  Β oob.py462839%58–99, 131–144, 170–181
Β  Β trust_registry.py62297%52–53
Β  Β verifier.py1393376%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.py805334%57–70, 96–108, 129–140, 166–180, 216–232, 266–283, 309–321, 342–353
app/services
Β  Β acapy_ledger.py631970%44–50, 80, 111–112, 125–141, 147–150, 200–201
Β  Β acapy_wallet.py40490%60–61, 98–99
Β  Β revocation_registry.py1664672%118–160, 201–205, 360–364, 403–408, 441–445, 463–478, 484–493, 527–528
app/services/issuer
Β  Β acapy_issuer_v2.py971288%63, 97–106, 110, 126–127, 172, 225–226, 252
app/services/onboarding
Β  Β tenants.py634922%30–103, 113–143
Β  Β verifier.py37392%67, 83–87
app/services/onboarding/util
Β  Β register_issuer_did.py95595%100–102, 276–281
Β  Β set_endorser_metadata.py724044%32–34, 58–60, 85–87, 118–137, 149–160, 172–185, 198–212
app/services/trust_registry
Β  Β actors.py107992%95–100, 110, 209–210, 212–217, 282–285
Β  Β schemas.py54983%57–63, 89–99
app/services/trust_registry/util
Β  Β actor.py31294%26–27
Β  Β issuer.py23483%39–40, 48–49
app/util
Β  Β acapy_verifier_utils.py123596%81–84, 164–168, 245
Β  Β assert_public_did.py181233%14–34
Β  Β check_endorser_connection.py10460%14–24
Β  Β credentials.py14286%13, 18
Β  Β retry_method.py363017%15–36, 68–114
Β  Β save_exchange_record.py13192%29
Β  Β string.py15473%15–16, 20, 24
Β  Β tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
Β  Β transaction_acked.py14750%21–39
shared
Β  Β log_config.py532062%41–94, 103–110, 152, 161–173
shared/models
Β  Β connection_record.py24196%47
Β  Β credential_exchange.py43784%85–88, 101–104
Β  Β endorsement.py866920%36–70, 92–122, 132–181
Β  Β presentation_exchange.py40978%54–56, 62–64, 82, 87, 91
Β  Β protocol.py10190%18
Β  Β trustregistry.py63789%22, 44, 75–83
shared/services
Β  Β nats_jetstream.py36489%56, 60, 64, 68
shared/util
Β  Β api_router.py14193%17
Β  Β mock_agent_controller.py55689%23, 74–78
trustregistry
Β  Β main.py84495%49–51, 113
waypoint
Β  Β main.py50198%67
waypoint/services
Β  Β nats_service.py112397%73–75
TOTAL496059788%Β 

Tests Skipped Failures Errors Time
895 46 πŸ’€ 0 ❌ 0 πŸ”₯ 4m 8s ⏱️

@sonarqubecloud
Copy link

@ff137 ff137 enabled auto-merge (squash) February 14, 2025 09:28
@github-actions
Copy link

Coverage

K8s Test Coverage
FileStmtsMissCoverMissing
app
Β  Β main.py80298%121–122
app/models
Β  Β wallet.py36489%100–105
app/routes
Β  Β jsonld.py604722%23–93, 104–137
Β  Β messaging.py241154%43–52, 85–95
Β  Β oob.py462839%58–99, 131–144, 170–181
Β  Β trust_registry.py62297%52–53
Β  Β verifier.py1393376%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.py805334%57–70, 96–108, 129–140, 166–180, 216–232, 266–283, 309–321, 342–353
app/services
Β  Β acapy_ledger.py631281%111–112, 125–141, 200–201
Β  Β acapy_wallet.py40490%60–61, 98–99
Β  Β revocation_registry.py1663579%118–160, 201–205, 360–364, 403–408, 441–445, 473–478, 527–528
app/services/issuer
Β  Β acapy_issuer_v2.py971288%63, 97–106, 110, 126–127, 172, 225–226, 252
app/services/onboarding
Β  Β tenants.py634922%30–103, 113–143
Β  Β verifier.py37392%67, 83–87
app/services/onboarding/util
Β  Β register_issuer_did.py95595%100–102, 276–281
Β  Β set_endorser_metadata.py724044%32–34, 58–60, 85–87, 118–137, 149–160, 172–185, 198–212
app/services/trust_registry
Β  Β actors.py107992%95–100, 110, 209–210, 212–217, 282–285
Β  Β schemas.py54983%57–63, 89–99
app/services/trust_registry/util
Β  Β actor.py31294%26–27
Β  Β issuer.py23483%39–40, 48–49
app/util
Β  Β acapy_verifier_utils.py123596%81–84, 164–168, 245
Β  Β assert_public_did.py18856%17–33
Β  Β credentials.py14286%13, 18
Β  Β retry_method.py361558%20–35, 76–77, 91–103
Β  Β save_exchange_record.py13192%29
Β  Β tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
Β  Β transaction_acked.py14286%34–35
shared
Β  Β log_config.py532062%41–94, 103–110, 152, 161–173
shared/models
Β  Β connection_record.py24196%47
Β  Β credential_exchange.py43784%85–88, 101–104
Β  Β endorsement.py866920%36–70, 92–122, 132–181
Β  Β presentation_exchange.py40978%54–56, 62–64, 82, 87, 91
Β  Β protocol.py10190%18
Β  Β trustregistry.py63789%22, 44, 75–83
shared/services
Β  Β nats_jetstream.py36489%56, 60, 64, 68
shared/util
Β  Β api_router.py14193%17
Β  Β mock_agent_controller.py55689%23, 74–78
trustregistry
Β  Β main.py84495%49–51, 113
waypoint
Β  Β main.py50198%67
waypoint/services
Β  Β nats_service.py112397%73–75
TOTAL496054789%Β 

Tests Skipped Failures Errors Time
895 6 πŸ’€ 0 ❌ 0 πŸ”₯ 4m 38s ⏱️

@github-actions
Copy link

Coverage

K8s Regression Test Coverage
FileStmtsMissCoverMissing
app
Β  Β main.py80298%121–122
app/models
Β  Β wallet.py36489%100–105
app/routes
Β  Β jsonld.py604722%23–93, 104–137
Β  Β messaging.py241154%43–52, 85–95
Β  Β oob.py462839%58–99, 131–144, 170–181
Β  Β trust_registry.py62297%52–53
Β  Β verifier.py1393376%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.py805334%57–70, 96–108, 129–140, 166–180, 216–232, 266–283, 309–321, 342–353
app/services
Β  Β acapy_ledger.py631970%44–50, 80, 111–112, 125–141, 147–150, 200–201
Β  Β acapy_wallet.py40490%60–61, 98–99
Β  Β revocation_registry.py1664672%118–160, 201–205, 360–364, 403–408, 441–445, 463–478, 484–493, 527–528
app/services/issuer
Β  Β acapy_issuer_v2.py971288%63, 97–106, 110, 126–127, 172, 225–226, 252
app/services/onboarding
Β  Β tenants.py634922%30–103, 113–143
Β  Β verifier.py37392%67, 83–87
app/services/onboarding/util
Β  Β register_issuer_did.py95595%100–102, 276–281
Β  Β set_endorser_metadata.py724044%32–34, 58–60, 85–87, 118–137, 149–160, 172–185, 198–212
app/services/trust_registry
Β  Β actors.py107992%95–100, 110, 209–210, 212–217, 282–285
Β  Β schemas.py54983%57–63, 89–99
app/services/trust_registry/util
Β  Β actor.py31294%26–27
Β  Β issuer.py23483%39–40, 48–49
app/util
Β  Β acapy_verifier_utils.py123596%81–84, 164–168, 245
Β  Β assert_public_did.py181233%14–34
Β  Β check_endorser_connection.py10460%14–24
Β  Β credentials.py14286%13, 18
Β  Β retry_method.py363017%15–36, 68–114
Β  Β save_exchange_record.py13192%29
Β  Β string.py15473%15–16, 20, 24
Β  Β tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
Β  Β transaction_acked.py14750%21–39
shared
Β  Β log_config.py532062%41–94, 103–110, 152, 161–173
shared/models
Β  Β connection_record.py24196%47
Β  Β credential_exchange.py43784%85–88, 101–104
Β  Β endorsement.py866920%36–70, 92–122, 132–181
Β  Β presentation_exchange.py40978%54–56, 62–64, 82, 87, 91
Β  Β protocol.py10190%18
Β  Β trustregistry.py63789%22, 44, 75–83
shared/services
Β  Β nats_jetstream.py36489%56, 60, 64, 68
shared/util
Β  Β api_router.py14193%17
Β  Β mock_agent_controller.py55689%23, 74–78
trustregistry
Β  Β main.py84495%49–51, 113
waypoint
Β  Β main.py50198%67
waypoint/services
Β  Β nats_service.py112397%73–75
TOTAL496059788%Β 

Tests Skipped Failures Errors Time
895 46 πŸ’€ 0 ❌ 0 πŸ”₯ 4m 10s ⏱️

@ff137 ff137 merged commit 712d1b3 into master Feb 14, 2025
35 checks passed
@ff137 ff137 deleted the update-openapi branch February 14, 2025 09:48
ff137 added a commit that referenced this pull request Feb 14, 2025
* ✨ Add bash script for downloading and formatting specs

* πŸ“ Updated openapi specs

* 🚚 Move to scripts folder

* 🚚 Move openapi specs to docs folder

* 🎨 Double quote to prevent globbing and word splitting.

* 🎨 Fenced code blocks should have a language specified
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants