# WfExS-backend cache metadata

- [1. Property `WfExS-backend cache metadata > oneOf > item 0`](#oneOf_i0)
  - [1.1. The following properties are required](#autogenerated_heading_2)
  - [1.2. Property `WfExS-backend cache metadata > oneOf > item 0 > resolves_to`](#oneOf_i0_resolves_to)
    - [1.2.1. Property `WfExS-backend cache metadata > oneOf > item 0 > resolves_to > oneOf > item 0`](#oneOf_i0_resolves_to_oneOf_i0)
    - [1.2.2. Property `WfExS-backend cache metadata > oneOf > item 0 > resolves_to > oneOf > item 1`](#oneOf_i0_resolves_to_oneOf_i1)
      - [1.2.2.1. WfExS-backend cache metadata > oneOf > item 0 > resolves_to > oneOf > item 1 > item 1 items](#autogenerated_heading_3)
- [2. Property `WfExS-backend cache metadata > oneOf > item 1`](#oneOf_i1)
  - [2.1. The following properties are required](#autogenerated_heading_4)
  - [2.2. Property `WfExS-backend cache metadata > oneOf > item 1 > kind`](#oneOf_i1_kind)
  - [2.3. Property `WfExS-backend cache metadata > oneOf > item 1 > fingerprint`](#oneOf_i1_fingerprint)
  - [2.4. Property `WfExS-backend cache metadata > oneOf > item 1 > path`](#oneOf_i1_path)
    - [2.4.1. Property `WfExS-backend cache metadata > oneOf > item 1 > path > relative`](#oneOf_i1_path_relative)
    - [2.4.2. Property `WfExS-backend cache metadata > oneOf > item 1 > path > absolute`](#oneOf_i1_path_absolute)
- [3. Property `WfExS-backend cache metadata > stamp`](#stamp)
- [4. Property `WfExS-backend cache metadata > licences`](#licences)
  - [4.1. WfExS-backend cache metadata > licences > licences items](#autogenerated_heading_5)
- [5. Property `WfExS-backend cache metadata > metadata_array`](#metadata_array)
  - [5.1. WfExS-backend cache metadata > metadata_array > metadata_array items](#autogenerated_heading_6)
    - [5.1.1. Property `WfExS-backend cache metadata > metadata_array > metadata_array items > uri`](#metadata_array_items_uri)
    - [5.1.2. Property `WfExS-backend cache metadata > metadata_array > metadata_array items > metadata`](#metadata_array_items_metadata)
      - [5.1.2.1. Property `WfExS-backend cache metadata > metadata_array > metadata_array items > metadata > oneOf > item 0`](#metadata_array_items_metadata_oneOf_i0)
        - [5.1.2.1.1. WfExS-backend cache metadata > metadata_array > metadata_array items > metadata > oneOf > item 0 > item 0 items](#autogenerated_heading_7)
      - [5.1.2.2. Property `WfExS-backend cache metadata > metadata_array > metadata_array items > metadata > oneOf > item 1`](#metadata_array_items_metadata_oneOf_i1)
    - [5.1.3. Property `WfExS-backend cache metadata > metadata_array > metadata_array items > preferredName`](#metadata_array_items_preferredName)

**Title:** WfExS-backend cache metadata

|                           |                                                                           |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type**                  | `combining`                                                               |
| **Required**              | No                                                                        |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |

**Description:** WfExS-backend cache metadata file (EOSC-Life Demonstrator 7 JSON Schemas)

| Property                             | Pattern | Type            | Deprecated | Definition | Title/Description                |
| ------------------------------------ | ------- | --------------- | ---------- | ---------- | -------------------------------- |
| - [stamp](#stamp )                   | No      | string          | No         | -          | When this cache entry was stored |
| - [licences](#licences )             | No      | array of string | No         | -          | -                                |
| - [metadata_array](#metadata_array ) | No      | array of object | No         | -          | -                                |

| One of(Option)      |
| ------------------- |
| [item 0](#oneOf_i0) |
| [item 1](#oneOf_i1) |

## <a name="oneOf_i0"></a>1. Property `WfExS-backend cache metadata > oneOf > item 0`

|                           |                                                                           |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type**                  | `object`                                                                  |
| **Required**              | No                                                                        |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |

| Property                                | Pattern | Type        | Deprecated | Definition | Title/Description                           |
| --------------------------------------- | ------- | ----------- | ---------- | ---------- | ------------------------------------------- |
| + [resolves_to](#oneOf_i0_resolves_to ) | No      | Combination | No         | -          | This metadata cache entry resolves to these |

### <a name="autogenerated_heading_2"></a>1.1. The following properties are required
* metadata_array

### <a name="oneOf_i0_resolves_to"></a>1.2. Property `WfExS-backend cache metadata > oneOf > item 0 > resolves_to`

|                           |                                                                           |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type**                  | `combining`                                                               |
| **Required**              | Yes                                                                       |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |

**Description:** This metadata cache entry resolves to these

| One of(Option)                           |
| ---------------------------------------- |
| [item 0](#oneOf_i0_resolves_to_oneOf_i0) |
| [item 1](#oneOf_i0_resolves_to_oneOf_i1) |

#### <a name="oneOf_i0_resolves_to_oneOf_i0"></a>1.2.1. Property `WfExS-backend cache metadata > oneOf > item 0 > resolves_to > oneOf > item 0`

|              |          |
| ------------ | -------- |
| **Type**     | `string` |
| **Required** | No       |
| **Format**   | `uri`    |

**Description:** This metadata cache entry resolves to a single URI

| Restrictions   |   |
| -------------- | - |
| **Min length** | 1 |

#### <a name="oneOf_i0_resolves_to_oneOf_i1"></a>1.2.2. Property `WfExS-backend cache metadata > oneOf > item 0 > resolves_to > oneOf > item 1`

|              |                   |
| ------------ | ----------------- |
| **Type**     | `array of string` |
| **Required** | No                |

**Description:** This metadata cache entry resolves to multiple URIs

|                      | Array restrictions |
| -------------------- | ------------------ |
| **Min items**        | 1                  |
| **Max items**        | N/A                |
| **Items unicity**    | False              |
| **Additional items** | False              |
| **Tuple validation** | See below          |

| Each item of this array must be                      | Description |
| ---------------------------------------------------- | ----------- |
| [item 1 items](#oneOf_i0_resolves_to_oneOf_i1_items) | -           |

##### <a name="autogenerated_heading_3"></a>1.2.2.1. WfExS-backend cache metadata > oneOf > item 0 > resolves_to > oneOf > item 1 > item 1 items

|              |          |
| ------------ | -------- |
| **Type**     | `string` |
| **Required** | No       |
| **Format**   | `uri`    |

| Restrictions   |   |
| -------------- | - |
| **Min length** | 1 |

## <a name="oneOf_i1"></a>2. Property `WfExS-backend cache metadata > oneOf > item 1`

|                           |                                                                           |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type**                  | `object`                                                                  |
| **Required**              | No                                                                        |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |

| Property                                | Pattern | Type             | Deprecated | Definition | Title/Description                                                                                                                  |
| --------------------------------------- | ------- | ---------------- | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| + [kind](#oneOf_i1_kind )               | No      | enum (of string) | No         | -          | Kind of cached content. It could be either a file or a directory                                                                   |
| + [fingerprint](#oneOf_i1_fingerprint ) | No      | string           | No         | -          | The fingerprint of the content, which is the name of the hashing algorithm, the '~' separator and the encoded hash in base64       |
| + [path](#oneOf_i1_path )               | No      | object           | No         | -          | Both the relative and absolute paths to the cached file or directory, using the base directory of the cached metadata as reference |

### <a name="autogenerated_heading_4"></a>2.1. The following properties are required
* metadata_array

### <a name="oneOf_i1_kind"></a>2.2. Property `WfExS-backend cache metadata > oneOf > item 1 > kind`

|              |                    |
| ------------ | ------------------ |
| **Type**     | `enum (of string)` |
| **Required** | Yes                |

**Description:** Kind of cached content. It could be either a file or a directory

Must be one of:
* "file"
* "dir"

### <a name="oneOf_i1_fingerprint"></a>2.3. Property `WfExS-backend cache metadata > oneOf > item 1 > fingerprint`

|              |                         |
| ------------ | ----------------------- |
| **Type**     | `string`                |
| **Required** | Yes                     |
| **Format**   | `^[^~]+~[A-Za-z0-9+/]+` |

**Description:** The fingerprint of the content, which is the name of the hashing algorithm, the '~' separator and the encoded hash in base64

### <a name="oneOf_i1_path"></a>2.4. Property `WfExS-backend cache metadata > oneOf > item 1 > path`

|                           |                                                                           |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type**                  | `object`                                                                  |
| **Required**              | Yes                                                                       |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |

**Description:** Both the relative and absolute paths to the cached file or directory, using the base directory of the cached metadata as reference

| Property                               | Pattern | Type   | Deprecated | Definition | Title/Description |
| -------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- |
| + [relative](#oneOf_i1_path_relative ) | No      | string | No         | -          | -                 |
| + [absolute](#oneOf_i1_path_absolute ) | No      | string | No         | -          | -                 |

#### <a name="oneOf_i1_path_relative"></a>2.4.1. Property `WfExS-backend cache metadata > oneOf > item 1 > path > relative`

|              |          |
| ------------ | -------- |
| **Type**     | `string` |
| **Required** | Yes      |

#### <a name="oneOf_i1_path_absolute"></a>2.4.2. Property `WfExS-backend cache metadata > oneOf > item 1 > path > absolute`

|              |          |
| ------------ | -------- |
| **Type**     | `string` |
| **Required** | Yes      |

## <a name="stamp"></a>3. Property `WfExS-backend cache metadata > stamp`

|              |             |
| ------------ | ----------- |
| **Type**     | `string`    |
| **Required** | No          |
| **Format**   | `date-time` |

**Description:** When this cache entry was stored

## <a name="licences"></a>4. Property `WfExS-backend cache metadata > licences`

|              |                   |
| ------------ | ----------------- |
| **Type**     | `array of string` |
| **Required** | No                |
| **Default**  | `[]`              |

|                      | Array restrictions |
| -------------------- | ------------------ |
| **Min items**        | N/A                |
| **Max items**        | N/A                |
| **Items unicity**    | False              |
| **Additional items** | False              |
| **Tuple validation** | See below          |

| Each item of this array must be   | Description |
| --------------------------------- | ----------- |
| [licences items](#licences_items) | -           |

### <a name="autogenerated_heading_5"></a>4.1. WfExS-backend cache metadata > licences > licences items

|              |                                               |
| ------------ | --------------------------------------------- |
| **Type**     | `string`                                      |
| **Required** | No                                            |
| **Format**   | `uri`                                         |
| **Default**  | `"https://choosealicense.com/no-permission/"` |

## <a name="metadata_array"></a>5. Property `WfExS-backend cache metadata > metadata_array`

|              |                   |
| ------------ | ----------------- |
| **Type**     | `array of object` |
| **Required** | No                |

|                      | Array restrictions |
| -------------------- | ------------------ |
| **Min items**        | N/A                |
| **Max items**        | N/A                |
| **Items unicity**    | False              |
| **Additional items** | False              |
| **Tuple validation** | See below          |

| Each item of this array must be               | Description |
| --------------------------------------------- | ----------- |
| [metadata_array items](#metadata_array_items) | -           |

### <a name="autogenerated_heading_6"></a>5.1. WfExS-backend cache metadata > metadata_array > metadata_array items

|                           |                                                                           |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type**                  | `object`                                                                  |
| **Required**              | No                                                                        |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |

| Property                                                | Pattern | Type           | Deprecated | Definition | Title/Description |
| ------------------------------------------------------- | ------- | -------------- | ---------- | ---------- | ----------------- |
| + [uri](#metadata_array_items_uri )                     | No      | string         | No         | -          | -                 |
| + [metadata](#metadata_array_items_metadata )           | No      | Combination    | No         | -          | -                 |
| - [preferredName](#metadata_array_items_preferredName ) | No      | string or null | No         | -          | -                 |

#### <a name="metadata_array_items_uri"></a>5.1.1. Property `WfExS-backend cache metadata > metadata_array > metadata_array items > uri`

|              |          |
| ------------ | -------- |
| **Type**     | `string` |
| **Required** | Yes      |
| **Format**   | `uri`    |

#### <a name="metadata_array_items_metadata"></a>5.1.2. Property `WfExS-backend cache metadata > metadata_array > metadata_array items > metadata`

|                           |                                                                           |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type**                  | `combining`                                                               |
| **Required**              | Yes                                                                       |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |

| One of(Option)                                    |
| ------------------------------------------------- |
| [item 0](#metadata_array_items_metadata_oneOf_i0) |
| [item 1](#metadata_array_items_metadata_oneOf_i1) |

##### <a name="metadata_array_items_metadata_oneOf_i0"></a>5.1.2.1. Property `WfExS-backend cache metadata > metadata_array > metadata_array items > metadata > oneOf > item 0`

|              |                   |
| ------------ | ----------------- |
| **Type**     | `array of object` |
| **Required** | No                |

|                      | Array restrictions |
| -------------------- | ------------------ |
| **Min items**        | N/A                |
| **Max items**        | N/A                |
| **Items unicity**    | False              |
| **Additional items** | False              |
| **Tuple validation** | See below          |

| Each item of this array must be                               | Description |
| ------------------------------------------------------------- | ----------- |
| [item 0 items](#metadata_array_items_metadata_oneOf_i0_items) | -           |

###### <a name="autogenerated_heading_7"></a>5.1.2.1.1. WfExS-backend cache metadata > metadata_array > metadata_array items > metadata > oneOf > item 0 > item 0 items

|                           |                                                                           |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type**                  | `object`                                                                  |
| **Required**              | No                                                                        |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |

##### <a name="metadata_array_items_metadata_oneOf_i1"></a>5.1.2.2. Property `WfExS-backend cache metadata > metadata_array > metadata_array items > metadata > oneOf > item 1`

|                           |                                                                           |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type**                  | `object`                                                                  |
| **Required**              | No                                                                        |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |

#### <a name="metadata_array_items_preferredName"></a>5.1.3. Property `WfExS-backend cache metadata > metadata_array > metadata_array items > preferredName`

|              |                  |
| ------------ | ---------------- |
| **Type**     | `string or null` |
| **Required** | No               |

----------------------------------------------------------------------------------------------------------------------------
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-09-19 at 23:38:46 +0000
