From af6d93addf500887ac8e63b326838445fe0dc611 Mon Sep 17 00:00:00 2001 From: Shota Jolbordi Date: Fri, 27 Sep 2024 16:53:36 +0400 Subject: [PATCH 1/3] Update docs Signed-off-by: Shota Jolbordi --- .../docusaurus/credentialdefinition/create.md | 33 +++++++++-- docs/docusaurus/credentials/issue.md | 4 ++ docs/docusaurus/schemas/create.md | 37 +++++++++++- docs/docusaurus/schemas/credential-schema.md | 58 ++++++++++++++++--- docs/docusaurus/schemas/update.md | 14 ++++- 5 files changed, 129 insertions(+), 17 deletions(-) diff --git a/docs/docusaurus/credentialdefinition/create.md b/docs/docusaurus/credentialdefinition/create.md index 653e7eb6fc..f900a8b570 100644 --- a/docs/docusaurus/credentialdefinition/create.md +++ b/docs/docusaurus/credentialdefinition/create.md @@ -6,6 +6,10 @@ The OpenAPI specification and ReDoc documentation describe the endpoint. In this document, you can find step-by-step instructions for creating the credential definition. +## Prerequisites + +Before creating a credential definition, one must first create and then publish [prism DID](../dids/create.md), and then [create a credential schema](../schemas/create.md) to be used for the credential definition. Credential schema for credential definition **MUST** have a type of `AnoncredSchemaV1` as shown in [this](../schemas/credential-schema#schema-anoncred-schema) example. + ## Step-by-step guide The following guide demonstrates how to create a birth certificate credential definition. @@ -33,7 +37,9 @@ Here's a sample content of the credential definition: 1. Use your preferred REST API client, such as Postman or Insomnia, or utilize a client stub that's generated based on the OpenAPI specification. -2. In your API client, initiate a new POST request to the `/credential-definition-registry/definitions/` endpoint. +2. In your API client, initiate a new POST request to either `/credential-definition-registry/definitions` or `/credential-definition-registry/definitions/did-url` endpoints. They both take the same payload + 1. `/credential-definition-registry/definitions` creates a credential definition that can later be resolved via HTTP URL + 2. `/credential-definition-registry/definitions/did-url` creates a credential definition that can later be resolved via [DID URL](/docs/concepts/glossary#did-url), the DID includes a service endpoint with the location of the credential definition registry. Please note: The `author` field value should align with the short form of a PRISM DID previously created by the same agent. It's okay if this DID is unpublished. You can refer to the [Create DID](../dids/create.md) documentation for more comprehensive details on crafting a PRISM DID. @@ -55,6 +61,7 @@ Please note: The `author` field value should align with the short form of a PRIS 4. Transmit the POST Request to Create the New Credential Definition Once you've crafted your POST request, send it. Upon success, the server should respond with a GUID that uniquely identifies the new credential definition. +The response bodies will be the same for HTTP URL endpoint and DID URL endpoint, as well as request bodies, the only difference will be the URL, and how this credential definitions will be resolved later, via HTTP URL or DID URL respectivly. For ease of reference, here's a `curl` example: @@ -99,7 +106,7 @@ A potential response could be: ### 3. Retrieve the Created Credential Definition -To obtain details of the newly created credential definition, send a GET request to the `/credential-definition-registry/definitions/{guid}` endpoint. Replace `{guid}` with the unique GUID returned from the previous creation step. +To obtain details of the newly created credential definition, send a GET request to either `/credential-definition-registry/definitions/{guid}` or `/credential-definition-registry/definitions/did-url/{guid}` endpoints. Replace `{guid}` with the unique GUID returned from the previous creation step. Note that if you've created a credential definitoin via HTTP URL endpoint, you can retrieve it via `/credential-definition-registry/definitions/{guid}` and if you've created credential definition via DID URL endpoint, it can only be retrieved via `/credential-definition-registry/definitions/did-url/{guid}` To exemplify this process, use the following `curl` command: @@ -110,6 +117,16 @@ curl -X 'GET' \ -H "apikey: $API_KEY" ``` +or in case of DID URL + + +```shell +curl -X 'GET' \ + 'http://localhost:8080/credential-definition-registry/definitions/did-url/3f86a73f-5b78-39c7-af77-0c16123fa9c2' \ + -H 'accept: application/json' \ + -H "apikey: $API_KEY" +``` + You should receive a response containing the JSON object representing the credential definition you've just established: ```json @@ -131,6 +148,15 @@ You should receive a response containing the JSON object representing the creden } ``` +Or in case of DID URL, the respoinse is [Prism Envelope](/docs/concepts/glossary#prism-envelope) + +```json +{ +"resource": "{"author":"did:prism:d62c1e6bed7baf3b8071bfa9752484f8984e7531fc2c50bb948918af05ab2019","authored":"2024-09-27T12:36:15.647054Z","definition":{"issuerId":"did:prism:d62c1e6bed7baf3b8071bfa9752484f8984e7531fc2c50bb948918af05ab2019","schemaId":"http://localhost:8085/schema-registry/schemas/dacf3b8e-89eb-3ad6-a146-122dda7d6264/schema","tag":"Licence","type":"CL","value":{"primary":{"n":"105654036851119198442804905197138772660961362564942726492221206537787427664761610528911268652582902833631804462988444772839976949767758506541660845887111206763015524279947078901745021754475777237499434817085913784479036872293656776429655004974087451111814781402170155606646001644646986796527203081346585774321556045125472435782849460132632617398334789853089128389636424276406433404518879679328718228028492489332048927038418877774706068827588736310538701700336139157168229896546370106287010508929357204430784674794948793210620682177517550789918633211660935881696345235664053113361119206649410581078448680060427641832137","r":{"birthday":"49775546669052907131552961596651534733665231178896381921835910294477324588171227160118150614633026012901215334565735542933808985987904947350285129543852236973774547739382985572449736866262951346388082782666147267787940651500337010465433296075555496743454082377088759611829669288586895600077529142274581335383133149899787925352158578641189456811972520368708805448387741342924947626045722020577530550877126223412583290595303818507665314347044354637449813757676439765966847815468936975206408516033484154626133630281952402509007091344020672771282352322604656479710520655596487133130167684212283313961063588989288856799905","location":"96500832215519275100078283292556536362247838771473303030140104836952829871161851181822085377788529488887509912823514723934188375201219746062211754181983631423930580136685860677701430120636579150720309986435713420321242820726721738218285735954514827146194603352011587710461810171926746939813361903861720884671933290595036606362195598148537593941785527506785890178954130349127604646667787779881034960636818457833101134863491905402335720684238135670488883759794500078091332627710378547110039195546214450303977524458883125722666961073806016585609786120827070765808184402362095492978001957041206657180104804815419185914365","master_secret":"90142805634141500881029756644063322402588989530308711625897475072053420254041564253205873232484576499994053885268671864357578569658142177413979272557044001377354040197801380310149803131074800936779659257570491897326862431053417514510747028866917808009542935426448740224200403220568009881029820453214159366358578717379530748495737049630439620871896530847803217452898926461645501859301239202909769452120444452703782422945615267778324792561563889349427757299977109019630901399886586557514589134799197967321347775299921054214539047209500632569437675049741041418973412260351829794099823389955045654230109154705657097673874"},"rctxt":"54859746017967172028422193085462803294243002653649756707291332297571778036720095221079646715122898595413704302254820475441857495540488267532638945460339061730236223013742588287110664578498728045062187424149394349237967319796179677876052832945417833602223896064548177440236740013079697533695662733733325136816729319545510515293815635548802989865293537512953252765368231537060619179139225282979217707780705520075662962742647908712649704445906681711186025324557973203279764463486615442662071687767142962270335971353524065327071297849542466259149713469283903106013189221884407168622281433856602263414786407998837824591859","s":"79144099319322874878740613834778552565088271758837188339848658797577484506551729873650125815268542500595715069501705037671804625253642814431233308312903241672732478153012811404715587738968511513285869756078021610192517776171999187791890234600608995611150074909033176969865372059257981336879972408780020053736058764057786220031852182660250780927775016485256524038005413546975141049814773142175491642028353676540791747198204109296085130663478306470916647507719810142084930679215763315049068201649543040022901293618629633207030691603949984969918144686178253795987400377731766812748821737192247783300183280021245939358163","z":"72987641420579259687854010385183966782201934083168118192516787005899488801898877657301204657782896990951812073017814684645467349754910260176476305221117043274252878595562291873224029948666997922589973035003223452230925727141907508808939364196190468600088054982111252211200735080956666383960461034943818136401935651857290729996875641822343586161639042336133451549847109860666457391584458626114174536019367800809791912148108083990013216655860100234137957337767049607683135431621346700507208108087282131034657528306041020675179563506543914992557922323852470998978310467757401566923163140022957693557771912502047397065728"},"revocation":{"g":"1 1225947472976B5AA8229C228EAE5B758C09F6B07B54580BC7635306BEB25892 1 09A3138B336F1FBABD0B13A9A3A735D32B4E7F3DFB515C90FD075F569A49E521 2 095E45DDF417D05FB10933FFC63D474548B7FFFF7888802F07FFFFFF7D07A8A8","g_dash":"1 249053F45BBA8700778CF15841DFDEB0AF5943E1E2F2EEE03EAB6D808AC2F1EE 1 0742CE7B37203575A8C5D3275767D915D6EECFEC37979393F661FF5414C7D4BA 1 18D7A10E362FA192F1D2E5179D580F194E3941311511700FBA79A4A212E17F9F 1 07C3CA4E20C992A10CCC72449AAE964E01DDFB50FCEDBE1E6C8D0EC398F9571C 2 095E45DDF417D05FB10933FFC63D474548B7FFFF7888802F07FFFFFF7D07A8A8 1 0000000000000000000000000000000000000000000000000000000000000000","h":"1 19EC0BA114E10A7F9FEB2E733256CC98554FEDC1FF837DDAA34417E576258479 1 01637EFA0BCA6B3D66C315EE8ABF73B0E91EB505DA5AFBD961093D0299F4FAED 2 095E45DDF417D05FB10933FFC63D474548B7FFFF7888802F07FFFFFF7D07A8A8","h0":"1 1AC0AF950D7E2FA403C7E0FB9E8C5187D7A0A31A383BAE45FEA21AF66E8C5191 1 13256F00B84293F2073EB9EEE1B1F80581026C32A5F7FA8C4A1A108326A63745 2 095E45DDF417D05FB10933FFC63D474548B7FFFF7888802F07FFFFFF7D07A8A8","h1":"1 1AD15092C13C5B45F80978CECFB3F95E213A1DACCA431FA36A71E89881A6FEC0 1 244A0E328922715196600D66F1E573085A41DC3E1FE8F6D854965E3E2AE6F6E2 2 095E45DDF417D05FB10933FFC63D474548B7FFFF7888802F07FFFFFF7D07A8A8","h2":"1 0F0FCEBC515327212426C206F68487E93A267557BF89ABD6B150C3061C5D3CF7 1 07B59EE18EDF5E8EC133FE0657DCF131011F0C1DEC5F464571C1122077F3005D 2 095E45DDF417D05FB10933FFC63D474548B7FFFF7888802F07FFFFFF7D07A8A8","h_cap":"1 240392660C66108BB8349009570FA442AAD03A651566D01A82EED4003D365C67 1 0C2A17CD9038C18C57CD2468E06DCE7584A8CB8E80393B3A20BFFDE690D4C360 1 23CFEDA46BC18DAC387BD7C1D6F353620F63A4DB48C900DCD1FF30A36DC6404F 1 0DBBC471E2350CB5BE6FAF7DC90CBD7CC1E929E0CC39BBD9A9CA8BE3F7DEB6B0 2 095E45DDF417D05FB10933FFC63D474548B7FFFF7888802F07FFFFFF7D07A8A8 1 0000000000000000000000000000000000000000000000000000000000000000","htilde":"1 01B48387B9FD9BAD0E85E2B01B4298BB73CCBA21977CA98D6ED4603683D81C60 1 1E40315D62565D8820E3DF84E0E3E18FB891C6BC52E92D38B52303E8CE428CE6 2 095E45DDF417D05FB10933FFC63D474548B7FFFF7888802F07FFFFFF7D07A8A8","pk":"1 023BD63D34FA46607DD0827D629C37B8EA0FE22E9D03BB98369A125F73D748DF 1 0FE0A77850F2FCA8ADDAB19BA64AF30EE3BA53CE30E518F7371FCE1456451840 2 095E45DDF417D05FB10933FFC63D474548B7FFFF7888802F07FFFFFF7D07A8A8","u":"1 02F49EA71F2136DDF3A492F33F1CE630AE74597745CBADBFFC02B7355D9DADBF 1 0E693D69E5E3D61F8F09ECE0D2A080953C927319F694454F92EF24D0A020254D 1 21141D84156BD12E34ACD1C2F7A0674BBE45C0F52F0E3C7EFD23C9DB5DC07623 1 19CD7675D919439E201D43DAB47CDECAC5114BA3C42E18BF5DD93F97E12CA6C2 2 095E45DDF417D05FB10933FFC63D474548B7FFFF7888802F07FFFFFF7D07A8A8 1 0000000000000000000000000000000000000000000000000000000000000000","y":"1 09E9DBFBB8A5156AB7D679BCB8FB6A4FE742D55C1DAC03706A45AD29AB3EE70F 1 1848B7FF19481ADB68FDE0240A1FAC95A8749875EE9889FD79B25954DEBC828A 1 10823FCC2B413ED2EEA3BD8F2BF3A1FF277B7EA4F6B5F0F16C8473D2F75E7415 1 112CF746EC75C0E606732AA4586B43705C1F60BCDD9F0C150C5F0622D753B155 2 095E45DDF417D05FB10933FFC63D474548B7FFFF7888802F07FFFFFF7D07A8A8 1 0000000000000000000000000000000000000000000000000000000000000000"}}},"definitionJsonSchemaId":"PublicCredentialDefinitionV1","description":"Birth certificate Anoncred Credential Definition","guid":"ef4a5ddc-0612-34f6-af28-c5d147aa4380","id":"b76ae093-7e4e-45a8-8f91-12a2c30ccb63","keyCorrectnessProof":{"c":"30741655264393678188703336916199755343224591790809728617117096290356944905766","xr_cap":[["location","376827731046334193960358990381007479374236449989809064087488098146083279229809444236943856194203234914501328579440287735179298633489320559715195354160089364207331342600826403429234951657028524777878746302014907084587125789732064405546279473922112486757796144100072276647578546901210003776408185515729338983867442512327761363001884278624362949877949304301291806599892706917949934427843801181841270934845174416920716137956604408074504998621275534122263122152451302702716860479047494116477403293998750571547229545510735063852077284960180055008609687284216330028365676903023386427096574011733401166429204746326096256649115752273902039434376276127132313917927553958451469860195693420221325585586731"],["birthday","255000368334093419539180028241051103089074338431499178771514794663019496683055815744167959920637000377684223217964159076653487261169937814818207038581044839942280456518338682832854903213975432427699578648330016949062539209654583727716739115948426034395333400790466358334057724003422491086099921978696673192053498885524034743744803321566422269470534405137896707699553496347329909830995929237445759191162970676589148808029328779905404630010189591843087179307459969142763063435908070965350619268671546464834588456666416582084373050389746480931526855944107963869290380709468858613620266141510316459657309816694781429121337450775374684443542065075589195499515443281900403063474747707655590051088809"],["master_secret","490078220369908268411903371588287757146370779896841095746088472063211068413709915465302600234550989726726524430457261371967797516460429976823621411052695461912307728793736715658996012462600336689428652821877079764726877595056486827745277037426418761809589273316704013288283762311987278523585517535105953406281042910598284565509426242079088327496398408217125552860192961689446136874393595316067470772770180193552387523501638173498258688445948594473844046310976935495946904721277851884291016190281756273239535029507975200449160690882738577607590915424488783595754992353238784052204793313190148864996143261071362058886878586885815286413288857905742006513047585141037034364000345482010794383466598"]],"xz_cap":"496685294524278684474945044329959224508765633588043450481518349898401297346994249810223837314074425448755960286157868594456016277572201080443107641639311402052937673329038654776025104962110143589607612936428077245788296976359899230240512279354086130622663283108698134654533145668455611856066276981250002146880594737356206015752001617856924097657856693560805844047567816573451585553833344814433331796879389682837247954050970714286440486669018233891504814897402861731086613159034413523396614618647673783022103141584100064514608861166787663831219134560402513249084709436839539547340732462918087757162946399133704104330751757931114990709657447254935977011643179658189327088469611371185966320757835"},"keyCorrectnessProofJsonSchemaId":"ProofKeyCredentialDefinitionV1","name":"Birth Certificate location","resolutionMethod":"did","schemaId":"http://localhost:8085/schema-registry/schemas/dacf3b8e-89eb-3ad6-a146-122dda7d6264/schema","signatureType":"CL","supportRevocation":true,"tag":"Licence","version":"1.0.0"}", +"url": "did:prism:d62c1e6bed7baf3b8071bfa9752484f8984e7531fc2c50bb948918af05ab2019?resourceService=agent-base-url&resourcePath=credential-definition-registry/definitions/did-url/ef4a5ddc-0612-34f6-af28-c5d147aa4380?resourceHash=ca8ea2c80ff1e07978e2ed59245186fbb9992daedbecb651535ad5996be372c1" + +``` + Remember, in the Cloud Agent, the combination of author, id, and version uniquely identifies each credential definition. Thus, using the same agent DID as the author, you cannot establish another credential definition with identical id and version values. ### 4. Update the Credential Definition @@ -141,5 +167,4 @@ To update or upgrade an existing credential definition, follow the steps outline 2. Update the `version` value to reflect the changes made. This is important to ensure that each version of the credential definition remains distinct. 3. Create a new credential definition entry with the updated version and schema. -Note: When you make changes to an existing credential definition, it's essential to version the new entry accurately. This ensures clarity and avoids potential conflicts or misunderstandings among different versions of the same definition. - +Note: When you make changes to an existing credential definition, it's essential to version the new entry accurately. This ensures clarity and avoids potential conflicts or misunderstandings among different versions of the same definition. \ No newline at end of file diff --git a/docs/docusaurus/credentials/issue.md b/docs/docusaurus/credentials/issue.md index b392d310c2..568695d134 100644 --- a/docs/docusaurus/credentials/issue.md +++ b/docs/docusaurus/credentials/issue.md @@ -134,7 +134,10 @@ curl -X 'POST' \ 1. `claims`: The data stored in a verifiable credential. AnonCreds claims get expressed in a flat, "string -> string", key-value pair format. The claims contain the data that the issuer attests to, such as name, address, date of birth, and so on. 2. `connectionId`: The unique ID of the connection between the holder and the issuer to offer this credential over. 3. `credentialDefinitionId`: The unique ID of the [credential definition](../credentialdefinition/credential-definition.md) that has been created by the issuer as a prerequisite. Please refer to the [Create AnonCreds Credential Definition](../credentialdefinition/credential-definition.md) doc for details on how to create a credential definition. + 1. 📌 Note: If the credential definition was created via HTTP URL endpoint, then this credential definition will be referenced to that credential via HTTP URL, and if this credential definition was created via DID URL endpoint, then it will be referenced via DID URL, How to create credential definition for HTTP URL or DID URL is explained in [credential definition creation guide](../credentialdefinition/create.md) 4. `credentialFormat`: The format of the credential that will be issued - `AnonCreds` in this case. +5. `issuingDID`: The DID referring to the issuer to issue this credential from + :::note The `connectionId` and `credentialDefinitionId` properties come from completing the pre-requisite steps listed above @@ -159,6 +162,7 @@ curl -X 'POST' \ "drivingClass": "3" }, "credentialFormat": "AnonCreds", + "issuingDID": "did:prism:9f847f8bbb66c112f71d08ab39930d468ccbfe1e0e1d002be53d46c431212c26", "connectionId": "9d075518-f97e-4f11-9d10-d7348a7a0fda", "credentialDefinitionId": "5d737816-8fe8-3492-bfe3-1b3e2b67220b" }' diff --git a/docs/docusaurus/schemas/create.md b/docs/docusaurus/schemas/create.md index edfd7454f3..ad34b1f2c4 100644 --- a/docs/docusaurus/schemas/create.md +++ b/docs/docusaurus/schemas/create.md @@ -79,7 +79,9 @@ Specification. 1. Open your preferred REST API client, such as Postman or Insomnia, or use the client stub generated based on the OpenAPI specification. -2. In the client, create a new POST request to the `/cloud-agent/schema-registry/schemas` endpoint. +2. In the client, create a new POST request to either `/cloud-agent/schema-registry/schemas` or `/cloud-agent/schema-registry/schemas/did-url` endpoints. They both take the same payload. + 1. `/cloud-agent/schema-registry/schemas` creates a schema that can later be resolved via HTTP URL + 2. `/cloud-agent/schema-registry/schemas/did-url` creates a schema that can later be resolved via [DID URL](/docs/concepts/glossary#did-url), the DID includes a service endpoint with the location of the schema registry. Note that the value of the `author` field must match the short form of a PRISM DID that has been created using the same agent. An unpublished DID is sufficient. Please refer to the [Create DID](../dids/create.md) documentation page for more details on how to create a PRISM DID. @@ -252,6 +254,15 @@ curl -X 'POST' \ } ``` +or in case of DID url, the response will be created schema wrapped in [Prism Envelope](/docs/concepts/glossary#prism-envelope) + +```json +{ + "resource":"eyJhdXRob3IiOiJkaWQ6cHJpc206ZTAyNjZlZThkODBhMDAxNjNlNWY5MjJkYzI1NjdhYjk2MTE3MjRhMDBkYjkyNDIzMzAxMTU0MjgyMTY5ZGZmOSIsImF1dGhvcmVkIjoiMjAyNC0wOS0yNVQxMDozNzoxNi4wOTM2MDlaIiwiZGVzY3JpcHRpb24iOiJEcml2aW5nIExpY2Vuc2UgU2NoZW1hIiwiZ3VpZCI6IjVjOTNmYTAwLWUwM2UtMzlkZC05NDdmLTI2NWI4YzFlYWQ4YiIsImlkIjoiNjhmMGQ4MDctYTcyYi00OTY2LTg1NWItMmIzNGJjMjYzNzAyIiwibmFtZSI6ImRyaXZpbmctbGljZW5zZSIsInJlc29sdXRpb25NZXRob2QiOiJkaWQiLCJzY2hlbWEiOnsiJGlkIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9kcml2aW5nLWxpY2Vuc2UtMS4wLjAiLCIkc2NoZW1hIjoiaHR0cHM6Ly9qc29uLXNjaGVtYS5vcmcvZHJhZnQvMjAyMC0xMi9zY2hlbWEiLCJhZGRpdGlvbmFsUHJvcGVydGllcyI6dHJ1ZSwiZGVzY3JpcHRpb24iOiJEcml2aW5nIExpY2Vuc2UiLCJwcm9wZXJ0aWVzIjp7ImRhdGVPZklzc3VhbmNlIjp7ImZvcm1hdCI6ImRhdGUtdGltZSIsInR5cGUiOiJzdHJpbmcifSwiZHJpdmluZ0NsYXNzIjp7InR5cGUiOiJpbnRlZ2VyIn0sImRyaXZpbmdMaWNlbnNlSUQiOnsidHlwZSI6InN0cmluZyJ9LCJlbWFpbEFkZHJlc3MiOnsiZm9ybWF0IjoiZW1haWwiLCJ0eXBlIjoic3RyaW5nIn0sImZhbWlseU5hbWUiOnsidHlwZSI6InN0cmluZyJ9LCJnaXZlbk5hbWUiOnsidHlwZSI6InN0cmluZyJ9fSwicmVxdWlyZWQiOlsiZW1haWxBZGRyZXNzIiwiZmFtaWx5TmFtZSIsImRhdGVPZklzc3VhbmNlIiwiZHJpdmluZ0xpY2Vuc2VJRCIsImRyaXZpbmdDbGFzcyJdLCJ0eXBlIjoib2JqZWN0In0sInRhZ3MiOlsiZHJpdmluZyIsImxpY2Vuc2UiXSwidHlwZSI6Imh0dHBzOi8vdzNjLWNjZy5naXRodWIuaW8vdmMtanNvbi1zY2hlbWFzL3NjaGVtYS8yLjAvc2NoZW1hLmpzb24iLCJ2ZXJzaW9uIjoiMS4wLjAifQ==", + "url":"did:prism:e0266ee8d80a00163e5f922dc2567ab9611724a00db92423301154282169dff9?resourceService=agent-base-url&resourcePath=schema-registry/schemas/did-url/5c93fa00-e03e-39dd-947f-265b8c1ead8b?resourceHash=d1557ede168f0f91097933aa2080edaf2f14fddd8a7362a22add97e431c4efe2" +} +``` + ### 3. Retrieve the created schema To retrieve the newly created schema, create a new GET request to the `/cloud-agent/schema-registry/schemas/{guid}` @@ -265,7 +276,17 @@ curl -X 'GET' \ -H "apikey: $API_KEY" ``` -The response should contain the JSON object representing the schema you just created. +or if you need to resolve a schema created via DID url, the endpoint will look like this `/cloud-agent/schema-registry/schemas/did-url/{guid}` + +```schell +curl -X 'GET' \ + 'http://localhost:8080/cloud-agent/schema-registry/schemas/did-url/3f86a73f-5b78-39c7-af77-0c16123fa9c2' \ + -H 'accept: application/json' \ + -H "apikey: $API_KEY" + +``` + +The response for HTTP URL request should contain the JSON object representing the schema you just created. ```json { @@ -323,6 +344,18 @@ The response should contain the JSON object representing the schema you just cre } ``` +and for DID URL request, response will include the same schema wrapped in [Prism envelope](/docs/concepts/glossary#prism-envelope) response + +```json +{ + "resource":"eyJhdXRob3IiOiJkaWQ6cHJpc206ZTAyNjZlZThkODBhMDAxNjNlNWY5MjJkYzI1NjdhYjk2MTE3MjRhMDBkYjkyNDIzMzAxMTU0MjgyMTY5ZGZmOSIsImF1dGhvcmVkIjoiMjAyNC0wOS0yNVQxMDozNzoxNi4wOTM2MDlaIiwiZGVzY3JpcHRpb24iOiJEcml2aW5nIExpY2Vuc2UgU2NoZW1hIiwiZ3VpZCI6IjVjOTNmYTAwLWUwM2UtMzlkZC05NDdmLTI2NWI4YzFlYWQ4YiIsImlkIjoiNjhmMGQ4MDctYTcyYi00OTY2LTg1NWItMmIzNGJjMjYzNzAyIiwibmFtZSI6ImRyaXZpbmctbGljZW5zZSIsInJlc29sdXRpb25NZXRob2QiOiJkaWQiLCJzY2hlbWEiOnsiJGlkIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9kcml2aW5nLWxpY2Vuc2UtMS4wLjAiLCIkc2NoZW1hIjoiaHR0cHM6Ly9qc29uLXNjaGVtYS5vcmcvZHJhZnQvMjAyMC0xMi9zY2hlbWEiLCJhZGRpdGlvbmFsUHJvcGVydGllcyI6dHJ1ZSwiZGVzY3JpcHRpb24iOiJEcml2aW5nIExpY2Vuc2UiLCJwcm9wZXJ0aWVzIjp7ImRhdGVPZklzc3VhbmNlIjp7ImZvcm1hdCI6ImRhdGUtdGltZSIsInR5cGUiOiJzdHJpbmcifSwiZHJpdmluZ0NsYXNzIjp7InR5cGUiOiJpbnRlZ2VyIn0sImRyaXZpbmdMaWNlbnNlSUQiOnsidHlwZSI6InN0cmluZyJ9LCJlbWFpbEFkZHJlc3MiOnsiZm9ybWF0IjoiZW1haWwiLCJ0eXBlIjoic3RyaW5nIn0sImZhbWlseU5hbWUiOnsidHlwZSI6InN0cmluZyJ9LCJnaXZlbk5hbWUiOnsidHlwZSI6InN0cmluZyJ9fSwicmVxdWlyZWQiOlsiZW1haWxBZGRyZXNzIiwiZmFtaWx5TmFtZSIsImRhdGVPZklzc3VhbmNlIiwiZHJpdmluZ0xpY2Vuc2VJRCIsImRyaXZpbmdDbGFzcyJdLCJ0eXBlIjoib2JqZWN0In0sInRhZ3MiOlsiZHJpdmluZyIsImxpY2Vuc2UiXSwidHlwZSI6Imh0dHBzOi8vdzNjLWNjZy5naXRodWIuaW8vdmMtanNvbi1zY2hlbWFzL3NjaGVtYS8yLjAvc2NoZW1hLmpzb24iLCJ2ZXJzaW9uIjoiMS4wLjAifQ==", + "url":"did:prism:e0266ee8d80a00163e5f922dc2567ab9611724a00db92423301154282169dff9?resourceService=agent-base-url&resourcePath=schema-registry/schemas/did-url/5c93fa00-e03e-39dd-947f-265b8c1ead8b?resourceHash=d1557ede168f0f91097933aa2080edaf2f14fddd8a7362a22add97e431c4efe2" +} +``` + +Schemas created for HTTP URL (`/cloud-agent/schema-registry/schemas`) will not be resolvable by endpoint that returns schemas created for DID URL (`/cloud-agent/schema-registry/schemas/did-url`) and vice verca. + + The Cloud Agent instance's triple `author`, `id`, and `version` are unique. So, having a single [DID](/docs/concepts/glossary#decentralized-identifier) reference that the author uses, creating the credential schema with the same `id` and `version` is impossible. diff --git a/docs/docusaurus/schemas/credential-schema.md b/docs/docusaurus/schemas/credential-schema.md index 56aff05830..641de1011f 100644 --- a/docs/docusaurus/schemas/credential-schema.md +++ b/docs/docusaurus/schemas/credential-schema.md @@ -219,14 +219,56 @@ A valid [ANONCRED-SCHEMA](https://hyperledger.github.io/anoncreds-spec/#term:sch ```json { - "name": "Birth Certificate Schema", - "version": "1.0", - "attrNames": [ - "location", - "birthday" - ], - "issuerId": "did:prism:4a5b5cf0a513e83b598bbea25cd6196746747f361a73ef77068268bc9bd732ff" -} + "name":"anoncred-birthday-cert", + "version":"1.0.0", + "description":"Birthday certificate", + "type":"AnoncredSchemaV1", + "author":"did:prism:e0266ee8d80a00163e5f922dc2567ab9611724a00db92423301154282169dff9", + "tags":[ + "birth", + "certificate" + ], + "schema":{ + "$schema":"https://json-schema.org/draft/2020-12/schema", + "type":"object", + "properties":{ + "name":{ + "type":"string", + "minLength":1 + }, + "version":{ + "type":"string", + "minLength":1 + }, + "attrNames":{ + "type":"array", + "items":{ + "type":"string", + "minLength":1 + }, + "minItems":1, + "maxItems":125, + "uniqueItems":true + }, + "issuerId":{ + "type":"string", + "minLength":1 + } + }, + "name":"Birth Certificate Schema", + "version":"1.0", + "attrNames":[ + "location", + "birthday" + ], + "issuerId":"did:prism:e0266ee8d80a00163e5f922dc2567ab9611724a00db92423301154282169dff9" + }, + "required":[ + "name", + "version" + ], + "additionalProperties":true + } ``` --- diff --git a/docs/docusaurus/schemas/update.md b/docs/docusaurus/schemas/update.md index 17010d13cc..9235b3499d 100644 --- a/docs/docusaurus/schemas/update.md +++ b/docs/docusaurus/schemas/update.md @@ -108,8 +108,8 @@ The JSON Schema changes must be defined as follows: 1. Open your preferred REST API client, such as Postman or Insomnia, or use the client stub generated based on the OpenAPI specification. -2. In the client, create a new PUT request to the `/cloud-agent/schema-registry/schemas/{id}` endpoint, where `id` is a - locally unique credential schema id, formatted as a URL. +2. In the client, create a new PUT request to either `/cloud-agent/schema-registry/schemas/{id}` or `/cloud-agent/schema-registry/schemas/did-url/{id}` endpoint, where `id` is a locally unique credential schema id, formatted as a URL, they both take same payload. + 1. When updating a schema, it is imporant to consider if the schema is `HTTP URL` resolvable or `DID URL` resolvable, the `id` in this endpoint needs to be used accordingly, if schema is `HTTP URL` resolvable, then only `/cloud-agent/schema-registry/schemas/{id}` can be used to update it, and same with regards to `DID URL` Note that the value of the `author` field must match the short form of a PRISM DID that has been created using the same agent. An unpublished DID is sufficient. Please refer to the [Create DID](../dids/create.md) documentation page for more details on how to create a PRISM DID. @@ -323,4 +323,12 @@ curl -X 'PUT' \ "kind": "CredentialSchema", "self": "/schema-registry/schemas/3f86a73f-5b78-39c7-af77-0c16123fa9c2" } -``` \ No newline at end of file +``` + +If you are updating schema that is DID URL resolvable, the response will be in a forom of [Prism Envelope](/docs/concepts/glossary#prism-envelope), like this: + +```json +{ + "resource":"eyJhdXRob3IiOiJkaWQ6cHJpc206ZTAyNjZlZThkODBhMDAxNjNlNWY5MjJkYzI1NjdhYjk2MTE3MjRhMDBkYjkyNDIzMzAxMTU0MjgyMTY5ZGZmOSIsImF1dGhvcmVkIjoiMjAyNC0wOS0yNVQxMDozNzoxNi4wOTM2MDlaIiwiZGVzY3JpcHRpb24iOiJEcml2aW5nIExpY2Vuc2UgU2NoZW1hIiwiZ3VpZCI6IjVjOTNmYTAwLWUwM2UtMzlkZC05NDdmLTI2NWI4YzFlYWQ4YiIsImlkIjoiNjhmMGQ4MDctYTcyYi00OTY2LTg1NWItMmIzNGJjMjYzNzAyIiwibmFtZSI6ImRyaXZpbmctbGljZW5zZSIsInJlc29sdXRpb25NZXRob2QiOiJkaWQiLCJzY2hlbWEiOnsiJGlkIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9kcml2aW5nLWxpY2Vuc2UtMS4wLjAiLCIkc2NoZW1hIjoiaHR0cHM6Ly9qc29uLXNjaGVtYS5vcmcvZHJhZnQvMjAyMC0xMi9zY2hlbWEiLCJhZGRpdGlvbmFsUHJvcGVydGllcyI6dHJ1ZSwiZGVzY3JpcHRpb24iOiJEcml2aW5nIExpY2Vuc2UiLCJwcm9wZXJ0aWVzIjp7ImRhdGVPZklzc3VhbmNlIjp7ImZvcm1hdCI6ImRhdGUtdGltZSIsInR5cGUiOiJzdHJpbmcifSwiZHJpdmluZ0NsYXNzIjp7InR5cGUiOiJpbnRlZ2VyIn0sImRyaXZpbmdMaWNlbnNlSUQiOnsidHlwZSI6InN0cmluZyJ9LCJlbWFpbEFkZHJlc3MiOnsiZm9ybWF0IjoiZW1haWwiLCJ0eXBlIjoic3RyaW5nIn0sImZhbWlseU5hbWUiOnsidHlwZSI6InN0cmluZyJ9LCJnaXZlbk5hbWUiOnsidHlwZSI6InN0cmluZyJ9fSwicmVxdWlyZWQiOlsiZW1haWxBZGRyZXNzIiwiZmFtaWx5TmFtZSIsImRhdGVPZklzc3VhbmNlIiwiZHJpdmluZ0xpY2Vuc2VJRCIsImRyaXZpbmdDbGFzcyJdLCJ0eXBlIjoib2JqZWN0In0sInRhZ3MiOlsiZHJpdmluZyIsImxpY2Vuc2UiXSwidHlwZSI6Imh0dHBzOi8vdzNjLWNjZy5naXRodWIuaW8vdmMtanNvbi1zY2hlbWFzL3NjaGVtYS8yLjAvc2NoZW1hLmpzb24iLCJ2ZXJzaW9uIjoiMS4wLjAifQ==", + "url":"did:prism:e0266ee8d80a00163e5f922dc2567ab9611724a00db92423301154282169dff9?resourceService=agent-base-url&resourcePath=schema-registry/schemas/did-url/5c93fa00-e03e-39dd-947f-265b8c1ead8b?resourceHash=d1557ede168f0f91097933aa2080edaf2f14fddd8a7362a22add97e431c4efe2" +} \ No newline at end of file From 00a7268a9d84c86bdde4e996f9bd9e0a6a1bae30 Mon Sep 17 00:00:00 2001 From: Pete Vielhaber Date: Fri, 27 Sep 2024 08:00:04 -0500 Subject: [PATCH 2/3] Update docs/docusaurus/credentialdefinition/create.md Signed-off-by: Pete Vielhaber --- docs/docusaurus/credentialdefinition/create.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docusaurus/credentialdefinition/create.md b/docs/docusaurus/credentialdefinition/create.md index f900a8b570..f387e5de33 100644 --- a/docs/docusaurus/credentialdefinition/create.md +++ b/docs/docusaurus/credentialdefinition/create.md @@ -8,7 +8,7 @@ In this document, you can find step-by-step instructions for creating the creden ## Prerequisites -Before creating a credential definition, one must first create and then publish [prism DID](../dids/create.md), and then [create a credential schema](../schemas/create.md) to be used for the credential definition. Credential schema for credential definition **MUST** have a type of `AnoncredSchemaV1` as shown in [this](../schemas/credential-schema#schema-anoncred-schema) example. +Before creating a credential definition, one must first create and then publish [prism DID](../dids/create.md), and then [create a credential schema](../schemas/create.md) to be used for the credential definition. Credential schema for credential definition **must** have a type of `AnoncredSchemaV1` as shown in [this](../schemas/credential-schema#schema-anoncred-schema) example. ## Step-by-step guide From f9edcae35332cb07a68fb9b744491ca67bfd62b3 Mon Sep 17 00:00:00 2001 From: Shota Jolbordi Date: Fri, 27 Sep 2024 23:58:42 +0400 Subject: [PATCH 3/3] Change docs Signed-off-by: Shota Jolbordi --- docs/docusaurus/credentials/issue.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docusaurus/credentials/issue.md b/docs/docusaurus/credentials/issue.md index 568695d134..ff9beeae99 100644 --- a/docs/docusaurus/credentials/issue.md +++ b/docs/docusaurus/credentials/issue.md @@ -134,11 +134,11 @@ curl -X 'POST' \ 1. `claims`: The data stored in a verifiable credential. AnonCreds claims get expressed in a flat, "string -> string", key-value pair format. The claims contain the data that the issuer attests to, such as name, address, date of birth, and so on. 2. `connectionId`: The unique ID of the connection between the holder and the issuer to offer this credential over. 3. `credentialDefinitionId`: The unique ID of the [credential definition](../credentialdefinition/credential-definition.md) that has been created by the issuer as a prerequisite. Please refer to the [Create AnonCreds Credential Definition](../credentialdefinition/credential-definition.md) doc for details on how to create a credential definition. - 1. 📌 Note: If the credential definition was created via HTTP URL endpoint, then this credential definition will be referenced to that credential via HTTP URL, and if this credential definition was created via DID URL endpoint, then it will be referenced via DID URL, How to create credential definition for HTTP URL or DID URL is explained in [credential definition creation guide](../credentialdefinition/create.md) +:::note +📌 Note: If the credential definition was created via HTTP URL endpoint, then this credential definition will be referenced to that credential via HTTP URL, and if this credential definition was created via DID URL endpoint, then it will be referenced via DID URL, How to create credential definition for HTTP URL or DID URL is explained in [credential definition creation guide](../credentialdefinition/create.md) +::: 4. `credentialFormat`: The format of the credential that will be issued - `AnonCreds` in this case. 5. `issuingDID`: The DID referring to the issuer to issue this credential from - - :::note The `connectionId` and `credentialDefinitionId` properties come from completing the pre-requisite steps listed above :::