# WfExS-backend exports definition - [1. Property `WfExS-backend exports definition > exports`](#exports) - [1.1. WfExS-backend exports definition > exports > ExportAction](#autogenerated_heading_2) - [1.1.1. Property `WfExS-backend exports definition > exports > exports items > id`](#exports_items_id) - [1.1.2. Property `WfExS-backend exports definition > exports > exports items > plugin`](#exports_items_plugin) - [1.1.3. Property `WfExS-backend exports definition > exports > exports items > what`](#exports_items_what) - [1.1.3.1. WfExS-backend exports definition > exports > exports items > what > what items](#autogenerated_heading_3) - [1.1.3.1.1. Property `WfExS-backend exports definition > exports > exports items > what > what items > oneOf > item 0`](#exports_items_what_items_oneOf_i0) - [1.1.3.1.2. Property `WfExS-backend exports definition > exports > exports items > what > what items > oneOf > item 1`](#exports_items_what_items_oneOf_i1) - [1.1.3.1.3. Property `WfExS-backend exports definition > exports > exports items > what > what items > oneOf > item 2`](#exports_items_what_items_oneOf_i2) - [1.1.3.1.4. Property `WfExS-backend exports definition > exports > exports items > what > what items > oneOf > item 3`](#exports_items_what_items_oneOf_i3) - [1.1.4. Property `WfExS-backend exports definition > exports > exports items > preferred-pid`](#exports_items_preferred-pid) - [1.1.5. Property `WfExS-backend exports definition > exports > exports items > title`](#exports_items_title) - [1.1.6. Property `WfExS-backend exports definition > exports > exports items > documentation`](#exports_items_documentation) - [1.1.7. Property `WfExS-backend exports definition > exports > exports items > custom-metadata`](#exports_items_custom-metadata) - [1.1.8. Property `WfExS-backend exports definition > exports > exports items > community-custom-metadata`](#exports_items_community-custom-metadata) - [1.1.9. Property `WfExS-backend exports definition > exports > exports items > licences`](#exports_items_licences) - [1.1.9.1. WfExS-backend exports definition > exports > exports items > licences > licences items](#autogenerated_heading_4) - [1.1.9.1.1. Property `WfExS-backend exports definition > exports > exports items > licences > licences items > oneOf > item 0`](#exports_items_licences_items_oneOf_i0) - [1.1.9.1.2. Property `WfExS-backend exports definition > exports > exports items > licences > licences items > oneOf > item 1`](#exports_items_licences_items_oneOf_i1) - [1.1.10. Property `WfExS-backend exports definition > exports > exports items > preferred-scheme`](#exports_items_preferred-scheme) - [1.1.11. Property `WfExS-backend exports definition > exports > exports items > security-context`](#exports_items_security-context) - [1.1.12. Property `WfExS-backend exports definition > exports > exports items > setup`](#exports_items_setup) **Title:** WfExS-backend exports definition | | | | ------------------------- | ------------------------------------------------------- | | **Type** | `object` | | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | **Description:** WfExS-backend stage definition file (EOSC-Life Demonstrator 7 JSON Schemas) | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------- | ------- | ----- | ---------- | ----------------------- | ----------------- | | + [exports](#exports ) | No | array | No | In #/$defs/ExportsBlock | - | ## 1. Property `WfExS-backend exports definition > exports` | | | | -------------- | -------------------- | | **Type** | `array` | | **Required** | Yes | | **Defined in** | #/$defs/ExportsBlock | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | N/A | | **Max items** | N/A | | **Items unicity** | True | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | ------------------------------- | ----------- | | [ExportAction](#exports_items) | - | ### 1.1. WfExS-backend exports definition > exports > ExportAction | | | | ------------------------- | ------------------------------------------------------------------------- | | **Type** | `object` | | **Required** | No | | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | | **Defined in** | #/$defs/ExportAction | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------ | ------- | --------------- | ---------- | ---------- | ---------------------------------------------------------------------------------------- | | + [id](#exports_items_id ) | No | string | No | - | A unique, symbolic name for this export action | | + [plugin](#exports_items_plugin ) | No | string | No | - | The plugin to be used to export the contents, and obtain a permanent / public identifier | | + [what](#exports_items_what ) | No | array | No | - | What output(s) to export | | - [preferred-pid](#exports_items_preferred-pid ) | No | string | No | - | - | | - [title](#exports_items_title ) | No | string | No | - | - | | - [documentation](#exports_items_documentation ) | No | string | No | - | - | | - [custom-metadata](#exports_items_custom-metadata ) | No | object | No | - | - | | - [community-custom-metadata](#exports_items_community-custom-metadata ) | No | object | No | - | - | | - [licences](#exports_items_licences ) | No | array of string | No | - | - | | - [preferred-scheme](#exports_items_preferred-scheme ) | No | string | No | - | - | | - [security-context](#exports_items_security-context ) | No | string | No | - | - | | - [setup](#exports_items_setup ) | No | object | No | - | - | #### 1.1.1. Property `WfExS-backend exports definition > exports > exports items > id` **Title:** A unique, symbolic name for this export action | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | | Restrictions | | | -------------- | - | | **Min length** | 1 | #### 1.1.2. Property `WfExS-backend exports definition > exports > exports items > plugin` **Title:** The plugin to be used to export the contents, and obtain a permanent / public identifier | | | | ------------ | -------- | | **Type** | `string` | | **Required** | Yes | | Restrictions | | | -------------- | - | | **Min length** | 1 | #### 1.1.3. Property `WfExS-backend exports definition > exports > exports items > what` **Title:** What output(s) to export | | | | ------------ | ------- | | **Type** | `array` | | **Required** | Yes | | | Array restrictions | | -------------------- | ------------------ | | **Min items** | 1 | | **Max items** | N/A | | **Items unicity** | True | | **Additional items** | False | | **Tuple validation** | See below | | Each item of this array must be | Description | | --------------------------------------- | ----------- | | [what items](#exports_items_what_items) | - | ##### 1.1.3.1. WfExS-backend exports definition > exports > exports items > what > what items | | | | ------------------------- | ------------------------------------------------------------------------- | | **Type** | `combining` | | **Required** | No | | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | | One of(Option) | | -------------------------------------------- | | [item 0](#exports_items_what_items_oneOf_i0) | | [item 1](#exports_items_what_items_oneOf_i1) | | [item 2](#exports_items_what_items_oneOf_i2) | | [item 3](#exports_items_what_items_oneOf_i3) | ###### 1.1.3.1.1. Property `WfExS-backend exports definition > exports > exports items > what > what items > oneOf > item 0` | | | | ------------ | ------- | | **Type** | `const` | | **Required** | No | Specific value: `":working-directory:"` ###### 1.1.3.1.2. Property `WfExS-backend exports definition > exports > exports items > what > what items > oneOf > item 1` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Must match regular expression** | ```^:stage-rocrate:(full\|(inputs\|workflow\|containers)(,(inputs\|workflow\|containers))*)?$``` [Test](https://regex101.com/?regex=%5E%3Astage-rocrate%3A%28full%7C%28inputs%7Cworkflow%7Ccontainers%29%28%2C%28inputs%7Cworkflow%7Ccontainers%29%29%2A%29%3F%24) | ###### 1.1.3.1.3. Property `WfExS-backend exports definition > exports > exports items > what > what items > oneOf > item 2` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | Restrictions | | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Must match regular expression** | ```^:provenance-rocrate:(full\|(inputs\|outputs\|workflow\|containers)(,(inputs\|outputs\|workflow\|containers))*)?$``` [Test](https://regex101.com/?regex=%5E%3Aprovenance-rocrate%3A%28full%7C%28inputs%7Coutputs%7Cworkflow%7Ccontainers%29%28%2C%28inputs%7Coutputs%7Cworkflow%7Ccontainers%29%29%2A%29%3F%24) | ###### 1.1.3.1.4. Property `WfExS-backend exports definition > exports > exports items > what > what items > oneOf > item 3` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Must match regular expression** | ```^(param\|envvar\|output):([^:;]+:)?[^:;]*$``` [Test](https://regex101.com/?regex=%5E%28param%7Cenvvar%7Coutput%29%3A%28%5B%5E%3A%3B%5D%2B%3A%29%3F%5B%5E%3A%3B%5D%2A%24) | #### 1.1.4. Property `WfExS-backend exports definition > exports > exports items > preferred-pid` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | Restrictions | | | -------------- | - | | **Min length** | 1 | #### 1.1.5. Property `WfExS-backend exports definition > exports > exports items > title` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | Restrictions | | | -------------- | - | | **Min length** | 1 | #### 1.1.6. Property `WfExS-backend exports definition > exports > exports items > documentation` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | Restrictions | | | -------------- | - | | **Min length** | 1 | #### 1.1.7. Property `WfExS-backend exports definition > exports > exports items > custom-metadata` | | | | ------------------------- | ------------------------------------------------------------------------- | | **Type** | `object` | | **Required** | No | | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | #### 1.1.8. Property `WfExS-backend exports definition > exports > exports items > community-custom-metadata` | | | | ------------------------- | ------------------------------------------------------------------------- | | **Type** | `object` | | **Required** | No | | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | #### 1.1.9. Property `WfExS-backend exports definition > exports > exports items > licences` | | | | ------------ | ----------------- | | **Type** | `array of string` | | **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 | | ----------------------------------------------- | ----------- | | [licences items](#exports_items_licences_items) | - | ##### 1.1.9.1. WfExS-backend exports definition > exports > exports items > licences > licences items | | | | ------------ | ----------- | | **Type** | `combining` | | **Required** | No | | One of(Option) | | ------------------------------------------------ | | [item 0](#exports_items_licences_items_oneOf_i0) | | [item 1](#exports_items_licences_items_oneOf_i1) | ###### 1.1.9.1.1. Property `WfExS-backend exports definition > exports > exports items > licences > licences items > oneOf > item 0` | | | | ------------------------- | ------------------------------------------------------------------------- | | **Type** | `object` | | **Required** | No | | **Format** | `uri` | | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | ###### 1.1.9.1.2. Property `WfExS-backend exports definition > exports > exports items > licences > licences items > oneOf > item 1` | | | | ------------ | ------------------ | | **Type** | `enum (of string)` | | **Required** | No | Must be one of: * "AFL-3.0" * "APL-1.0" * "Apache-1.1" * "Apache-2.0" * "APSL-2.0" * "Artistic-2.0" * "AAL" * "BSD-2-Clause" * "BSD-3-Clause" * "BitTorrent-1.1" * "BSL-1.0" * "CC0-1.0" * "CNRI-Python" * "CUA-OPL-1.0" * "CECILL-2.1" * "CDDL-1.0" * "CPAL-1.0" * "CATOSL-1.1" * "EUDatagrid" * "EPL-1.0" * "ECL-2.0" * "EFL-2.0" * "Entessa" * "EUPL-1.1" * "Fair" * "Frameworx-1.0" * "AGPL-3.0" * "GPL-2.0" * "GPL-3.0" * "LGPL-2.1" * "LGPL-3.0" * "HPND" * "IPL-1.0" * "IPA" * "ISC" * "Intel" * "LPPL-1.3c" * "LPL-1.0" * "LPL-1.02" * "MIT" * "mitre" * "MS-PL" * "MS-RL" * "MirOS" * "Motosoto" * "MPL-1.0" * "MPL-1.1" * "MPL-2.0" * "Multics" * "NASA-1.3" * "NTP" * "Naumen" * "NGPL" * "Nokia" * "NPOSL-3.0" * "OCLC-2.0" * "OFL-1.1" * "OGL-UK-1.0" * "OGL-UK-2.0" * "OGL-UK-3.0" * "OGTSL" * "OSL-3.0" * "PHP-3.0" * "PostgreSQL" * "Python-2.0" * "QPL-1.0" * "RPSL-1.0" * "RPL-1.5" * "RSCPL" * "SimPL-2.0" * "Sleepycat" * "SISSL" * "SPL-1.0" * "Watcom-1.0" * "NCSA" * "Unlicense" * "VSL-1.0" * "W3C" * "Xnet" * "ZPL-2.0" * "WXwindows" * "Zlib" * "notspecified" | Restrictions | | | -------------- | - | | **Min length** | 1 | #### 1.1.10. Property `WfExS-backend exports definition > exports > exports items > preferred-scheme` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | Restrictions | | | -------------- | - | | **Min length** | 1 | #### 1.1.11. Property `WfExS-backend exports definition > exports > exports items > security-context` | | | | ------------ | -------- | | **Type** | `string` | | **Required** | No | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------- | | **Min length** | 1 | | **Must match regular expression** | ```^[^:;]+$``` [Test](https://regex101.com/?regex=%5E%5B%5E%3A%3B%5D%2B%24) | #### 1.1.12. Property `WfExS-backend exports definition > exports > exports items > setup` | | | | ------------------------- | ------------------------------------------------------------------------- | | **Type** | `object` | | **Required** | No | | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-09-19 at 23:38:46 +0000