{"openapi":"3.1.0","info":{"title":"Pod platform API","description":"Pod platform API","version":"687ce03"},"externalDocs":{"description":"Pod platform api Documentation","url":"/docs"},"servers":[{"url":"https://pod-platform.api.athumi.eu","description":"Generated server url"}],"tags":[{"name":"WebId"},{"name":"Contract"}],"paths":{"/v1/webids":{"get":{"tags":["WebId"],"summary":"Gets the WebID for a citizen","description":"See [Get WebId](/doc/v1/api.html#webids-get)","operationId":"getWebId","parameters":[{"name":"X-Correlation-Id","in":"header","description":"A unique identifier value referencing to a particular transaction or event chain. If no correlation id is provided one will be generated.The correlation id is also returned in the response ","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The WebID was found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebId","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"404":{"description":"Resource not found. Additional details provided in the error message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}}},"security":[{"citizenAuthentication":[]}]},"put":{"tags":["WebId"],"summary":"Creates the WebID and corresponding pod for a citizen","description":"See [Create WebId](/doc/v1/api.html#webids-put)","operationId":"getOrCreateWebId","parameters":[{"name":"X-Correlation-Id","in":"header","description":"A unique identifier value referencing to a particular transaction or event chain. If no correlation id is provided one will be generated.The correlation id is also returned in the response ","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"An exising WebId was found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebId","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"201":{"description":"An new WebId was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebId","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}}},"security":[{"citizenAuthentication":[]}]},"delete":{"tags":["WebId"],"summary":"Delete the WebID and corresponding pod for a citizen","description":"See [Delete WebId](/doc/v1/api.html#webids-delete)","operationId":"deleteWebId","parameters":[{"name":"X-Correlation-Id","in":"header","description":"A unique identifier value referencing to a particular transaction or event chain. If no correlation id is provided one will be generated.The correlation id is also returned in the response ","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"An exising WebId was found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebId","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"201":{"description":"An new WebId was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebId","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}}},"security":[{"citizenAuthentication":[]}]}},"/v1/contracts/{contractId}/data":{"get":{"tags":["Contract"],"summary":"Gets the data for a citizen in the context of a contract","description":"Gets the data for a citizen in the context of a contract. The call should be made with a Solid OIDC token holding the citizen's WebId. See [Contracts](/doc/index.html#api-contracts) for more info.","operationId":"getDataForContract","parameters":[{"name":"contractId","in":"path","required":true,"schema":{"type":"string","default":"##default"}},{"name":"X-Correlation-Id","in":"header","description":"A unique identifier value referencing to a particular transaction or event chain. If no correlation id is provided one will be generated.The correlation id is also returned in the response ","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalDataResponse","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"400":{"description":"Bad request. Additional details provided in the error message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"404":{"description":"Resource not found. Additional details provided in the error message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}}},"security":[{"solidOIDCAuthentication":[]}]},"post":{"tags":["Contract"],"summary":"Stores the data retrieved for a citizen in the context of a contract and generates access grants to the contract owner.","description":"Stores the data retrieved for a citizen in the context of a contract and generates access grants to the contract owner. The call should be made with a Solid OIDC token holding the citizen's WebId. See [Contracts](/doc/index.html#api-contracts) for more info.","operationId":"shareDataForContract","parameters":[{"name":"contractId","in":"path","required":true,"schema":{"type":"string","default":"##default"}},{"name":"X-Correlation-Id","in":"header","description":"A unique identifier value referencing to a particular transaction or event chain. If no correlation id is provided one will be generated.The correlation id is also returned in the response ","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","default":"##default"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"items":{"$ref":"#/components/schemas/SharedPersonalData","contains":{"default":"##default"},"default":"##default","unevaluatedItems":{"default":"##default"}},"unevaluatedItems":{"default":"##default"}}}}},"400":{"description":"Bad request. Additional details provided in the error message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"404":{"description":"Resource not found. Additional details provided in the error message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}}},"security":[{"solidOIDCAuthentication":[]}]}},"/v1/resources":{"get":{"tags":["Resource"],"summary":"Returns the content of the given resource using an access grant.","description":"This endpoint returns the content of the given resource. It uses the access grant given in the X-Access-Grant header. If the optional verified parameter is set to true. The system will execute a verification at the resource source. If the verification is successful, the content is returned, otherwise a not found will be returned.The content-type of the response depends on the actual resource contents. If the content-type cannot be determined, octet-stream is used.","operationId":"resource","parameters":[{"name":"X-Access-Grant","in":"header","description":"Access Grant URI used to access the resource","required":true,"schema":{"type":"string","default":"##default","pattern":""}},{"name":"resource","in":"query","description":"Resource URI.","required":true,"schema":{"type":"string","default":"##default","pattern":""}},{"name":"verified","in":"query","description":"Only verified resources.","required":false,"schema":{"type":"string","default":"##default"}},{"name":"X-Correlation-Id","in":"header","description":"A unique identifier value referencing to a particular transaction or event chain. If no correlation id is provided one will be generated.The correlation id is also returned in the response ","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"byte","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"400":{"description":"Bad request. Additional details provided in the error message.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"404":{"description":"The resource could not be found. This could mean that the resource does not exist, or in case verified=true was given, deemed not valid by the source.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"401":{"description":"Unauthorized: This means the authorization header is missing or invalid. It should contain a valid Solid OIDC token.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"403":{"description":"Forbidden. This could have multiple reasons: the access grant does not exist, is revoked, expired or does not give the data user access to the given resource","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}}},"security":[{"solidOIDCAuthentication":[]}]}},"/v1/pods/{podId}/resources":{"get":{"tags":["Pod"],"operationId":"resourceForPod","parameters":[{"name":"podId","in":"path","required":true,"schema":{"type":"string"}},{"name":"X-Correlation-Id","in":"header","description":"A unique identifier value referencing to a particular transaction or event chain. If no correlation id is provided one will be generated.The correlation id is also returned in the response ","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}},"security":[{"solidOIDCAuthentication":[]}]}},"/v1/pods/{podId}/resources/{resourceId}":{"get":{"tags":["Pod"],"summary":"Returns the content of the given resource.","description":"This endpoint returns the content of the given resource. If the optional verified parameter is set to true. The system will execute a verification at the resource source. If the verification is successful, the content is returned, otherwise a not found will be returned.The content-type of the response depends on the actual resource contents. If the content-type cannot be determined, octet-stream is used.","operationId":"resourceById","parameters":[{"name":"podId","in":"path","description":"The unique identifier of the Pod.","required":true,"schema":{"type":"string","default":"##default"}},{"name":"resourceId","in":"path","description":"The unique identifier of the resource.","required":true,"schema":{"type":"string","default":"##default"}},{"name":"verified","in":"query","description":"Only verified resources.","required":false,"schema":{"type":"string","default":"##default"}},{"name":"X-Correlation-Id","in":"header","description":"A unique identifier value referencing to a particular transaction or event chain. If no correlation id is provided one will be generated.The correlation id is also returned in the response ","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-Correlation-Id","in":"header","description":"A unique identifier value referencing to a particular transaction or event chain. If no correlation id is provided one will be generated.The correlation id is also returned in the response ","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"byte","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}},"text/html":{"schema":{"type":"object"}}}},"400":{"description":"Bad request. Additional details provided in the error message.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"404":{"description":"The resource could not be found. This could mean that the resource does not exist, or in case verified=true was given, deemed not valid by the source.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"401":{"description":"Unauthorized: This means the authorization header is missing or invalid. It should contain a valid Solid OIDC token.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"403":{"description":"Forbidden. This could have multiple reasons: the access grant does not exist, is revoked, expired or does not give the data user access to the given resource","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}}},"security":[{"solidOIDCAuthentication":[]}]}},"/v1/gebouwen/**":{"get":{"tags":["resources-controller"],"operationId":"resourceByCustomUrl","parameters":[{"name":"X-Correlation-Id","in":"header","description":"A unique identifier value referencing to a particular transaction or event chain. If no correlation id is provided one will be generated.The correlation id is also returned in the response ","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}}}},"/v1/contracts/{contractId}":{"get":{"tags":["Contract"],"summary":"Get the contract","description":"Gets a contract. See [Contracts](/doc/index.html#api-contracts) for more info.","operationId":"getContract","parameters":[{"name":"contractId","in":"path","description":"The id of the contract.","required":true,"schema":{"type":"string","default":"##default"}},{"name":"X-Correlation-Id","in":"header","description":"A unique identifier value referencing to a particular transaction or event chain. If no correlation id is provided one will be generated.The correlation id is also returned in the response ","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Contract","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"400":{"description":"Bad request. Additional details provided in the error message.","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}},"404":{"description":"Resource not found. Additional details provided in the error message.","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error","additionalProperties":{"default":"##default"},"contains":{"default":"##default"},"default":"##default","items":{"default":"##default"},"unevaluatedItems":{"default":"##default"}}}}}}}},"/v1/pods/{podId}/resources/{resourceId}/access-grants/{accessGrantId}":{"delete":{"tags":["Pod"],"operationId":"deleteAccessGrant","parameters":[{"name":"podId","in":"path","required":true,"schema":{"type":"string"}},{"name":"resourceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accessGrantId","in":"path","required":true,"schema":{"type":"string"}},{"name":"X-Correlation-Id","in":"header","description":"A unique identifier value referencing to a particular transaction or event chain. If no correlation id is provided one will be generated.The correlation id is also returned in the response ","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}},"security":[{"solidOIDCAuthentication":[]}]}}},"components":{"schemas":{"WebId":{"type":"object","default":"##default","description":"A WebId","properties":{"uri":{"type":"string","format":"uri","default":"##default","description":"The URI"}}},"Error":{"type":"object","default":"##default","description":"Representation for an RFC 9457 api error.","properties":{"instance":{"type":"string","default":"##default","description":"A URI reference that identifies the specific occurrence of the problem."},"type":{"type":"string","format":"uri","default":"about:blank","description":"A URI reference that identifies the problem type","example":"about:blank"},"timestamp":{"type":"string","format":"date-time","default":"##default","description":"UTC ISO-8601 timestamp","example":"2025-02-05T14:35:56.601710Z"},"status":{"type":"integer","format":"int32","default":"##default","description":"HTTP status code","example":404},"title":{"type":"string","default":"##default","description":"Short, human-readable summary of the problem type","example":"Resource not found"},"detail":{"type":"string","default":"##default","description":"A human-readable explanation specific to this occurrence of the problem"}}},"SharedPersonalData":{"type":"object","default":"##default","description":"Describes personal data shared in the context of a contract","properties":{"podResource":{"type":"string","format":"uri","default":"##default","description":"The resource in the pod to which the data was written"},"accessGrant":{"type":"string","format":"uri","default":"##default","description":"The URI for the access grant granting access to the pod resource for the contract data user"}}},"I18nString":{"type":"object","default":"##default","description":"An internationalized string","properties":{"value":{"type":"string","default":"##default","description":"The translated string"},"language":{"type":"string","default":"##default","description":"The IETF BCP 47 language reference","example":"en"}}},"PersonalDataResponse":{"type":"object","default":"##default","description":"Response containing the personal data to which a contract consumer has access based on a specific contract instance","properties":{"dataValues":{"type":"array","items":{"$ref":"#/components/schemas/PersonalDataValue"}}},"required":["dataValues"]},"PersonalDataValue":{"type":"object","default":"##default","description":"A personal data instance","properties":{"id":{"type":"string","default":"##default","description":"The data value id"},"type":{"type":"string","format":"uri","default":"##default","description":"The data type"},"value":{"type":"string","default":"##default","description":"The raw data value. This is usually a verifiable credential as a JSON-LD document"},"summary":{"$ref":"#/components/schemas/PersonalDataValueSummary","default":"##default","description":"The summarized data value"},"error":{"type":"array","default":"##default","description":"Top level errors. When errors are present the data is considered invalid","items":{"$ref":"#/components/schemas/I18nString"}}}},"PersonalDataValueSummary":{"type":"object","default":"##default","description":"A generic data structure summarizing a personal data  value","properties":{"title":{"type":"array","default":"##default","description":"The title","items":{"$ref":"#/components/schemas/I18nString"}},"subtitle":{"type":"array","default":"##default","description":"The subtitle","items":{"$ref":"#/components/schemas/I18nString"}},"details":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/SummaryBooleanField"},{"$ref":"#/components/schemas/SummaryDateField"},{"$ref":"#/components/schemas/SummaryErrorField"},{"$ref":"#/components/schemas/SummaryGroupField"},{"$ref":"#/components/schemas/SummaryNumberField"},{"$ref":"#/components/schemas/SummaryStringField"},{"$ref":"#/components/schemas/SummaryTimestampField"}]},"default":"##default","description":"The details"}}},"SummaryBooleanField":{"allOf":[{"$ref":"#/components/schemas/SummaryField"},{"type":"object","properties":{"value":{"type":"string","default":"##default","description":"The boolean value"}}}],"description":"A field representing a boolean value"},"SummaryDateField":{"allOf":[{"$ref":"#/components/schemas/SummaryField"},{"type":"object","properties":{"value":{"type":"string","default":"##default","description":"The date value"}}}],"description":"A field representing a date value"},"SummaryErrorField":{"allOf":[{"$ref":"#/components/schemas/SummaryField"},{"type":"object","properties":{"value":{"type":"array","default":"##default","description":"The error value","items":{"$ref":"#/components/schemas/I18nString"}}}}],"description":"A field representing an error value"},"SummaryField":{"type":"object","default":"##default","description":"A field in a PersonalDataValueSummary","discriminator":{"propertyName":"format","mapping":{"string":"#/components/schemas/SummaryStringField","group":"#/components/schemas/SummaryGroupField","date":"#/components/schemas/SummaryDateField","timestamp":"#/components/schemas/SummaryTimestampField","boolean":"#/components/schemas/SummaryBooleanField","number":"#/components/schemas/SummaryNumberField","error":"#/components/schemas/SummaryErrorField"}},"properties":{"label":{"type":"array","default":"##default","description":"The field label","items":{"$ref":"#/components/schemas/I18nString"}},"format":{"type":"string","default":"##default","description":"The field format discriminator"}}},"SummaryGroupField":{"allOf":[{"$ref":"#/components/schemas/SummaryField"},{"type":"object","properties":{"items":{"type":"object","additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/SummaryBooleanField"},{"$ref":"#/components/schemas/SummaryDateField"},{"$ref":"#/components/schemas/SummaryErrorField"},{"$ref":"#/components/schemas/SummaryGroupField"},{"$ref":"#/components/schemas/SummaryNumberField"},{"$ref":"#/components/schemas/SummaryStringField"},{"$ref":"#/components/schemas/SummaryTimestampField"}]},"default":"##default","description":"The list of fields"}}}],"description":"A field representing a list of other fields"},"SummaryNumberField":{"allOf":[{"$ref":"#/components/schemas/SummaryField"},{"type":"object","properties":{"value":{"type":"string","default":"##default","description":"The number value"}}}],"description":"A field representing a number value"},"SummaryStringField":{"allOf":[{"$ref":"#/components/schemas/SummaryField"},{"type":"object","properties":{"items":{"type":"array","default":"##default","description":"The list of string values","items":{"type":"array","items":{"$ref":"#/components/schemas/I18nString"}}}}}],"description":"A field representing a list of internationalized string values"},"SummaryTimestampField":{"allOf":[{"$ref":"#/components/schemas/SummaryField"},{"type":"object","properties":{"value":{"type":"string","default":"##default","description":"The timestamp value"}}}],"description":"A field representing a timestamp value"},"Contract":{"type":"object","default":"##default","description":"A data sharing contract that can be used by the contract owner to retrieve and store personal data from another party","properties":{"@context":{"type":"string","default":"##default","description":"The JSON-LD context.","example":"https://pod-platform.api.athumi.eu/doc/context/2024-10-08/contract.jsonld"},"@type":{"type":"string","default":"##default","description":"The type.","example":"https://pod-platform.api.athumi.eu/doc/vocabulary/core#Contract"},"startDate":{"type":"string","default":"##default","description":"The start date represented as a ISO-8601 string. The contract can not be consumed prior to this date.","example":"2024-01-30"},"endDate":{"type":"string","default":"##default","description":"The optional end date represented as a ISO-8601 string. If present the contract can not be consumed after this date.","example":"2025-12-25"},"accessMode":{"type":"string","default":"##default","description":"The mode in which the data user can consume the data made available through this contract.","enum":["READ","WRITE"],"example":"READ"},"accessDuration":{"type":"string","default":"##default","description":"The duration during which the consumer can consume the data made available through this contract. Represented as a [ISO-8601](https://www.digi.com/resources/documentation/digidocs/90001488-13/reference/r_iso_8601_duration_format.htm) duration","example":"P1D"},"forDataUser":{"type":"string","default":"##default","description":"The entity for which the contract was created. Is represented using a WebId URI.","example":"https://acme.com/webid"},"forDataType":{"type":"array","default":"##default","description":"The data that can be access using this contract. 1 or more URI(s) pointing to a data type description hosted by Athumi.","example":"https://pod-platform.api.athumi.eu/doc/concept/data-type/Diploma_2024_05_22","items":{"type":"string"}},"forPurpose":{"type":"string","default":"##default","description":"A URI pointing to a RDF document describing the purpose the data user has with the data retrieved using this contract.","example":"https://pod-platform.api.athumi.eu/doc/concept/purposes/JobApplication"}},"required":["@context","@type","accessDuration","forDataType","forDataUser","forPurpose"]}},"securitySchemes":{"citizenAuthentication":{"type":"http","description":"A valid [SOLID OIDC token](/doc/index.html#security-solid-oidc-token) with a 'citizen_national_id' claim or a deprecated [JWS token](/doc/index.html#security-deprecated-jws-token) representing a citizen","name":"citizenAuthentication","in":"header","scheme":"bearer","bearerFormat":"JWT"},"solidOIDCAuthentication":{"type":"http","description":"A valid [SOLID OIDC token](/doc/index.html#security-solid-oidc-token)","name":"solidOIDCAuthentication","in":"header","scheme":"bearer","bearerFormat":"JWT"}}}}