feat: improve OpenAPI's PresentProof to make more consistent #1130

FabioPinheiro · 2024-06-03T11:05:40Z

Description:

Improve OpenAPI's PresentProof to make more consistent and add missing examples

Current is like https://staging-docs.atalaprism.io/agent-api/#tag/Present-Proof/operation/getAllPresentation

ATL-6373

On the last image the output should look like json

Checklist:

My PR follows the contribution guidelines of this project
My PR is free of third-party dependencies that don't comply with the Allowlist
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
I have checked the PR title to follow the conventional commit specification

Signed-off-by: FabioPinheiro <[email protected]>

github-actions · 2024-06-03T11:19:31Z

Integration Test Results

15 files ±0 15 suites ±0 2s ⏱️ ±0s
33 tests ±0 33 ✅ ±0 0 💤 ±0 0 ❌ ±0
46 runs ±0 46 ✅ ±0 0 💤 ±0 0 ❌ ±0

Results for commit 1df5bed. ± Comparison against base commit ee53eda.

♻️ This comment has been updated with latest results.

github-actions · 2024-06-03T11:24:55Z

Unit Test Results

96 files ±0 96 suites ±0 20m 40s ⏱️ - 1m 45s
824 tests ±0 816 ✅ ±0 8 💤 ±0 0 ❌ ±0
831 runs ±0 823 ✅ ±0 8 💤 ±0 0 ❌ ±0

Results for commit 1df5bed. ± Comparison against base commit ee53eda.

♻️ This comment has been updated with latest results.

bvoiturier · 2024-06-03T14:31:42Z

