[Doc not up to date] Creating VC Offer

[incubiq]

Is this a regression?

No

Description

The Doc https://docs.atalaprism.io/agent-api/#tag/Issue-Credentials-Protocol/operation/createCredentialOffer is very misleading., and the change to Identus v1.33.0 seems to be more restrictive on params, which makes it very hard to understand what works / what does not work, as the doc is not clear.

The doc states the params must be {
"validityPeriod": 3600,
"schemaId": "https://agent-host.com/cloud-agent/schema-registry/schemas/d9569cec-c81e-4779-aa86-0d5994d82676/schema",
"credentialDefinitionId": "d9569cec-c81e-4779-aa86-0d5994d82676",
"credentialFormat": "JWT",
"claims": {
"firstname": "Alice",
"lastname": "Wonderland"
},
"automaticIssuance": true,
"issuingDID": "did:prism:3bb0505d13fcb04d28a48234edb27b0d4e6d7e18a81e2c1abab58f3bbc21ce6f",
"connectionId": "d9569cec-c81e-4779-aa86-0d5994d82676"
}

1/ this comes up with undocumented internal errors "$: required property 'attrNames' not found; $: required property 'issuerId' not found"

2/ it was recommended to remove the credentialDefinitionId but then it comes up with another undocumented internal error : status 400 ; Failed to parse schema content as Json or OEA: .guid(missing)

3/ then it was recommended to put "schemaId": null, and it worked...

what should be done:

• update the doc to make a WORKING example using NO schema, and NO Definition
• update the doc to make a WORKING example using schema, but NO Definition
• update the doc to make a WORKING example using Definition (with or without Schema)
• update the doc to make a WORKING example for AnonCreds
• document all possible errors correctly

Please provide the exception or error you saw

see above

Please provide the environment you discovered this bug in

Identus V1.33.0

Anything else?

No response

[essbante-io]

Thank you for your contribution to the project.

The core base of Hyperledger Identus maintainers is currently focused on delivering specific goals, which means that we are temporarily unable to address new issues, feature requests, or support inquiries at this time. However, we do recognize the importance of community and want to assure you that your issue, as well as all other community issues, have been noted and will be reviewed once bandwidth is available.

We will make exceptions for critical bugs or security incidents. If you are reporting a security issue, please go to this link and click the "Report a vulnerability" green button.

In the meantime, you can contact the community via our Discord channel. Other community members may be able to assist you with your issue.

We appreciate your understanding and patience as we work towards our goals. Thank you for supporting the Hyperledger Identus project!

Best regards,
Hyperledger Identus Maintainers