Skip to content

Commit

Permalink
JSON Schemas to Markdown - 2023-01-11
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions Bot committed Jan 11, 2023
1 parent 3e736c4 commit d4b6155
Show file tree
Hide file tree
Showing 64 changed files with 1,405 additions and 153 deletions.
8 changes: 5 additions & 3 deletions docs/json_browser/markdowns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@

* [Assay technology](./ega-12-definitions-assay-technology.md "Metadata of the assay instrument (e")`https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.common-definitions.json#/definitions/assayTechnologyDescriptor`

* [Assay type specifications](./ega-11-properties-assay-type-specifications.md "Node containing different sets of fields that depend on the specific assay type")`https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/properties/assayTypeSpecifications`
* [Assay type specifications](./ega-11-properties-assay-type-specifications.md "Node containing different sets of fields that depend on the instrument used for the assay: either array assays (those in which an array instrument \[EFO:0002698] was used) or sequencing assays (those in which a sequencing instrument \[EFO:0003739] was used)")`https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/properties/assayTypeSpecifications`

* [Assayed biological macromolecule](./ega-9-properties-assayed-biological-macromolecule.md "Node containing information about the assayed biological macromolecule: the material entity (e")`https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.experiment.json#/properties/assayedBiologicalMacromolecule`

* [Basecall](./ega-12-definitions-spot-descriptor-spot-decode-spec-properties-read-specs-read-spec-properties-expected-basecall-table-properties-basecalls-array-basecall.md)`https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.common-definitions.json#/definitions/spotDescriptor/items/properties/readSpecs/items/properties/expectedBasecallTable/properties/basecalls/items`

Expand Down Expand Up @@ -264,7 +266,7 @@

* [Source of the relationship](./ega-12-definitions-ega-relationships-object-properties-source-of-the-relationship.md "Object reference of the relationship's source")`https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.common-definitions.json#/definitions/relationshipObject/properties/rSource`

* [Specifications of a sequencing assay](./ega-11-properties-assay-type-specifications-properties-specifications-of-a-sequencing-assay.md "Node containing the set of fields specific to an assay of type 'sequencing' (i")`https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/properties/assayTypeSpecifications/properties/sequencingAssaySpecifications`
* [Specifications of a sequencing assay](./ega-11-properties-assay-type-specifications-properties-specifications-of-a-sequencing-assay.md "Node containing the set of fields specific to an assay of type 'sequencer' (i")`https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/properties/assayTypeSpecifications/properties/sequencingAssaySpecifications`

* [Specifications of a sequencing experiment](./ega-9-properties-experiment-type-specifications-properties-specifications-of-a-sequencing-experiment.md "Node containing the set of fields specific to an experiment of sequencing-type (i")`https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.experiment.json#/properties/experimentTypeSpecifications/properties/sequencingExperiment`

Expand All @@ -278,7 +280,7 @@

* [Target of the relationship](./ega-12-definitions-ega-relationships-object-properties-target-of-the-relationship.md "Object reference of the relationship's target")`https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.common-definitions.json#/definitions/relationshipObject/properties/rTarget`

* [Type of assay](./ega-9-properties-type-of-assay.md "Node defining the type of assay applicable to the experiment")`https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.experiment.json#/properties/assayTypeDescriptor`
* [Type of used assay](./ega-9-properties-type-of-used-assay.md "Node defining the type of assay applicable to the experiment")`https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.experiment.json#/properties/assayType`

### Arrays

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Untitled undefined type in EGA assay metadata schema Schema

```txt
https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/allOf/1/if/properties/assayTypeSpecifications/properties/assayInstrument
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [EGA.assay.json\*](../../../schemas/EGA.assay.json "open original schema") |

## assayInstrument Type

unknown

## assayInstrument Constraints

**constant**: the value of this property must be equal to:

```json
"sequencer"
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,32 +16,32 @@ unknown

# assayTypeSpecifications Properties