...main/scala/org/hyperledger/identus/presentproof/controller/http/PresentationStatusPage.scala

        )
    object contents
        extends Annotation[Seq[PresentationStatus]](
          description = "A sequence of Presentation objects.",
-          example = Seq.empty
+          example = Seq(


Have you checked that this Seq is rendered correctly in the API doc? As far as I can see in the YAML spec file above, it looks weird... 🤔

yes I points that out but is a more generic problem.

Its already on the OpenAPI on other stuff like the class EntityResponse.

https://staging-docs.atalaprism.io/agent-api/#tag/Identity-and-Access-Management/operation/getAllEntities

Signed-off-by: FabioPinheiro <[email protected]>

…-consistent-beautiful Signed-off-by: Fabio Pinheiro <[email protected]>

…-consistent-beautiful

Signed-off-by: Yurii Shynbuiev <[email protected]>

…-consistent-beautiful

# [1.37.0-snapshot.test.1](cloud-agent-v1.36.1...cloud-agent-v1.37.0-snapshot.test.1) (2024-07-01) ### Bug Fixes * avoid name and operationId conflict when creating oas client ([#1233](#1233)) ([73e8e24](73e8e24)) * incorrect parsing of public key coordinates and enable some tests again ([#1215](#1215)) ([5398a75](5398a75)) * KeyID from String to Opaque Type and presentation job cleanup ([#1190](#1190)) ([b813faf](b813faf)) * make init-script.sh idempotent [#1173](#1173) ([#1194](#1194)) ([1712062](1712062)) * migrate and repair in case of renaming issues ([#1211](#1211)) ([cb4d479](cb4d479)) * Present Error Handling (Part 1: Repo Changes) ([#1172](#1172)) ([13e2447](13e2447)) * Present Error Handling Job ([#1204](#1204)) ([3191d8b](3191d8b)) * present error handling Part 2 ([#1177](#1177)) ([9ac6e52](9ac6e52)) * Verification Policy Error Handling ([#1228](#1228)) ([6117a3c](6117a3c)) ### Features * add oidc4vci protocol MVP ([#1182](#1182)) ([3ae91dc](3ae91dc)) * add schemaId to the issuance session ([#1199](#1199)) ([97f5d83](97f5d83)) * add support for EcdsaSecp256k1Signature2019Proof and fix pk encoding for EddsaJcs2022Proof ([#1127](#1127)) ([e617ded](e617ded)) * **agent:** add browser fingerprint label to http metrics ([#1231](#1231)) ([f090554](f090554)) * ATL 6829 - Integrate ZIO failures and defects ADR in credential status list ([#1175](#1175)) ([dffad1d](dffad1d)) * ATL-6832 ZIO failures and defects in entity controller ([#1203](#1203)) ([9050094](9050094)) * ATL-6833 integrate ZIO failures and defects in wallet event controller ([#1186](#1186)) ([8bc2018](8bc2018)) * ATL-6834 Use ZIO Failures and Defects effectively in the Issue flow ([#1139](#1139)) ([ede7b77](ede7b77)) * Handle Error in Background Jobs - Improve the way we store errors and defects in DB ([#1218](#1218)) ([e3cadc9](e3cadc9)) * implement ADR Use ZIO Failures and Defects Effectively - Mercury should not throw exceptions ([#1192](#1192)) ([a4ce87f](a4ce87f)) * improve OpenAPI's PresentProof to make more consistent ([#1130](#1130)) ([bdc5d20](bdc5d20)) * Integrate ZIO failures and defects ADR in DID Registrar Controller and Mercury ([#1180](#1180)) ([d8e2120](d8e2120)) * SDJWT holder key binding ([#1185](#1185)) ([628f2f0](628f2f0)) * use kid in the jwt proof header of OID4VCI CredentialIssue request ([#1184](#1184)) ([ee53eda](ee53eda)) * use the compact format in SD-JWT ([#1169](#1169)) ([65da651](65da651)) Signed-off-by: Allain Magyar <[email protected]>

# [1.37.0-snapshot.test.1](cloud-agent-v1.36.1...cloud-agent-v1.37.0-snapshot.test.1) (2024-07-01) ### Bug Fixes * avoid name and operationId conflict when creating oas client ([#1233](#1233)) ([73e8e24](73e8e24)) * incorrect parsing of public key coordinates and enable some tests again ([#1215](#1215)) ([5398a75](5398a75)) * KeyID from String to Opaque Type and presentation job cleanup ([#1190](#1190)) ([b813faf](b813faf)) * make init-script.sh idempotent [#1173](#1173) ([#1194](#1194)) ([1712062](1712062)) * migrate and repair in case of renaming issues ([#1211](#1211)) ([cb4d479](cb4d479)) * Present Error Handling (Part 1: Repo Changes) ([#1172](#1172)) ([13e2447](13e2447)) * Present Error Handling Job ([#1204](#1204)) ([3191d8b](3191d8b)) * present error handling Part 2 ([#1177](#1177)) ([9ac6e52](9ac6e52)) * Verification Policy Error Handling ([#1228](#1228)) ([6117a3c](6117a3c)) ### Features * add oidc4vci protocol MVP ([#1182](#1182)) ([3ae91dc](3ae91dc)) * add schemaId to the issuance session ([#1199](#1199)) ([97f5d83](97f5d83)) * add support for EcdsaSecp256k1Signature2019Proof and fix pk encoding for EddsaJcs2022Proof ([#1127](#1127)) ([e617ded](e617ded)) * **agent:** add browser fingerprint label to http metrics ([#1231](#1231)) ([f090554](f090554)) * ATL 6829 - Integrate ZIO failures and defects ADR in credential status list ([#1175](#1175)) ([dffad1d](dffad1d)) * ATL-6832 ZIO failures and defects in entity controller ([#1203](#1203)) ([9050094](9050094)) * ATL-6833 integrate ZIO failures and defects in wallet event controller ([#1186](#1186)) ([8bc2018](8bc2018)) * ATL-6834 Use ZIO Failures and Defects effectively in the Issue flow ([#1139](#1139)) ([ede7b77](ede7b77)) * Handle Error in Background Jobs - Improve the way we store errors and defects in DB ([#1218](#1218)) ([e3cadc9](e3cadc9)) * implement ADR Use ZIO Failures and Defects Effectively - Mercury should not throw exceptions ([#1192](#1192)) ([a4ce87f](a4ce87f)) * improve OpenAPI's PresentProof to make more consistent ([#1130](#1130)) ([bdc5d20](bdc5d20)) * Integrate ZIO failures and defects ADR in DID Registrar Controller and Mercury ([#1180](#1180)) ([d8e2120](d8e2120)) * SDJWT holder key binding ([#1185](#1185)) ([628f2f0](628f2f0)) * use kid in the jwt proof header of OID4VCI CredentialIssue request ([#1184](#1184)) ([ee53eda](ee53eda)) * use the compact format in SD-JWT ([#1169](#1169)) ([65da651](65da651)) Signed-off-by: Allain Magyar <[email protected]> Signed-off-by: Pat Losoponkul <[email protected]>

Signed-off-by: Pat Losoponkul <[email protected]> test: remove println Signed-off-by: Pat Losoponkul <[email protected]> chore(release): cut Identus Cloud agent 1.37.0-snapshot.test.1 release * avoid name and operationId conflict when creating oas client ([#1233](#1233)) ([73e8e24](73e8e24)) * incorrect parsing of public key coordinates and enable some tests again ([#1215](#1215)) ([5398a75](5398a75)) * KeyID from String to Opaque Type and presentation job cleanup ([#1190](#1190)) ([b813faf](b813faf)) * make init-script.sh idempotent [#1173](#1173) ([#1194](#1194)) ([1712062](1712062)) * migrate and repair in case of renaming issues ([#1211](#1211)) ([cb4d479](cb4d479)) * Present Error Handling (Part 1: Repo Changes) ([#1172](#1172)) ([13e2447](13e2447)) * Present Error Handling Job ([#1204](#1204)) ([3191d8b](3191d8b)) * present error handling Part 2 ([#1177](#1177)) ([9ac6e52](9ac6e52)) * Verification Policy Error Handling ([#1228](#1228)) ([6117a3c](6117a3c)) * add oidc4vci protocol MVP ([#1182](#1182)) ([3ae91dc](3ae91dc)) * add schemaId to the issuance session ([#1199](#1199)) ([97f5d83](97f5d83)) * add support for EcdsaSecp256k1Signature2019Proof and fix pk encoding for EddsaJcs2022Proof ([#1127](#1127)) ([e617ded](e617ded)) * **agent:** add browser fingerprint label to http metrics ([#1231](#1231)) ([f090554](f090554)) * ATL 6829 - Integrate ZIO failures and defects ADR in credential status list ([#1175](#1175)) ([dffad1d](dffad1d)) * ATL-6832 ZIO failures and defects in entity controller ([#1203](#1203)) ([9050094](9050094)) * ATL-6833 integrate ZIO failures and defects in wallet event controller ([#1186](#1186)) ([8bc2018](8bc2018)) * ATL-6834 Use ZIO Failures and Defects effectively in the Issue flow ([#1139](#1139)) ([ede7b77](ede7b77)) * Handle Error in Background Jobs - Improve the way we store errors and defects in DB ([#1218](#1218)) ([e3cadc9](e3cadc9)) * implement ADR Use ZIO Failures and Defects Effectively - Mercury should not throw exceptions ([#1192](#1192)) ([a4ce87f](a4ce87f)) * improve OpenAPI's PresentProof to make more consistent ([#1130](#1130)) ([bdc5d20](bdc5d20)) * Integrate ZIO failures and defects ADR in DID Registrar Controller and Mercury ([#1180](#1180)) ([d8e2120](d8e2120)) * SDJWT holder key binding ([#1185](#1185)) ([628f2f0](628f2f0)) * use kid in the jwt proof header of OID4VCI CredentialIssue request ([#1184](#1184)) ([ee53eda](ee53eda)) * use the compact format in SD-JWT ([#1169](#1169)) ([65da651](65da651)) Signed-off-by: Allain Magyar <[email protected]> Signed-off-by: Pat Losoponkul <[email protected]>

# [1.37.0](cloud-agent-v1.36.1...cloud-agent-v1.37.0) (2024-07-01) ### Bug Fixes * avoid name and operationId conflict when creating oas client ([#1233](#1233)) ([73e8e24](73e8e24)) * incorrect parsing of public key coordinates and enable some tests again ([#1215](#1215)) ([5398a75](5398a75)) * KeyID from String to Opaque Type and presentation job cleanup ([#1190](#1190)) ([b813faf](b813faf)) * make init-script.sh idempotent [#1173](#1173) ([#1194](#1194)) ([1712062](1712062)) * migrate and repair in case of renaming issues ([#1211](#1211)) ([cb4d479](cb4d479)) * Present Error Handling (Part 1: Repo Changes) ([#1172](#1172)) ([13e2447](13e2447)) * Present Error Handling Job ([#1204](#1204)) ([3191d8b](3191d8b)) * present error handling Part 2 ([#1177](#1177)) ([9ac6e52](9ac6e52)) * Verification Policy Error Handling ([#1228](#1228)) ([6117a3c](6117a3c)) ### Features * add oidc4vci protocol MVP ([#1182](#1182)) ([3ae91dc](3ae91dc)) * add schemaId to the issuance session ([#1199](#1199)) ([97f5d83](97f5d83)) * add support for EcdsaSecp256k1Signature2019Proof and fix pk encoding for EddsaJcs2022Proof ([#1127](#1127)) ([e617ded](e617ded)) * **agent:** add browser fingerprint label to http metrics ([#1231](#1231)) ([f090554](f090554)) * ATL 6829 - Integrate ZIO failures and defects ADR in credential status list ([#1175](#1175)) ([dffad1d](dffad1d)) * ATL-6832 ZIO failures and defects in entity controller ([#1203](#1203)) ([9050094](9050094)) * ATL-6833 integrate ZIO failures and defects in wallet event controller ([#1186](#1186)) ([8bc2018](8bc2018)) * ATL-6834 Use ZIO Failures and Defects effectively in the Issue flow ([#1139](#1139)) ([ede7b77](ede7b77)) * Handle Error in Background Jobs - Improve the way we store errors and defects in DB ([#1218](#1218)) ([e3cadc9](e3cadc9)) * implement ADR Use ZIO Failures and Defects Effectively - Mercury should not throw exceptions ([#1192](#1192)) ([a4ce87f](a4ce87f)) * improve OpenAPI's PresentProof to make more consistent ([#1130](#1130)) ([bdc5d20](bdc5d20)) * Integrate ZIO failures and defects ADR in DID Registrar Controller and Mercury ([#1180](#1180)) ([d8e2120](d8e2120)) * SDJWT holder key binding ([#1185](#1185)) ([628f2f0](628f2f0)) * use kid in the jwt proof header of OID4VCI CredentialIssue request ([#1184](#1184)) ([ee53eda](ee53eda)) * use the compact format in SD-JWT ([#1169](#1169)) ([65da651](65da651)) Signed-off-by: Allain Magyar <[email protected]>

feat: improve OpenAPI's PresentProof to make more consisten

c2016ce

Signed-off-by: FabioPinheiro <[email protected]>

FabioPinheiro requested review from bvoiturier, yshyn-iohk and patlo-iog as code owners June 3, 2024 11:05

github-actions bot added the cloud-agent label Jun 3, 2024

FabioPinheiro requested a review from mineme0110 June 3, 2024 11:07

yshyn-iohk approved these changes Jun 3, 2024

View reviewed changes

bvoiturier reviewed Jun 3, 2024

View reviewed changes

hammer time

d80df34

Signed-off-by: FabioPinheiro <[email protected]>

FabioPinheiro force-pushed the feat/ATL-6273-OpenAPI-PresentProof-Update-to-consistent-beautiful branch from 9839665 to d80df34 Compare June 3, 2024 15:56

FabioPinheiro mentioned this pull request Jun 3, 2024

Fix the encoding of examples in generated OpenAPI file #1137

Closed

FabioPinheiro enabled auto-merge (squash) June 3, 2024 17:04

Merge branch 'main' into feat/ATL-6273-OpenAPI-PresentProof-Update-to…

1390c80

…-consistent-beautiful Signed-off-by: Fabio Pinheiro <[email protected]>

mineme0110 approved these changes Jun 4, 2024

View reviewed changes

yshyn-iohk added 5 commits June 7, 2024 18:00

Merge branch 'main' into feat/ATL-6273-OpenAPI-PresentProof-Update-to…

a0ea24e

…-consistent-beautiful

Merge branch 'main' into feat/ATL-6273-OpenAPI-PresentProof-Update-to…

363dff1

…-consistent-beautiful

style: fix scala files formatting

b71ec1d

Signed-off-by: Yurii Shynbuiev <[email protected]>

Merge branch 'main' into feat/ATL-6273-OpenAPI-PresentProof-Update-to…

e162849

…-consistent-beautiful

Merge branch 'main' into feat/ATL-6273-OpenAPI-PresentProof-Update-to…

1df5bed

…-consistent-beautiful

FabioPinheiro merged commit bdc5d20 into main Jun 14, 2024
10 checks passed

FabioPinheiro deleted the feat/ATL-6273-OpenAPI-PresentProof-Update-to-consistent-beautiful branch June 14, 2024 13:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: improve OpenAPI's PresentProof to make more consistent #1130

feat: improve OpenAPI's PresentProof to make more consistent #1130

FabioPinheiro commented Jun 3, 2024

github-actions bot commented Jun 3, 2024 •

edited

Loading

github-actions bot commented Jun 3, 2024 •

edited

Loading

bvoiturier Jun 3, 2024

FabioPinheiro Jun 3, 2024

feat: improve OpenAPI's PresentProof to make more consistent #1130

feat: improve OpenAPI's PresentProof to make more consistent #1130

Conversation

FabioPinheiro commented Jun 3, 2024

Description:

Checklist:

github-actions bot commented Jun 3, 2024 • edited Loading

Integration Test Results

github-actions bot commented Jun 3, 2024 • edited Loading

Unit Test Results

bvoiturier Jun 3, 2024

Choose a reason for hiding this comment

FabioPinheiro Jun 3, 2024

Choose a reason for hiding this comment

github-actions bot commented Jun 3, 2024 •

edited

Loading

github-actions bot commented Jun 3, 2024 •

edited

Loading