-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi-v2204.json
1 lines (1 loc) · 23 KB
/
openapi-v2204.json
1
{"openapi":"3.0.0","paths":{"/api/v2204/sign":{"post":{"operationId":"CommonController_signSelfDescription","summary":"Canonize, hash and sign a valid Self Description","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifiableCredentialDto"},"examples":{"participant":{"summary":"Participant SD Example","value":{"@context":["http://www.w3.org/ns/shacl#","http://www.w3.org/2001/XMLSchema#","http://w3id.org/gaia-x/participant#","@nest"],"@id":"https://compliance.gaia-x.eu/.well-known/participant.json","@type":["VerifiableCredential","LegalPerson"],"credentialSubject":{"id":"did:compliance.gaia-x.eu","gx-participant:name":{"@value":"Gaia-X AISBL","@type":"xsd:string"},"gx-participant:legalName":{"@value":"Gaia-X European Association for Data and Cloud AISBL","@type":"xsd:string"},"gx-participant:registrationNumber":{"@value":"0762747721","@type":"xsd:string"},"gx-participant:headquarterAddress":{"@type":"gx-participant:Address","gx-participant:country":{"@value":"BE","@type":"xsd:string"},"gx-participant:street-address":{"@value":"Avenue des Arts 6-9","@type":"xsd:string"},"gx-participant:postal-code":{"@value":"1210","@type":"xsd:string"},"gx-participant:locality":{"@value":"Bruxelles/Brussels","@type":"xsd:string"}},"gx-participant:legalAddress":{"@type":"gx-participant:Address","gx-participant:country":{"@value":"BE","@type":"xsd:string"},"gx-participant:street-address":{"@value":"Avenue des Arts 6-9","@type":"xsd:string"},"gx-participant:postal-code":{"@value":"1210","@type":"xsd:string"},"gx-participant:locality":{"@value":"Bruxelles/Brussels","@type":"xsd:string"}}},"proof":{"type":"JsonWebKey2020","created":"2022-06-17T07:46:45.065Z","proofPurpose":"assertionMethod","verificationMethod":"did:web:compliance.lab.gaia-x.eu","jws":"eyJhbGciOiJQUzI1NiIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..knqo_G8hFzrXxrHOWNrYiD1v2bsdm7n6D9ekokszpPVp9p1rHNb3GzAW0q5gDdTxoFPUgZes93Gb2DR67ttewMTtoxFSuUfzqYtq584Rx85lSfmircSpR_QJRb1CxjJPZhWogznimujITW26-p9jvzvq-c6JzoduclpYEbb3rq6Eubsl6gVDxAOazJ9zxm4uLwTZTfVLaLAYIiyxhflBHE5Nmh1dRx7sy8fGEkRklZjzIbhjG1py9bo-GISHxzSEwbmxOyRbGzP_fqxLMIXFWHpXycugbY7D2Xnvm3FIH33Rd8KHc7klOXtilD3IaNEdRJIcvjLxRbA-aYW93atO_Q"}}},"service":{"summary":"Service Offering Experimental SD Example","value":{"@context":["http://www.w3.org/ns/shacl#","http://www.w3.org/2001/XMLSchema#","http://w3id.org/gaia-x/resource#","http://w3id.org/gaia-x/participant#","http://w3id.org/gaia-x/service-offering#"],"@type":["VerifiableCredential","ServiceOfferingExperimental"],"@id":"https://compliance.gaia-x.eu/.well-known/serviceComplianceService.json","credentialSubject":{"id":"https://compliance.gaia-x.eu/.well-known/serviceComplianceService.json","gx-service-offering:providedBy":{"@type":"xsd:string","@value":"https://compliance.gaia-x.eu/.well-known/participant.json"},"gx-service-offering:name":{"@type":"xsd:string","@value":"Gaia-X Lab Compliance Service"},"gx-service-offering:description":{"@type":"xsd:string","@value":"The Compliance Service will validate the shape and content of Self Descriptions. Required fields and consistency rules are defined in the Gaia-X Trust Framework."},"gx-service-offering:webAddress":{"@value":"https://compliance.gaia-x.eu/","@type":"xsd:anyURI"},"gx-service-offering:termsAndConditions":[{"@type":"gx-service-offering:TermsAndConditions","gx-service-offering:url":"https://compliance.gaia-x.eu/terms","gx-service-offering:hash":"myrandomhash"}],"gx-service-offering:gdpr":[{"@type":"xsd:anyURI","gx-service-offering:imprint":"https://gaia-x.eu/imprint/"},{"@type":"xsd:anyURI","gx-service-offering:privacyPolicy":"https://gaia-x.eu/privacy-policy/"}],"gx-service-offering:dependsOn":[{"@type":"xsd:anyURI","@value":"https://compliance.gaia-x.eu/.well-known/serviceManagedPostgreSQLOVH.json"},{"@type":"xsd:anyURI","@value":"https://compliance.gaia-x.eu/.well-known/serviceManagedK8sOVH.json"}]},"proof":{"type":"JsonWebKey2020","created":"2022-06-17T07:52:48.147Z","proofPurpose":"assertionMethod","verificationMethod":"did:web:compliance.lab.gaia-x.eu","jws":"eyJhbGciOiJQUzI1NiIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..baQ1Ks9ZM1YelRxZAoyH3XmgU5qMt-30Z27Mwadw8lv6WptueelIxL1RpoMctUXQalgUpLRnXJdo6U0igyrwHNyqx4rQcAlG8tkvflG9o0IYzcr6ojdb7--gkV9KlfN2yvzIB41BxfyTndK-4CgW_WwnwjxMQ3XbTGe3vgaz6ErohcSN846nXiX8Fph9HknEKWPF7MJoe2yFGXudLppnYKpMP2kiXU74_WeaAm7y1PXMeIL-qw9YDLUgqQ53Vg2YAd-4gDhYzhgZig2K-FrHm2aNRKyLyWFl47fxxik5hsU-SveTsnyJjkqfFTgqScjf2-F7pw7RsdBvCxIjsWNZ8A"}}}}}}},"responses":{"201":{"description":"Succesfully signed posted content. Will return the posted JSON with an additional \"proof\" property added."},"400":{"description":"Invalid JSON request body."},"409":{"description":"Invalid Participant Self Description."}},"tags":["Common"]}},"/api/v2204/normalize":{"post":{"operationId":"CommonController_normalizeSelfDescriptionRaw","summary":"Normalize (canonize) a Self Description using URDNA2015","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifiableCredentialDto"},"examples":{"participant":{"summary":"Participant SD Example","value":{"@context":["http://www.w3.org/ns/shacl#","http://www.w3.org/2001/XMLSchema#","http://w3id.org/gaia-x/participant#","@nest"],"@id":"https://compliance.gaia-x.eu/.well-known/participant.json","@type":["VerifiableCredential","LegalPerson"],"credentialSubject":{"id":"did:compliance.gaia-x.eu","gx-participant:name":{"@value":"Gaia-X AISBL","@type":"xsd:string"},"gx-participant:legalName":{"@value":"Gaia-X European Association for Data and Cloud AISBL","@type":"xsd:string"},"gx-participant:registrationNumber":{"@value":"0762747721","@type":"xsd:string"},"gx-participant:headquarterAddress":{"@type":"gx-participant:Address","gx-participant:country":{"@value":"BE","@type":"xsd:string"},"gx-participant:street-address":{"@value":"Avenue des Arts 6-9","@type":"xsd:string"},"gx-participant:postal-code":{"@value":"1210","@type":"xsd:string"},"gx-participant:locality":{"@value":"Bruxelles/Brussels","@type":"xsd:string"}},"gx-participant:legalAddress":{"@type":"gx-participant:Address","gx-participant:country":{"@value":"BE","@type":"xsd:string"},"gx-participant:street-address":{"@value":"Avenue des Arts 6-9","@type":"xsd:string"},"gx-participant:postal-code":{"@value":"1210","@type":"xsd:string"},"gx-participant:locality":{"@value":"Bruxelles/Brussels","@type":"xsd:string"}}},"proof":{"type":"JsonWebKey2020","created":"2022-06-17T07:46:45.065Z","proofPurpose":"assertionMethod","verificationMethod":"did:web:compliance.lab.gaia-x.eu","jws":"eyJhbGciOiJQUzI1NiIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..knqo_G8hFzrXxrHOWNrYiD1v2bsdm7n6D9ekokszpPVp9p1rHNb3GzAW0q5gDdTxoFPUgZes93Gb2DR67ttewMTtoxFSuUfzqYtq584Rx85lSfmircSpR_QJRb1CxjJPZhWogznimujITW26-p9jvzvq-c6JzoduclpYEbb3rq6Eubsl6gVDxAOazJ9zxm4uLwTZTfVLaLAYIiyxhflBHE5Nmh1dRx7sy8fGEkRklZjzIbhjG1py9bo-GISHxzSEwbmxOyRbGzP_fqxLMIXFWHpXycugbY7D2Xnvm3FIH33Rd8KHc7klOXtilD3IaNEdRJIcvjLxRbA-aYW93atO_Q"}}},"service":{"summary":"Service Offering Experimental SD Example","value":{"@context":["http://www.w3.org/ns/shacl#","http://www.w3.org/2001/XMLSchema#","http://w3id.org/gaia-x/resource#","http://w3id.org/gaia-x/participant#","http://w3id.org/gaia-x/service-offering#"],"@type":["VerifiableCredential","ServiceOfferingExperimental"],"@id":"https://compliance.gaia-x.eu/.well-known/serviceComplianceService.json","credentialSubject":{"id":"https://compliance.gaia-x.eu/.well-known/serviceComplianceService.json","gx-service-offering:providedBy":{"@type":"xsd:string","@value":"https://compliance.gaia-x.eu/.well-known/participant.json"},"gx-service-offering:name":{"@type":"xsd:string","@value":"Gaia-X Lab Compliance Service"},"gx-service-offering:description":{"@type":"xsd:string","@value":"The Compliance Service will validate the shape and content of Self Descriptions. Required fields and consistency rules are defined in the Gaia-X Trust Framework."},"gx-service-offering:webAddress":{"@value":"https://compliance.gaia-x.eu/","@type":"xsd:anyURI"},"gx-service-offering:termsAndConditions":[{"@type":"gx-service-offering:TermsAndConditions","gx-service-offering:url":"https://compliance.gaia-x.eu/terms","gx-service-offering:hash":"myrandomhash"}],"gx-service-offering:gdpr":[{"@type":"xsd:anyURI","gx-service-offering:imprint":"https://gaia-x.eu/imprint/"},{"@type":"xsd:anyURI","gx-service-offering:privacyPolicy":"https://gaia-x.eu/privacy-policy/"}],"gx-service-offering:dependsOn":[{"@type":"xsd:anyURI","@value":"https://compliance.gaia-x.eu/.well-known/serviceManagedPostgreSQLOVH.json"},{"@type":"xsd:anyURI","@value":"https://compliance.gaia-x.eu/.well-known/serviceManagedK8sOVH.json"}]},"proof":{"type":"JsonWebKey2020","created":"2022-06-17T07:52:48.147Z","proofPurpose":"assertionMethod","verificationMethod":"did:web:compliance.lab.gaia-x.eu","jws":"eyJhbGciOiJQUzI1NiIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..baQ1Ks9ZM1YelRxZAoyH3XmgU5qMt-30Z27Mwadw8lv6WptueelIxL1RpoMctUXQalgUpLRnXJdo6U0igyrwHNyqx4rQcAlG8tkvflG9o0IYzcr6ojdb7--gkV9KlfN2yvzIB41BxfyTndK-4CgW_WwnwjxMQ3XbTGe3vgaz6ErohcSN846nXiX8Fph9HknEKWPF7MJoe2yFGXudLppnYKpMP2kiXU74_WeaAm7y1PXMeIL-qw9YDLUgqQ53Vg2YAd-4gDhYzhgZig2K-FrHm2aNRKyLyWFl47fxxik5hsU-SveTsnyJjkqfFTgqScjf2-F7pw7RsdBvCxIjsWNZ8A"}}}}}}},"responses":{"201":{"description":"Normalized Self Description."},"400":{"description":"Bad request."}},"tags":["Common"]}},"/api/v2204/participant/verify":{"post":{"operationId":"ParticipantController_verifyParticipant","summary":"Validate a Participant Self Description from a URL","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyParticipantDto"}}}},"responses":{"200":{"description":"Participant credential successfully verified"},"400":{"description":"Invalid request payload"},"409":{"description":"Participant credential could not be verified"}},"tags":["Participant"]}},"/api/v2204/participant/verify/raw":{"post":{"operationId":"ParticipantController_verifyParticipantRaw","summary":"Validate a Participant Self Description","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/VerifiableSelfDescriptionDto"},{"properties":{"selfDescriptionCredential":{"properties":{"credentialSubject":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ParticipantSelfDescriptionDto"},{"properties":{"parentOrganisation":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantSelfDescriptionDto"}},"subOrganisation":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantSelfDescriptionDto"}}}}]}}}}}}]},"examples":{"service":{"summary":"Participant SD Example","value":{"selfDescriptionCredential":{"@context":["http://www.w3.org/ns/shacl#","http://www.w3.org/2001/XMLSchema#","http://w3id.org/gaia-x/participant#","@nest"],"@id":"https://compliance.gaia-x.eu/.well-known/participant.json","@type":["VerifiableCredential","LegalPerson"],"credentialSubject":{"id":"did:compliance.gaia-x.eu","gx-participant:name":{"@value":"Gaia-X AISBL","@type":"xsd:string"},"gx-participant:legalName":{"@value":"Gaia-X European Association for Data and Cloud AISBL","@type":"xsd:string"},"gx-participant:registrationNumber":{"@value":"0762747721","@type":"xsd:string"},"gx-participant:headquarterAddress":{"@type":"gx-participant:Address","gx-participant:country":{"@value":"BE","@type":"xsd:string"},"gx-participant:street-address":{"@value":"Avenue des Arts 6-9","@type":"xsd:string"},"gx-participant:postal-code":{"@value":"1210","@type":"xsd:string"},"gx-participant:locality":{"@value":"Bruxelles/Brussels","@type":"xsd:string"}},"gx-participant:legalAddress":{"@type":"gx-participant:Address","gx-participant:country":{"@value":"BE","@type":"xsd:string"},"gx-participant:street-address":{"@value":"Avenue des Arts 6-9","@type":"xsd:string"},"gx-participant:postal-code":{"@value":"1210","@type":"xsd:string"},"gx-participant:locality":{"@value":"Bruxelles/Brussels","@type":"xsd:string"}}},"proof":{"type":"JsonWebKey2020","created":"2022-06-17T07:46:45.065Z","proofPurpose":"assertionMethod","verificationMethod":"did:web:compliance.lab.gaia-x.eu","jws":"eyJhbGciOiJQUzI1NiIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..knqo_G8hFzrXxrHOWNrYiD1v2bsdm7n6D9ekokszpPVp9p1rHNb3GzAW0q5gDdTxoFPUgZes93Gb2DR67ttewMTtoxFSuUfzqYtq584Rx85lSfmircSpR_QJRb1CxjJPZhWogznimujITW26-p9jvzvq-c6JzoduclpYEbb3rq6Eubsl6gVDxAOazJ9zxm4uLwTZTfVLaLAYIiyxhflBHE5Nmh1dRx7sy8fGEkRklZjzIbhjG1py9bo-GISHxzSEwbmxOyRbGzP_fqxLMIXFWHpXycugbY7D2Xnvm3FIH33Rd8KHc7klOXtilD3IaNEdRJIcvjLxRbA-aYW93atO_Q"}},"complianceCredential":{"@context":["https://www.w3.org/2018/credentials/v1"],"@type":["VerifiableCredential","ParticipantCredential"],"id":"https://catalogue.gaia-x.eu/credentials/ParticipantCredential/1655452007162","issuer":"did:web:compliance.gaia-x.eu","issuanceDate":"2022-06-17T07:46:47.162Z","credentialSubject":{"id":"did:compliance.gaia-x.eu","hash":"9ecf754ffdad0c6de238f60728a90511780b2f7dbe2f0ea015115515f3f389cd"},"proof":{"type":"JsonWebKey2020","created":"2022-06-17T07:46:47.162Z","proofPurpose":"assertionMethod","jws":"eyJhbGciOiJQUzI1NiIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..eQrh53oeg-NmnOun_iM3tHH1ZnEnp7IqZmfsBgBPrLreN5F3DI6YxZisLAXToZiuWxOKux19ehRU1vg5gTAx6Zjb6NfHyj8-9AL9EQ4y7oBfhIk-ZIl6WzdkghtmVyp5dZxYTcSqCiSyWMJGrXsCRoxLU4SWAT0VP_bBuQc9joQZSiIUs3rHzyudV-6MLGhv9e9hwKarzZTXxvBCt4uVGm1ycqcr88SmYOxxFKrdLhJig8ttCD6codeNorDMV3VMj89lXOoFBDWSHPs5yEtLuAUu8RrxAwbyPOfbnCMpgbbriMlVlA9NDqdDK58AvirUtVfvWhhnZx0xKhyscVbIVw","verificationMethod":"did:web:compliance.gaia-x.eu"}}}}}}}},"responses":{"200":{"description":"Participant credential successfully verified"},"400":{"description":"Invalid request payload"},"409":{"description":"Participant credential could not be verified"}},"tags":["Participant"]}},"/api/v2204/service-offering/verify":{"post":{"operationId":"ServiceOfferingController_verifyServiceOffering","summary":"Validate a Service Offering Self Description from a URL","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyServiceOfferingDto"}}}},"responses":{"200":{"description":"Service Offering (experimental) credential successfully verified"},"400":{"description":"Invalid request payload"},"409":{"description":"Service Offering (experimental) credential could not be verified"}},"tags":["Service Offering (experimental)"]}},"/api/v2204/service-offering/verify/raw":{"post":{"operationId":"ServiceOfferingController_verifyServiceOfferingRaw","summary":"Validate a Service Offering Self Description","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/VerifiableSelfDescriptionDto"},{"properties":{"selfDescriptionCredential":{"properties":{"credentialSubject":{"type":"array","items":{"$ref":"#/components/schemas/ServiceOfferingSelfDescriptionDto"}}}}}}]},"examples":{"service":{"summary":"Service Offering Experimental SD Example","value":{"selfDescriptionCredential":{"@context":["http://www.w3.org/ns/shacl#","http://www.w3.org/2001/XMLSchema#","http://w3id.org/gaia-x/resource#","http://w3id.org/gaia-x/participant#","http://w3id.org/gaia-x/service-offering#"],"@type":["VerifiableCredential","ServiceOfferingExperimental"],"@id":"https://compliance.gaia-x.eu/.well-known/serviceComplianceService.json","credentialSubject":{"id":"https://compliance.gaia-x.eu/.well-known/serviceComplianceService.json","gx-service-offering:providedBy":{"@type":"xsd:string","@value":"https://compliance.gaia-x.eu/.well-known/participant.json"},"gx-service-offering:name":{"@type":"xsd:string","@value":"Gaia-X Lab Compliance Service"},"gx-service-offering:description":{"@type":"xsd:string","@value":"The Compliance Service will validate the shape and content of Self Descriptions. Required fields and consistency rules are defined in the Gaia-X Trust Framework."},"gx-service-offering:webAddress":{"@value":"https://compliance.gaia-x.eu/","@type":"xsd:anyURI"},"gx-service-offering:termsAndConditions":[{"@type":"gx-service-offering:TermsAndConditions","gx-service-offering:url":"https://compliance.gaia-x.eu/terms","gx-service-offering:hash":"myrandomhash"}],"gx-service-offering:gdpr":[{"@type":"xsd:anyURI","gx-service-offering:imprint":"https://gaia-x.eu/imprint/"},{"@type":"xsd:anyURI","gx-service-offering:privacyPolicy":"https://gaia-x.eu/privacy-policy/"}],"gx-service-offering:dependsOn":[{"@type":"xsd:anyURI","@value":"https://compliance.gaia-x.eu/.well-known/serviceManagedPostgreSQLOVH.json"},{"@type":"xsd:anyURI","@value":"https://compliance.gaia-x.eu/.well-known/serviceManagedK8sOVH.json"}]},"proof":{"type":"JsonWebKey2020","created":"2022-06-17T07:52:48.147Z","proofPurpose":"assertionMethod","verificationMethod":"did:web:compliance.lab.gaia-x.eu","jws":"eyJhbGciOiJQUzI1NiIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..baQ1Ks9ZM1YelRxZAoyH3XmgU5qMt-30Z27Mwadw8lv6WptueelIxL1RpoMctUXQalgUpLRnXJdo6U0igyrwHNyqx4rQcAlG8tkvflG9o0IYzcr6ojdb7--gkV9KlfN2yvzIB41BxfyTndK-4CgW_WwnwjxMQ3XbTGe3vgaz6ErohcSN846nXiX8Fph9HknEKWPF7MJoe2yFGXudLppnYKpMP2kiXU74_WeaAm7y1PXMeIL-qw9YDLUgqQ53Vg2YAd-4gDhYzhgZig2K-FrHm2aNRKyLyWFl47fxxik5hsU-SveTsnyJjkqfFTgqScjf2-F7pw7RsdBvCxIjsWNZ8A"}},"complianceCredential":{"@context":["https://www.w3.org/2018/credentials/v1"],"@type":["VerifiableCredential","ServiceOfferingCredentialExperimental"],"id":"https://catalogue.gaia-x.eu/credentials/ServiceOfferingCredentialExperimental/1655452370826","issuer":"did:web:compliance.gaia-x.eu","issuanceDate":"2022-06-17T07:52:50.826Z","credentialSubject":{"id":"https://compliance.gaia-x.eu/.well-known/serviceComplianceService.json","hash":"8424132029ec053ea6aef978e86f39874f8ffcaa35826ecad18b2616cd77e092"},"proof":{"type":"JsonWebKey2020","created":"2022-06-17T07:52:50.826Z","proofPurpose":"assertionMethod","jws":"eyJhbGciOiJQUzI1NiIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..mJIKkp3L49QIW9FiWqdXINdLIdLBlCxpp0O-F8-pIXZ8OM4dTxJwZI-NJod4H56cEq7U3oqgH5gxfAUZCvD8YmZYerULBGzFuGnutVn-2uD9nyqhkVZnoyPUZoauJ7zRL-emt875vTg9TPZHIgQa3NsDm011KnQFy03l9IpGcndZRMH7YXj-q0YPKQm55Gq0jBKR9xJivSFWKeXQ2dBmDbFDhwCF1vNTeIK7SlwGt0TvDcACNth4ZrAgytiWPhyvyIolQafjt1tcP07a3_wHp1G5PJtKFXF27awDvXElZlY2b1x8kRbQgram2qM1Zi2LxrUpXfvEawf-0EumjwyBrA","verificationMethod":"did:web:compliance.gaia-x.eu"}}}}}}}},"responses":{"200":{"description":"Service Offering (experimental) credential successfully verified"},"400":{"description":"Invalid request payload"},"409":{"description":"Service Offering (experimental) credential could not be verified"}},"tags":["Service Offering (experimental)"]}}},"info":{"title":"gx-compliance","description":"Prototype for a compliance service as defined in https://gaia-x.gitlab.io/policy-rules-committee/trust-framework/","version":"2204","contact":{}},"tags":[],"servers":[],"components":{"schemas":{"SignatureDto":{"type":"object","properties":{"type":{"type":"string","description":"Type of the proof"},"created":{"type":"string","description":"Creation date of the proof"},"proofPurpose":{"type":"string","description":"The proofPurpose property is used to associate a purpose, such as assertionMethod or authentication with a proof"},"jws":{"type":"string","description":"JSON Web Signature for a given self description"},"verificationMethod":{"type":"string","description":"Public key as PEM-encoded SPKI string"}},"required":["type","created","proofPurpose","jws","verificationMethod"]},"VerifiableCredentialDto":{"type":"object","properties":{"@context":{"type":"object","description":"The context to be used for the self description."},"@type":{"description":"The type of the self description.","type":"array","items":{"type":"string"}},"id":{"type":"string","description":"The identifier of the self description."},"credentialSubject":{"type":"object","description":"The claims of the credential."},"issuer":{"type":"string","description":"The identifier of the issuer of the credential."},"issuanceDate":{"type":"string","description":"The date of issuance of the credential."},"proof":{"description":"The proof of the credential.","allOf":[{"$ref":"#/components/schemas/SignatureDto"}]}},"required":["@context","@type","id","credentialSubject","issuer","issuanceDate","proof"]},"VerifyParticipantDto":{"type":"object","properties":{"url":{"type":"string","description":"The HTTP location of the Participant Self Description to verify","example":"https://compliance.gaia-x.eu/.well-known/participant.json"}},"required":["url"]},"VerifiableSelfDescriptionDto":{"type":"object","properties":{"selfDescriptionCredential":{"description":"Self Description created and signed by participant.","allOf":[{"$ref":"#/components/schemas/VerifiableCredentialDto"}]},"complianceCredential":{"description":"Proof issued by the compliance service.","allOf":[{"$ref":"#/components/schemas/VerifiableCredentialDto"}]}},"required":["selfDescriptionCredential","complianceCredential"]},"AddressDto":{"type":"object","properties":{"country":{"type":"string","description":"Country in ISO 3166-1 alpha2, alpha-3 or numeric format"},"state":{"type":"string","description":"State - a two letter state abbreviation is required for US based addresses."}},"required":["country"]},"ParticipantSelfDescriptionDto":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the credential subject."},"registrationNumber":{"type":"string","description":"Country's registration number which identifies one specific company."},"headquarterAddress":{"description":"Physical location of the companys head quarter.","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"legalAddress":{"description":"Physical location of the companys legal registration.","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"leiCode":{"type":"string","description":"Unique LEI number as defined by https://www.gleif.org."},"parentOrganisation":{"description":"A (list of) direct participant(s) that this entity is a subOrganization of, if any.","type":"array","items":{"type":"string"}},"subOrganisation":{"description":"A (list of) direct participant(s) with a legal mandate on this entity, e.g., as a subsidiary.","type":"array","items":{"type":"string"}}},"required":["id","registrationNumber","headquarterAddress","legalAddress"]},"VerifyServiceOfferingDto":{"type":"object","properties":{"url":{"type":"string","description":"The HTTP location of the Service Offering Self Description to verify","example":"https://compliance.gaia-x.eu/.well-known/serviceComplianceService.json"}},"required":["url"]},"TermsAndConditionsDto":{"type":"object","properties":{"url":{"type":"string","description":"A resolvable link to the Terms and Conditions document."},"hash":{"type":"string","description":"sha256 hash of the document provided at the given url."}},"required":["url","hash"]},"ServiceOfferingSelfDescriptionDto":{"type":"object","properties":{"id":{"type":"string","description":"The identifier of the credential subject."},"providedBy":{"type":"string","description":"A resolvable link to the participant Self-Description providing the service."},"aggregationOf":{"description":"Resolvable link(s) to the Self-Description(s) of resources related to the service and that can exist independently of it.","type":"array","items":{"type":"string"}},"termsAndConditions":{"description":"Physical location of the companys legal registration.","type":"array","items":{"$ref":"#/components/schemas/TermsAndConditionsDto"}}},"required":["id","providedBy","termsAndConditions"]}}}}