| Property | Type | Required | Nullable | Defined by |
| :---------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [assayType](#assaytype) | Not specified | Optional | cannot be null | [EGA assay metadata schema](ega-11-allof-allowed-filetypes-for-a-sequencing-assay-if-properties-assaytypespecifications-properties-assaytype.md "https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/allOf/1/if/properties/assayTypeSpecifications/properties/assayType") |
| Property | Type | Required | Nullable | Defined by |
| :---------------------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [assayInstrument](#assayinstrument) | Not specified | Optional | cannot be null | [EGA assay metadata schema](ega-11-allof-allowed-filetypes-for-a-sequencing-assay-if-properties-assaytypespecifications-properties-assayinstrument.md "https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/allOf/1/if/properties/assayTypeSpecifications/properties/assayInstrument") |

## assayType
## assayInstrument



`assayType`
`assayInstrument`

* is optional

* Type: unknown

* cannot be null

* defined in: [EGA assay metadata schema](ega-11-allof-allowed-filetypes-for-a-sequencing-assay-if-properties-assaytypespecifications-properties-assaytype.md "https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/allOf/1/if/properties/assayTypeSpecifications/properties/assayType")
* defined in: [EGA assay metadata schema](ega-11-allof-allowed-filetypes-for-a-sequencing-assay-if-properties-assaytypespecifications-properties-assayinstrument.md "https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/allOf/1/if/properties/assayTypeSpecifications/properties/assayInstrument")

### assayType Type
### assayInstrument Type

unknown

### assayType Constraints
### assayInstrument Constraints

**constant**: the value of this property must be equal to:

```json
"sequencing"
"sequencer"
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Untitled undefined type in EGA assay metadata schema Schema

```txt
https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/allOf/2/if/properties/assayTypeSpecifications/properties/assayInstrument
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [EGA.assay.json\*](../../../schemas/EGA.assay.json "open original schema") |

## assayInstrument Type

unknown

## assayInstrument Constraints

**constant**: the value of this property must be equal to:

```json
"array"
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,29 @@ unknown

# assayTypeSpecifications Properties

| Property | Type | Required | Nullable | Defined by |
| :---------------------- | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [assayType](#assaytype) | Not specified | Optional | cannot be null | [EGA assay metadata schema](ega-11-allof-allowed-filetypes-for-an-array-assay-if-properties-assaytypespecifications-properties-assaytype.md "https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/allOf/2/if/properties/assayTypeSpecifications/properties/assayType") |
| Property | Type | Required | Nullable | Defined by |
| :---------------------------------- | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [assayInstrument](#assayinstrument) | Not specified | Optional | cannot be null | [EGA assay metadata schema](ega-11-allof-allowed-filetypes-for-an-array-assay-if-properties-assaytypespecifications-properties-assayinstrument.md "https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/allOf/2/if/properties/assayTypeSpecifications/properties/assayInstrument") |

## assayType
## assayInstrument



`assayType`
`assayInstrument`

* is optional

* Type: unknown

* cannot be null

* defined in: [EGA assay metadata schema](ega-11-allof-allowed-filetypes-for-an-array-assay-if-properties-assaytypespecifications-properties-assaytype.md "https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/allOf/2/if/properties/assayTypeSpecifications/properties/assayType")
* defined in: [EGA assay metadata schema](ega-11-allof-allowed-filetypes-for-an-array-assay-if-properties-assaytypespecifications-properties-assayinstrument.md "https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/allOf/2/if/properties/assayTypeSpecifications/properties/assayInstrument")

### assayType Type
### assayInstrument Type

unknown

### assayType Constraints
### assayInstrument Constraints

**constant**: the value of this property must be equal to:

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Untitled undefined type in EGA assay metadata schema Schema

```txt
https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/properties/assayTypeSpecifications/allOf/0/if/properties/assayInstrument
```



| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [EGA.assay.json\*](../../../schemas/EGA.assay.json "open original schema") |

## assayInstrument Type

unknown

## assayInstrument Constraints

**enum**: the value of this property must be equal to one of the following values:

| Value | Explanation |
| :-------- | :---------- |
| `"array"` | |
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,29 @@ unknown

# if Properties

| Property | Type | Required | Nullable | Defined by |
| :---------------------- | :------------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [assayType](#assaytype) | Not specified | Required | cannot be null | [EGA assay metadata schema](ega-11-properties-assay-type-specifications-allof-if-the-assay-is-of-type-array-its-specifications-will-be-expected-if-properties-assaytype.md "https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/properties/assayTypeSpecifications/allOf/0/if/properties/assayType") |
| Property | Type | Required | Nullable | Defined by |
| :---------------------------------- | :------------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [assayInstrument](#assayinstrument) | Not specified | Required | cannot be null | [EGA assay metadata schema](ega-11-properties-assay-type-specifications-allof-if-the-assay-is-of-type-array-its-specifications-will-be-expected-if-properties-assayinstrument.md "https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/properties/assayTypeSpecifications/allOf/0/if/properties/assayInstrument") |

## assayType
## assayInstrument



`assayType`
`assayInstrument`

* is required

* Type: unknown

* cannot be null

* defined in: [EGA assay metadata schema](ega-11-properties-assay-type-specifications-allof-if-the-assay-is-of-type-array-its-specifications-will-be-expected-if-properties-assaytype.md "https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/properties/assayTypeSpecifications/allOf/0/if/properties/assayType")
* defined in: [EGA assay metadata schema](ega-11-properties-assay-type-specifications-allof-if-the-assay-is-of-type-array-its-specifications-will-be-expected-if-properties-assayinstrument.md "https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/properties/assayTypeSpecifications/allOf/0/if/properties/assayInstrument")

### assayType Type
### assayInstrument Type

unknown

### assayType Constraints
### assayInstrument Constraints

**enum**: the value of this property must be equal to one of the following values:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Untitled undefined type in EGA assay metadata schema Schema

```txt
https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/properties/assayTypeSpecifications/properties/assayType/meta:enum
https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.assay.json#/properties/assayTypeSpecifications/properties/assayInstrument/meta:enum
```


Expand Down
Loading

0 comments on commit d4b6155

Please sign in to comment.