repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
ga4gh-beacon/beacon-v2 | bf2d78821c80404be777c9f0df35f79e8424bbd6 | 2022-03-24T08:35:39 | models/json/beacon-v2-default-model/common/commonDefinitions.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Ethnicity": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json",
"description": "Ethnic background of the individual. Recommended is the use of a value from NCIT Race (NCIT:C17049) ontology term descendants, e.g. NCIT:C126531 (Latin American). A geographic ancestral origin category that is assigned to a population group based mainly on physical characteristics that are thought to be distinct and inherent. [ NCI ]",
"examples": [
{
"id": "NCIT:C42331",
"label": "African"
},
{
"id": "NCIT:C41260",
"label": "Asian"
},
{
"id": "NCIT:C126535",
"label": "Australian"
},
{
"id": "NCIT:C43851",
"label": "European"
},
{
"id": "NCIT:C77812",
"label": "North American"
},
{
"id": "NCIT:C126531",
"label": "Latin American"
},
{
"id": "NCIT:C104495",
"label": "Other race"
}
]
},
"GeographicLocation": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json",
"description": "Country or region of origin of the individual (birthplace or residence place regardless of ethnic origin). Value from GAZ Geographic Location ontology (GAZ:00000448), e.g. GAZ:00002459 (United States of America).",
"examples": [
{
"id": "GAZ:00002955",
"label": "Slovenia"
},
{
"id": "GAZ:00002459",
"label": "United States of America"
},
{
"id": "GAZ:00316959",
"label": "Municipality of El Masnou"
},
{
"id": "GAZ:00000460",
"label": "Eurasia"
}
]
},
"KaryotypicSex": {
"$comments": "Compares to https://github.com/phenopackets/phenopacket-schema/blob/master/docs/karyotypicsex.rst",
"default": "UNKNOWN_KARYOTYPE",
"description": "The chromosomal sex of an individual represented from a selection of options. The values correspond to the ordinal values in the Phenopackets schema where: 0 - UNKNOWN_KARYOTYPE (Untyped or inconclusive karyotyping); 1 - XX (Female); 2 - XY (Male); 3 - XO (Single X chromosome only); 4 - XXY (Two X and one Y chromosome); 5 - XXX (Three X chromosomes); 6 - XXYY (Two X chromosomes and two Y chromosomes); 7 - XXXY (Three X chromosomes and one Y chromosome); 8 - XXXX (Four X chromosomes); 9 - XYY (One X and two Y chromosomes); 10 - OTHER_KARYOTYPE (None of the above types)",
"enum": [
"UNKNOWN_KARYOTYPE",
"XX",
"XY",
"XO",
"XXY",
"XXX",
"XXYY",
"XXXY",
"XXXX",
"XYY",
"OTHER_KARYOTYPE"
],
"type": "string"
},
"SeverityLevel": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json",
"description": "Severity as applicable to phenotype or disease observed. Recommended are values from Human Phenotype Ontology (HP:0012824), e.g `mild`. The intensity or degree of a manifestation. Source: Phenopackets v2",
"examples": [
{
"id": "HP:0012828",
"label": "Severe"
},
{
"id": "HP:0012829",
"label": "Profound"
},
{
"id": "HP:0012826",
"label": "Moderate"
},
{
"id": "HP:0012825",
"label": "Mild"
},
{
"id": "HP:0012827",
"label": "Borderline"
}
]
},
"Sex": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json",
"description": "Sex of the individual. Recommended values from NCIT General Qualifier (NCIT:C27993): \"unknown\" (not assessed or not available) - NCIT:C17998; \"female\" - NCIT:C16576; \"male\" - NCIT:C20197",
"examples": [
{
"id": "NCIT:C16576",
"label": "female"
},
{
"id": "NCIT:C20197",
"label": "male"
},
{
"id": "NCIT:C1799",
"label": "unknown"
}
]
},
"Timestamp": {
"description": "Time in date-time ISO8601 string format.",
"examples": [
"1999-08-05T17:21:00+01:00",
"2002-09-21T02:37:00-08:00"
],
"format": "date-time",
"type": "string"
},
"Unit": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json",
"description": "The kind of unit. Recommended from NCIT Unit of Category ontology term (NCIT:C42568) descendants",
"examples": [
{
"id": "NCIT:C70575",
"label": "Roentgen"
},
{
"id": "NCIT:C28252",
"label": "Kilogram"
},
{
"id": "NCIT:C28253",
"label": "Milligram"
}
]
}
},
"description": "Definitions for concepts used in several entry types, but that having only one property are not complex enough to require a full independent schema document.",
"title": "Common Definitions"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 89ed443fecde703f259d5ec169ceeede37db72f9 | 2022-03-09T07:58:30 | models/json/beacon-v2-default-model/analyses/examples/analyses-MIN-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"analysisDate": "2021-10-17",
"id": "analyses-example-0001",
"pipelineName": "Pipeline-panel-0001-v1"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/responses/examples-sections/beaconCountResponseSection-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"exists": true,
"numTotalResults": 45363
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 60904b990df006b581ad41b9562360edb97402c4 | 2022-03-23T10:10:35 | models/json/beacon-v2-default-model/genomicVariations/examples/genomicVariant-MIN-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"variantInternalId": "GRCh37-1-55505652-G-A",
"variation": {
"alternateBases": "A",
"location": {
"interval": {
"end": {
"type": "Number",
"value": 5505653
},
"start": {
"type": "Number",
"value": 5505652
},
"type": "SequenceInterval"
},
"sequenceId": "refseq:NC_000001.10",
"type": "SequenceLocation"
},
"variantType": "SNP"
}
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 283bdfd38d9bdcabb64d30631e2b6615e559f6fb | 2022-07-19T07:37:45 | models/json/beacon-v2-default-model/common/phenotypicFeature.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {},
"description": "Used to describe a phenotype that characterizes the subject or biosample.",
"properties": {
"evidence": {
"$ref": "./evidence.json",
"description": "The evidence for an assertion of the observation of a type. RECOMMENDED."
},
"excluded": {
"default": false,
"description": "Flag to indicate whether the phenotypic feature was observed or not. Default is \u2018false\u2019, in other words the phenotype was observed. Therefore it is only used in cases where the phenotype was looked for but found to be absent. More formally, this modifier indicates the logical negation of the OntologyClass used in the `featureType` field. CAUTION: It is imperative to check this field for correct interpretation of the phenotype! Source: Phenopackets v2",
"type": "boolean"
},
"featureType": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json",
"description": "Term denoting the phenotypic feature, preferably using a value from Human Phenotype Ontology (HPO)",
"examples": [
{
"id": "HP:0000002",
"label": "Abnormality of body height"
},
{
"id": "HP:0002006",
"label": "Facial cleft"
},
{
"id": "HP:0012469",
"label": "Infantile spasms"
}
]
},
"modifiers": {
"description": "This subontology is designed to provide terms to characterize and specify the phenotypic abnormalities defined in the Phenotypic abnormality subontology, with respect to severity, laterality, age of onset, and other aspects. Example use here would be one or more terms from HPO Clinical Modifier (HP:0012823). Source: Phenopackets v2",
"examples": [
{
"id": "HP:0032500",
"label": "Exacerbated by tobacco use"
},
{
"id": "HP:4000053",
"label": "Displaced fracture"
}
],
"items": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json"
},
"type": "array"
},
"notes": {
"description": "Unstructured text to describe additional properties of this phenotypic feature.",
"example": "Some free text",
"type": "string"
},
"onset": {
"$ref": "./timeElement.json",
"description": "Age or time at which the feature was first observed."
},
"resolution": {
"$ref": "./timeElement.json",
"description": "Age or time at which the feature resolved or abated."
},
"severity": {
"$ref": "./commonDefinitions.json#/definitions/SeverityLevel",
"examples": [
{
"id": "HP:0012828",
"label": "Severe"
},
{
"id": "HP:0012826",
"label": "Moderate"
}
]
}
},
"required": [
"featureType"
],
"title": "PhenotypicFeature",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 3e6093cf1b20ac74bc021c315511094f930be1ef | 2022-02-22T11:21:39 | framework/json/responses/examples-fullDocuments/beaconEntryTypesResponse-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"info": {},
"meta": {
"apiVersion": "string",
"beaconId": "string",
"returnedSchemas": [
{
"entityType": "info",
"schema": "beacon-map-v2.0.0"
}
]
},
"response": {
"$schema": "../../configuration/entryTypesSchema.json",
"entryTypes": {
"dataset": {
"aCollectionOf": [
{
"id": "exampleEntry",
"name": "Example entries"
}
],
"additionallySupportedSchemas": [],
"defaultSchema": {
"id": "datasetDefaultSchema",
"name": "Default schema for datasets",
"referenceToSchemaDefinition": "./datasets/defaultSchema.json",
"schemaVersion": "v.2"
},
"description": "A Dataset is a collection of records, like rows in a database or cards in a cardholder.",
"endpoint": "/datasets",
"filteringTermsReference": "./datasets/filteringTerms.json",
"id": "dataset",
"name": "Dataset",
"ontologyTermForThisType": {
"id": "NCIT:C47824",
"label": "Data set"
},
"partOfSpecification": "Beacon v2.0"
},
"exampleEntry": {
"additionallySupportedSchemas": [],
"defaultSchema": {
"id": "ExampleEntryTypeDefaultschema",
"name": "Default schema for an example entries",
"referenceToSchemaDefinition": "./exampleEntry/defaultSchema.json",
"schemaVersion": "v.2"
},
"description": "A generic entry type to allow testing and playing with the specification.",
"endpoint": "./exampleEntries",
"filteringTermsReference": "./exampleEntry/filteringTerms.json",
"id": "exampleEntry",
"name": "Example Entry",
"ontologyTermForThisType": {
"id": "NCIT:C20181",
"label": "Conceptual Entity"
},
"partOfSpecification": "Beacon v2.0"
}
}
}
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 76473abf60e91dc993a3e1cd2e63bca8b64c30e9 | 2022-07-01T12:47:44 | framework/json/common/beaconCommonComponents.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"$schema": {
"$comment": "TO REVIEW: adding a `format` or `regex` attribute that validates correctly against a file path (relative).",
"description": "Refers to the JSON Schema which describes the set of valid attributes for this particular document type. This attribute is mostly used in schemas that should be tested in Beacon implementations.",
"type": "string"
},
"ApiVersion": {
"description": "an API version.",
"example": "v2.0",
"type": "string"
},
"BeaconError": {
"description": "Beacon-specific error.",
"properties": {
"errorCode": {
"description": "Entry not found",
"examples": [
"404"
],
"format": "int32",
"type": "integer"
},
"errorMessage": {
"examples": [
"the provided parameters are incomplete. 'xyz' is missing."
],
"type": "string"
}
},
"required": [
"errorCode"
],
"type": "object"
},
"BeaconId": {
"description": "the Id of a Beacon. Usually a reversed domain string, but any URI is acceptable. The purpose of this attribute is, in the context of a Beacon network, to disambiguate responses coming from different Beacons.",
"example": "org.example.beacon.v2",
"type": "string"
},
"CURIE": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"Exists": {
"description": "Indicator of whether any record was observed in any of the collections queried. This should be non-null.",
"examples": [
true
],
"type": "boolean"
},
"Filters": {
"description": "Ontology based filters. A CURIE syntax is encouraged to be used.",
"example": [
"BTO:0000199",
"PATO:0000383"
],
"items": {
"type": "string"
},
"type": "array"
},
"Granularity": {
"default": "boolean",
"description": "Granularity or level of detail of the response:\n* `boolean`: returns true/false' responses * `count`: adds the total number of positive results found * `aggregated`: returns summary, aggregated or distribution like responses * `record`: returns details for every row. In cases where a Beacon prefers\n to return records with fewer than allattributes, different strategies have\n to be considered w/o adding them to the current design, e.g.:\n - keeping non-mandatory attributes empty\n - Beacon to provide a minimal record definition",
"enum": [
"boolean",
"count",
"aggregated",
"record"
],
"type": "string"
},
"Handover": {
"description": "A handover is a typed link for attaching actionable links to results, non purely informational, requests. The goal of the handovers is to list the different actions available, e.g.:\n* a link to a request access page * linking to a file for download, e.g. a VCF file\nAnother common scenario is to provide a fast summary response (e.g. BeconCountResponse) and to provide access to different endpoints for the entities matched by the query using temporary access tokens in the handover URLs.",
"properties": {
"handoverType": {
"$ref": "#/definitions/HandoverType"
},
"note": {
"description": "An optional text including considerations on the handover link provided.",
"example": "This handover link provides access to a summarized VCF.",
"type": "string"
},
"url": {
"description": "URL endpoint to where the handover process could progress, in RFC3986 format",
"example": "https://api.mygenomeservice.org/Handover/9dcc48d7-fc88-11e8-9110-b0c592dbf8c0/",
"format": "uri",
"type": "string"
}
},
"required": [
"handoverType",
"url"
],
"type": "object"
},
"HandoverType": {
"$ref": "./ontologyTerm.json",
"description": "Handover type, as an Ontology_term object with CURIE syntax for the `id` value. Use `CUSTOM` for the `id` when no ontology is available.",
"examples": [
{
"id": "EFO:0004157",
"label": "BAM format"
},
{
"id": "CUSTOM",
"label": "download genomic variants in .pgxseg file format"
}
]
},
"IncludeResultsetResponses": {
"default": "HIT",
"description": "Indicator of whether responses from every Resultset should be included in the response to this request or just the ones with positive, negative results or no details at all. If null (not specified), the default value of 'HIT' is assumed. This parameter allows for returning boolean/counting results although the Beacon instance is capable to return record level details.",
"enum": [
"ALL",
"HIT",
"MISS",
"NONE"
],
"examples": [
"ALL",
"HIT",
"MISS",
"NONE"
],
"type": "string"
},
"Info": {
"description": "Placeholder to allow the Beacon to return any additional information that is necessary or could be of interest in relation to the query or the entry returned. It is recommended to encapsulate additional informations in this attribute instead of directly adding attributes at the same level than the others in order to avoid collision in the names of attributes in future versions of the specification.",
"type": "object"
},
"Limit": {
"default": 10,
"description": "Size of the page. Use `0` to return all the results or the maximum allowed by the Beacon, if there is any.",
"example": 10,
"minimum": 0,
"type": "integer"
},
"ListOfHandovers": {
"description": "Set of handovers to be added in one section the response.",
"items": {
"$ref": "#/definitions/Handover",
"description": "Requested schema to be used for individuals in the response."
},
"type": "array"
},
"ListOfSchemas": {
"description": "Set of schemas to be used in the response to a request.",
"items": {
"$ref": "#/definitions/SchemasPerEntity"
},
"type": "array"
},
"NonFilteredQueriesAllowed": {
"default": true,
"description": "Switch that declares if this Beacon instance, for a given entry type, admits queries that does not include any element that restrict returning all the results, like filters, parameters, ids, etc. The default value is 'true' for backward compatibility and for clarity in the request-response dialog.",
"type": "boolean"
},
"NumTotalResults": {
"description": "Total number of results. NOT the number of results returned in this batch, but the total obtained by the query.",
"examples": [
123
],
"minimum": 0,
"type": "integer"
},
"PageToken": {
"description": "A hash or similar that allows the server to use it as a cursor over a query. It could be or not a readable value, like a word or a key. E.g. it could be an encrypted value of primary keys to navigate next and previous page.",
"example": "ab0sc&fe1dd",
"type": "string"
},
"Pagination": {
"description": "Pagination to apply or that has been applied on the results.",
"properties": {
"currentPage": {
"$ref": "#/definitions/PageToken",
"description": "Token of the returned page. To be used only in the response to allow the client to check if the returned page is the one requested."
},
"limit": {
"$ref": "#/definitions/Limit"
},
"nextPage": {
"$ref": "#/definitions/PageToken",
"description": "Token of the next page. Used to navigate forward. If empty, it is assumed that no more pages are available"
},
"previousPage": {
"$ref": "#/definitions/PageToken",
"description": "Token of the previous page. Used to navigate backwards. If empty, it is assumed that the current page is the first one."
},
"skip": {
"$ref": "#/definitions/Skip"
}
},
"type": "object"
},
"SchemasPerEntity": {
"description": "Schema to be used for the requested entry type in the response.",
"properties": {
"entityType": {
"$comment": "TO REVIEW: Should that refer to a concept d? or would that include an undesired dependency to the configuration?",
"example": "Individual",
"type": "string"
},
"schema": {
"$comment": "TO DO: Add the correct format as 'uri' or 'regex'",
"examples": [
"./ga4gh-beacon-dataset-v2.0.0",
"https://www.example.org/schemas/ga4gh-beacon-dataset-v2.0.0.json"
],
"type": "string"
}
},
"type": "object"
},
"Skip": {
"default": 0,
"description": "* In the request: number of pages to skip * In the response: number of pages that has been skipped",
"example": 0,
"minimum": 0,
"type": "integer"
},
"TestMode": {
"default": false,
"description": "Used for indicating that a request or response is done in a test context e.g. for compliance testing i.e. to evaluate the acceptance/understanding of a request and the structure of the returned response by the Beacon instance. A TRUE `testMode` parameter DOES NOT require that the Beacon instance is a test instance, but that this specific request-response cycle is a testing one. When `true` the Beacon instance MUST respond the request but it SHOULD use virtual or non-sensitive data. Here, what is being evaluated is the acceptance/understanding of a request and the structure of the returned response by the Beacon instance.",
"type": "boolean"
}
},
"description": "Definition of relatively simple components used in different points of the Beacon specification, both in requests and responses, therefore not associated exclusively with one or the other. Separate schema documents are provided for complex components.",
"title": "Beacon Common Components",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 1f6fb0bae286687066e5b6a2ea8b3fc161fdc03c | 2023-10-10T08:48:08 | models/json/beacon-v2-default-model/common/age.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age value definition. Provenance: GA4GH Phenopackets v2 `Age`",
"properties": {
"iso8601duration": {
"description": "Represents age as a ISO8601 duration (e.g., 'P40Y10M05D').",
"example": "P32Y6M1D",
"type": "string"
}
},
"required": [
"iso8601duration"
],
"title": "Age",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 89ed443fecde703f259d5ec169ceeede37db72f9 | 2022-03-09T07:58:30 | models/json/beacon-v2-default-model/common/procedure.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Class describing a clinical procedure or intervention. Provenance: GA4GH Phenopackets v2 `Procedure`",
"properties": {
"ageAtProcedure": {
"$ref": "./timeElement.json",
"description": "Compares to Phenopackets v2 `Procedure.performed`"
},
"bodySite": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "Specific body site where the procedure was performed. Recommended valuee from Uber-anatomy ontology (UBERON)",
"examples": [
{
"id": "UBERON:0003403",
"label": "Skin of forearm"
},
{
"id": "UBERON:0003214",
"label": "mammary gland alveolus"
}
]
},
"dateOfProcedure": {
"description": "Date of procedure, in ISO8601 format",
"example": "2010-07-10",
"format": "date",
"type": "string"
},
"procedureCode": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "Clinical procedure performed with recommended values from Medical Action Ontology (MAXO) 'Medical action' term tree (MAXO:0000001). Compares to Phenopackets v2 `Procedure.code`",
"examples": [
{
"id": "MAXO:0001175",
"label": "liver transplantation"
},
{
"id": "MAXO:0000136",
"label": "high-resolution microendoscopy"
},
{
"id": "OBI:0002654",
"label": "needle biopsy"
}
]
}
},
"required": [
"procedureCode"
],
"title": "Procedure",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/requests/validation/filteringTerms.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"definitions": {
"AlphanumericFilter": {
"description": "Filter results based on operators and values applied to alphanumeric fields.",
"properties": {
"id": {
"description": "Field identfier to be queried.",
"example": "age",
"type": "string"
},
"operator": {
"default": "=",
"description": "Defines how the value relates to the field `id`.",
"enum": [
"=",
"<",
">",
"!",
">=",
"<="
],
"example": ">",
"type": "string"
},
"value": {
"description": "Alphanumeric search term to be used within the query which can contain wildcard characters (%) to denote any number of unknown characters. Values can be assocatied with units if applicable.",
"example": "P70Y",
"type": "string"
}
},
"required": [
"id",
"operator",
"value"
],
"type": "object"
},
"CustomFilter": {
"description": "Filter results to include records that contain a custom term defined by this Beacon.",
"properties": {
"id": {
"description": "Custom filter terms should contain a unique identifier.",
"example": "demographic.ethnicity:asian",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"OntologyFilter": {
"description": "Filter results to include records that contain a specific ontology term.",
"properties": {
"id": {
"description": "Term ID to be queried, using CURIE syntax where possible.",
"example": "HP:0002664",
"type": "string"
},
"includeDescendantTerms": {
"default": true,
"description": "Define if the Beacon should implement the ontology hierarchy, thus query the descendant terms of `id`.",
"type": "boolean"
},
"similarity": {
"default": "exact",
"description": "Allow the Beacon to return results which do not match the filter exactly, but do match to a certain degree of similarity. The Beacon defines the semantic similarity model implemented and how to apply the thresholds of 'high', 'medium' and 'low' similarity.",
"enum": [
"exact",
"high",
"medium",
"low"
],
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
},
"description": "Rules for selecting records based upon the field values those records contain. Filters are seperated by the logical AND operator.",
"properties": {
"$schema": {
"description": "Added here to allow the example to comply with the 'additionalProperties:true' restriction.",
"type": "string"
},
"filters": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/OntologyFilter"
},
{
"$ref": "#/definitions/AlphanumericFilter"
},
{
"$ref": "#/definitions/CustomFilter"
}
]
},
"type": "array"
}
},
"title": "Filtering Term Element"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 86d8c3bebb92dc892e2560022884e1ddea491821 | 2022-02-22T13:58:39 | framework/json/responses/sections/beaconReceivedRequestSummary.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Section of the response that summarize the request received as it has been interpreted by teh Beacon server. Although it is not expected to differ from the request received, in case of unexpected results or formats, this summary could help to determine the source of confusion or errors. The required properties include those that every request should have implicitly or explicitly. The request summary is making them explicit.",
"properties": {
"apiVersion": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/ApiVersion",
"description": "API version expected by the client to be supported by the server and used in the response format."
},
"filters": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/Filters",
"description": "Ontology based filters. CURIE syntax is encouraged to be used."
},
"includeResultsetResponses": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/IncludeResultsetResponses"
},
"pagination": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/Pagination",
"description": "Pagination to apply on the results."
},
"requestParameters": {
"$ref": "../../requests/requestParameters.json",
"description": "Dictionary of request parameters received in the RequestBody"
},
"requestedGranularity": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/Granularity",
"description": "Requested granularity. Targeted Beacon could respond or not with the requested granularity. E.g. record level granularity could be requested, but the Beacon could respond only with boolean or count results."
},
"requestedSchemas": {
"$comment": "TO DO: Add the format attribute as a uri.\n2. minItems:0 is used to confirm that an empty array is acceptable here.",
"$ref": "../../common/beaconCommonComponents.json#/definitions/ListOfSchemas",
"description": "Set of schemas to be used in the response to a request.",
"minItems": 0
},
"testMode": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/TestMode",
"description": "Used for indicating that a request was received in a test context. Purposed for compliance testing."
}
},
"required": [
"apiVersion",
"requestedSchemas",
"pagination",
"requestedGranularity"
],
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 284e82aa022ef5eccc996d957e3af4fbf261c8c8 | 2022-02-24T11:37:28 | framework/json/responses/beaconEntryTypesResponse.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Response including a list of Entry types definitions.",
"properties": {
"meta": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/responses/sections/beaconInformationalResponseMeta.json",
"description": "Information about the response that could be relevant for the Beacon client in order to interpret the results."
},
"response": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/configuration/entryTypesSchema.json",
"description": "Returning the Beacon Entry Types."
}
},
"required": [
"meta",
"response"
],
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 86d8c3bebb92dc892e2560022884e1ddea491821 | 2022-02-22T13:58:39 | framework/json/requests/beaconRequestMeta.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Meta section of the Beacon request. It includes request context details relevant for the Beacon server when processing the request.",
"properties": {
"$schema": {
"$ref": "../common/beaconCommonComponents.json#/definitions/$schema"
},
"apiVersion": {
"$ref": "../common/beaconCommonComponents.json#/definitions/ApiVersion",
"description": "API version expected by the client to be supported by the server and used in the response format."
},
"requestedSchemas": {
"$ref": "../common/beaconCommonComponents.json#/definitions/ListOfSchemas",
"description": "Set of schemas to be used in the response."
}
},
"required": [
"apiVersion"
],
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 39f9f133ad13fba7d17c03512c7b9eb3b3870416 | 2022-06-20T14:11:11 | framework/json/common/beaconCommonComponents.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"$schema": {
"$comment": "TO REVIEW: adding a `format` or `regex` attribute that validates correctly against a file path (relative).",
"description": "Refers to the JSON Schema which describes the set of valid attributes for this particular document type. This attribute is mostly used in schemas that should be tested in Beacon implementations.",
"type": "string"
},
"ApiVersion": {
"description": "an API version.",
"example": "v2.0",
"type": "string"
},
"BeaconError": {
"description": "Beacon-specific error.",
"properties": {
"errorCode": {
"description": "Entry not found",
"examples": [
"404"
],
"format": "int32",
"type": "integer"
},
"errorMessage": {
"examples": [
"the provided parameters are incomplete. 'xyz' is missing."
],
"type": "string"
}
},
"required": [
"errorCode"
],
"type": "object"
},
"BeaconId": {
"description": "the Id of a Beacon. Usually a reversed domain string, but any URI is acceptable. The purpose of this attribute is, in the context of a Beacon network, to disambiguate responses coming from different Beacons.",
"example": "org.example.beacon.v2",
"type": "string"
},
"Exists": {
"description": "Indicator of whether any record was observed in any of the collections queried. This should be non-null.",
"examples": [
true
],
"type": "boolean"
},
"Filters": {
"description": "Ontology based filters. A CURIE syntax is encouraged to be used.",
"example": [
"BTO:0000199",
"PATO:0000383"
],
"items": {
"type": "string"
},
"type": "array"
},
"Granularity": {
"default": "boolean",
"description": "Granularity or level of detail of the response:\n* `boolean`: returns true/false' responses * `count`: adds the total number of positive results found * `aggregated`: returns summary, aggregated or distribution like responses * `record`: returns details for every row. In cases where a Beacon prefers\n to return records with fewer than allattributes, different strategies have\n to be considered w/o adding them to the current design, e.g.:\n - keeping non-mandatory attributes empty\n - Beacon to provide a minimal record definition",
"enum": [
"boolean",
"count",
"aggregated",
"record"
],
"type": "string"
},
"Handover": {
"description": "A handover is a typed link for attaching actionable links to results, non purely informational, requests. The goal of the handovers is to list the different actions available, e.g.:\n* a link to a request access page * linking to a file for download, e.g. a VCF file\nAnother common scenario is to provide a fast summary response (e.g. BeconCountResponse) and to provide access to different endpoints for the entities matched by the query using temporary access tokens in the handover URLs.",
"properties": {
"handoverType": {
"$ref": "#/definitions/HandoverType"
},
"note": {
"description": "An optional text including considerations on the handover link provided.",
"example": "This handover link provides access to a summarized VCF.",
"type": "string"
},
"url": {
"description": "URL endpoint to where the handover process could progress, in RFC3986 format",
"example": "https://api.mygenomeservice.org/Handover/9dcc48d7-fc88-11e8-9110-b0c592dbf8c0/",
"format": "uri",
"type": "string"
}
},
"required": [
"handoverType",
"url"
],
"type": "object"
},
"HandoverType": {
"$ref": "./ontologyTerm.json",
"description": "Handover type, as an Ontology_term object with CURIE syntax for the `id` value. Use `CUSTOM` for the `id` when no ontology is available.",
"examples": [
{
"id": "EFO:0004157",
"label": "BAM format"
},
{
"id": "CUSTOM",
"label": "download genomic variants in .pgxseg file format"
}
]
},
"IncludeResultsetResponses": {
"default": "HIT",
"description": "Indicator of whether responses from every Resultset should be included in the response to this request or just the ones with positive, negative results or no details at all. If null (not specified), the default value of 'HIT' is assumed. This parameter allows for returning boolean/counting results although the Beacon instance is capable to return record level details.",
"enum": [
"ALL",
"HIT",
"MISS",
"NONE"
],
"examples": [
"ALL",
"HIT",
"MISS",
"NONE"
],
"type": "string"
},
"Info": {
"description": "Placeholder to allow the Beacon to return any additional information that is necessary or could be of interest in relation to the query or the entry returned. It is recommended to encapsulate additional informations in this attribute instead of directly adding attributes at the same level than the others in order to avoid collision in the names of attributes in future versions of the specification.",
"type": "object"
},
"Limit": {
"default": 10,
"description": "Size of the page. Use `0` to return all the results or the maximum allowed by the Beacon, if there is any.",
"example": 10,
"minimum": 0,
"type": "integer"
},
"ListOfHandovers": {
"description": "Set of handovers to be added in one section the response.",
"items": {
"$ref": "#/definitions/Handover",
"description": "Requested schema to be used for individuals in the response."
},
"type": "array"
},
"ListOfSchemas": {
"description": "Set of schemas to be used in the response to a request.",
"items": {
"$ref": "#/definitions/SchemasPerEntity"
},
"type": "array"
},
"NonFilteredQueriesAllowed": {
"default": true,
"description": "Switch that declares if this Beacon instance, for a given entry type, admits queries that does not include any element that restrict returning all the results, like filters, parameters, ids, etc. The default value is 'true' for backward compatibility and for clarity in the request-response dialog.",
"type": "boolean"
},
"NumTotalResults": {
"description": "Total number of results. NOT the number of results returned in this batch, but the total obtained by the query.",
"examples": [
123
],
"minimum": 0,
"type": "integer"
},
"PageToken": {
"description": "A hash or similar that allows the server to use it as a cursor over a query. It could be or not a readable value, like a word or a key. E.g. it could be an encrypted value of primary keys to navigate next and previous page.",
"example": "ab0sc&fe1dd",
"type": "string"
},
"Pagination": {
"description": "Pagination to apply or that has been applied on the results.",
"properties": {
"currentPage": {
"$ref": "#/definitions/PageToken",
"description": "Token of the returned page. To be used only in the response to allow the client to check if the returned page is the one requested."
},
"limit": {
"$ref": "#/definitions/Limit"
},
"nextPage": {
"$ref": "#/definitions/PageToken",
"description": "Token of the next page. Used to navigate forward. If empty, it is assumed that no more pages are available"
},
"previousPage": {
"$ref": "#/definitions/PageToken",
"description": "Token of the previous page. Used to navigate backwards. If empty, it is assumed that the current page is the first one."
},
"skip": {
"$ref": "#/definitions/Skip"
}
},
"type": "object"
},
"SchemasPerEntity": {
"description": "Schema to be used for the requested entry type in the response.",
"properties": {
"entityType": {
"$comment": "TO REVIEW: Should that refer to a concept d? or would that include an undesired dependency to the configuration?",
"example": "Individual",
"type": "string"
},
"schema": {
"$comment": "TO DO: Add the correct format as 'uri' or 'regex'",
"examples": [
"./ga4gh-beacon-dataset-v2.0.0",
"https://www.example.org/schemas/ga4gh-beacon-dataset-v2.0.0.json"
],
"type": "string"
}
},
"type": "object"
},
"Skip": {
"default": 0,
"description": "* In the request: number of pages to skip * In the response: number of pages that has been skipped",
"example": 0,
"minimum": 0,
"type": "integer"
},
"TestMode": {
"default": false,
"description": "Used for indicating that a request or response is done in a test context e.g. for compliance testing i.e. to evaluate the acceptance/understanding of a request and the structure of the returned response by the Beacon instance. A TRUE `testMode` parameter DOES NOT require that the Beacon instance is a test instance, but that this specific request-response cycle is a testing one. When `true` the Beacon instance MUST respond the request but it SHOULD use virtual or non-sensitive data. Here, what is being evaluated is the acceptance/understanding of a request and the structure of the returned response by the Beacon instance.",
"type": "boolean"
}
},
"description": "Definition of relatively simple components used in different points of the Beacon specification, both in requests and responses, therefore not associated exclusively with one or the other. Separate schema documents are provided for complex components.",
"title": "Beacon Common Components",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 89ed443fecde703f259d5ec169ceeede37db72f9 | 2022-03-09T07:58:30 | models/json/beacon-v2-default-model/individuals/examples/pedigree-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"disease": {
"diseaseCode": {
"id": "HP:0004789",
"label": "lactose intolerance"
}
},
"id": "SCD-Pedigree001",
"members": [
{
"affected": true,
"memberId": "Ind001",
"role": {
"id": "NCIT:C64435",
"label": "Proband"
}
},
{
"affected": false,
"memberId": "Pedigree1001-m1",
"role": {
"id": "NCIT:C96572",
"label": "Biological Father"
}
},
{
"affected": false,
"memberId": "Pedigree1001-m3",
"role": {
"id": "NCIT:C96572",
"label": "Biological Father"
}
},
{
"affected": false,
"memberId": "Pedigree1001-m2",
"role": {
"id": "NCIT:C111201",
"label": "Full Brother"
}
}
],
"numSubjects": 4
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/configuration/beaconConfigurationSchema.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"definitions": {
"EntryTypes": {
"additionalProperties": {
"$ref": "./entryTypeDefinition.json",
"type": "object"
},
"description": "This is a dictionary of the entry types implemented in this Beacon instance.",
"minProperties": 1,
"type": "object"
}
},
"description": "Files complaint with this schema are the configuration ones. The details returned in `service-info` are mirroring the ones in this configuration file.",
"properties": {
"$schema": {
"$ref": "../common/beaconCommonComponents.json#/definitions/$schema"
},
"entryTypes": {
"$ref": "#/definitions/EntryTypes"
},
"maturityAttributes": {
"description": "Declares the level of maturity of the Beacon instance.",
"properties": {
"productionStatus": {
"description": "`DEV`= 'Service potentially unstable, not real data', which availability and data should not be used in production setups. `TEST`= 'Service stable, not real data'. 'PROD'= 'Service stable, actual data'.",
"enum": [
"DEV",
"TEST",
"PROD"
],
"type": "string"
}
},
"type": "object"
},
"securityAttributes": {
"description": "Configuration of the security aspects of the Beacon. By default, a Beacon that does not declare the configuration settings would return `boolean` (true/false) responses, and only if the user is authenticated and explicitly authorized to access the Beacon resources. Although this is the safest set of settings, it is not recommended unless the Beacon shares very sensitive information. Non sensitive Beacons should preferably opt for a `record` and `PUBLIC` combination.",
"properties": {
"defaultGranularity": {
"$ref": "../common/beaconCommonComponents.json#/definitions/Granularity",
"description": "Default granularity. Some responses could return higher detail, but this would be the granularity by default."
},
"securityLevels": {
"description": "All access levels supported by the Beacon. Any combination is valid, as every option would apply to different parts of the Beacon.",
"items": {
"$comment": "TO DO: Check if values can be made unique.",
"default": "CONTROLLED",
"enum": [
"PUBLIC",
"REGISTERED",
"CONTROLLED"
]
},
"type": "array"
}
},
"type": "object"
}
},
"required": [
"$schema",
"maturityAttributes",
"entryTypes"
],
"title": "Beacon Configuration",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 89ed443fecde703f259d5ec169ceeede37db72f9 | 2022-03-09T07:58:30 | models/json/beacon-v2-default-model/beaconMap.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"endpointSets": {
"analysis": {
"endpoints": {
"genomicVariant": {
"returnedEntryType": "genomicVariant",
"url": "https://exampleBeacons.org/analyses/{id}/g_variants"
}
},
"entryType": "analysis",
"openAPIEndpointsDefinition": "https://exampleBeacons.org/analyses/endpoints.json",
"rootUrl": "https://exampleBeacons.org/analyses",
"singleEntryUrl": "https://exampleBeacons.org/analyses/{id}"
},
"biosample": {
"endpoints": {
"analysis": {
"returnedEntryType": "analysis",
"url": "https://exampleBeacons.org/biosamples/{id}/analyses"
},
"genomicVariant": {
"returnedEntryType": "genomicVariant",
"url": "https://exampleBeacons.org/biosamples/{id}/g_variants"
},
"run": {
"returnedEntryType": "run",
"url": "https://exampleBeacons.org/biosamples/{id}/runs"
}
},
"entryType": "biosample",
"openAPIEndpointsDefinition": "https://exampleBeacons.org/biosamples/endpoints.json",
"rootUrl": "https://exampleBeacons.org/biosamples",
"singleEntryUrl": "https://exampleBeacons.org/biosamples/{id}"
},
"cohort": {
"endpoints": {
"analyses": {
"returnedEntryType": "analysis",
"url": "https://exampleBeacons.org/cohorts/{id}/analyses"
},
"biosample": {
"returnedEntryType": "biosample",
"url": "https://exampleBeacons.org/cohorts/{id}/biosamples"
},
"genomicVariant": {
"returnedEntryType": "genomicVariant",
"url": "https://exampleBeacons.org/cohorts/{id}/g_variants"
},
"individual": {
"returnedEntryType": "individual",
"url": "https://exampleBeacons.org/cohorts/{id}/individuals"
},
"runs": {
"returnedEntryType": "run",
"url": "https://exampleBeacons.org/cohorts/{id}/runs"
}
},
"entryType": "cohort",
"filteringTermsUrl": "https://exampleBeacons.org/cohorts/{id}/filtering_terms",
"openAPIEndpointsDefinition": "https://exampleBeacons.org/cohorts/endpoints.json",
"rootUrl": "https://exampleBeacons.org/cohorts",
"singleEntryUrl": "https://exampleBeacons.org/cohorts/{id}"
},
"dataset": {
"endpoints": {
"analyses": {
"returnedEntryType": "analysis",
"url": "https://exampleBeacons.org/datasets/{id}/analyses"
},
"biosample": {
"returnedEntryType": "biosample",
"url": "https://exampleBeacons.org/datasets/{id}/biosamples"
},
"genomicVariant": {
"returnedEntryType": "genomicVariant",
"url": "https://exampleBeacons.org/datasets/{id}/g_variants"
},
"individual": {
"returnedEntryType": "individual",
"url": "https://exampleBeacons.org/datasets/{id}/individuals"
},
"runs": {
"returnedEntryType": "run",
"url": "https://exampleBeacons.org/datasets/{id}/runs"
}
},
"entryType": "dataset",
"filteringTermsUrl": "https://exampleBeacons.org/datasets/{id}/filtering_terms",
"openAPIEndpointsDefinition": "https://exampleBeacons.org/datasets/endpoints.json",
"rootUrl": "https://exampleBeacons.org/datasets",
"singleEntryUrl": "https://exampleBeacons.org/datasets/{id}"
},
"genomicVariant": {
"endpoints": {
"analyses": {
"returnedEntryType": "analysis",
"url": "https://exampleBeacons.org/g_variants/{id}/analyses"
},
"biosample": {
"returnedEntryType": "biosample",
"url": "https://exampleBeacons.org/g_variants/{id}/biosamples"
},
"individual": {
"returnedEntryType": "individual",
"url": "https://exampleBeacons.org/g_variants/{id}/individuals"
},
"runs": {
"returnedEntryType": "run",
"url": "https://exampleBeacons.org/g_variants/{id}/runs"
}
},
"entryType": "genomicVariant",
"openAPIEndpointsDefinition": "https://exampleBeacons.org/genomicVariations/endpoints.json",
"rootUrl": "https://exampleBeacons.org/g_variants",
"singleEntryUrl": "https://exampleBeacons.org/g_variants/{id}"
},
"individual": {
"endpoints": {
"analyses": {
"returnedEntryType": "analysis",
"url": "https://exampleBeacons.org/individuals/{id}/analyses"
},
"biosample": {
"returnedEntryType": "biosample",
"url": "https://exampleBeacons.org/individuals/{id}/biosamples"
},
"genomicVariant": {
"returnedEntryType": "genomicVariant",
"url": "https://exampleBeacons.org/individuals/{id}/g_variants"
},
"runs": {
"returnedEntryType": "run",
"url": "https://exampleBeacons.org/individuals/{id}/runs"
}
},
"entryType": "individual",
"filteringTermsUrl": "https://exampleBeacons.org/individuals/{id}/filtering_terms",
"openAPIEndpointsDefinition": "https://exampleBeacons.org/individuals/endpoints.json",
"rootUrl": "https://exampleBeacons.org/individuals",
"singleEntryUrl": "https://exampleBeacons.org/individuals/{id}"
},
"run": {
"endpoints": {
"analysis": {
"returnedEntryType": "analysis",
"url": "https://exampleBeacons.org/runs/{id}/analyses"
},
"genomicVariant": {
"returnedEntryType": "genomicVariant",
"url": "https://exampleBeacons.org/runs/{id}/g_variants"
}
},
"entryType": "run",
"openAPIEndpointsDefinition": "https://exampleBeacons.org/runs/endpoints.json",
"rootUrl": "https://exampleBeacons.org/runs",
"singleEntryUrl": "https://exampleBeacons.org/runs/{id}"
}
}
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 2d5365d7295c42617ee1e0498a3223d0a4493089 | 2022-03-11T15:24:20 | framework/json/configuration/beaconMapSchema.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"definitions": {
"Endpoint": {
"properties": {
"endpoints": {
"additionalProperties": {
"$ref": "#/definitions/RelatedEndpoint"
},
"description": "Optional. A list describing additional endpoints implemented by this Beacon instance for that entry type. Additional details on the endpoint parameters, supported HTTP verbs, etc. could be obtained by parsing the OpenAPI definition referenced in the `openAPIEndpointsDefinition` attribute.",
"minProperties": 0,
"type": "object"
},
"entryType": {
"description": "",
"type": "string"
},
"filteringTermsUrl": {
"description": "Optional. Returns the list of filtering terms that could be applied to this entry type. It is added here for convenience of the Beacon clients, so they don't need to parse the OpenAPI endpoints definition to get that endpoint. Also, in very simple Beacons, that endpoint could be the one of the few implemented, together with \u00b4rootUrl` and \u00b4singleEntryUrl`, in which case the whole map of endpoints is found in the current Map.",
"format": "uri",
"type": "string"
},
"openAPIEndpointsDefinition": {
"description": "Reference to the file that includes the OpenAPI definition of the endpoints implemented in this Beacon instance. The referenced file MUST BE a valid OpenAPI definition file, as it is expected that the Beacon clients (e.g. a Beacon Network) should be able to parse it to discover additional details on the supported verbs, parameters, etc.",
"type": "string"
},
"rootUrl": {
"description": "The base url for this entry type. Returns a list of entries. It is added here for convenience of the Beacon clients, so they don't need to parse the OpenAPI endpoints definition to get that base endpoint. Also, in very simple Beacons, that endpoint could be the only one implemented, together with \u00b4singleEntryUrl`, in which case the whole map of endpoints is found in the current Map.",
"format": "uri",
"type": "string"
},
"singleEntryUrl": {
"description": "Optional, but recommended. Returns only one instance of this entry, identified by an `id`. It is added here for convenience of the Beacon clients, so they don't need to parse the OpenAPI endpoints definition to get that base endpoint. Also, in very simple Beacons, that endpoint could be the only one implemented, together with \u00b4rootUrl`, in which case the whole map of endpoints is found in the current Map.",
"format": "uri",
"type": "string"
}
},
"required": [
"entryType",
"rootUrl"
],
"type": "object"
},
"RelatedEndpoint": {
"properties": {
"returnedEntryType": {
"description": "Which entry type is returned by querying this endpoint. It MUST match one of the entry types defined in the Beacon configuration file (`beaconConfiguration.json`).",
"type": "string"
},
"url": {
"description": "Endpoint URL",
"format": "uri",
"type": "string"
}
},
"required": [
"url",
"returnedEntryType"
],
"type": "object"
}
},
"description": "Map of a Beacon, its entry types and endpoints. It isconceptually similar to a website sitemap.",
"properties": {
"$schema": {
"$ref": "../common/beaconCommonComponents.json#/definitions/$schema"
},
"endpointSets": {
"additionalProperties": {
"$ref": "#/definitions/Endpoint"
},
"description": "List of enpoints included in this Beacon instance. This is list is meant to inform Beacon clients, e.g. a Beacon Network, about the available endpoints, it is not used to generate any automatic list, but could be used for Beacon validation purposes.",
"minProperties": 1,
"type": "object"
}
},
"required": [
"$schema",
"endpointSets"
],
"title": "Beacon Map",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 86d8c3bebb92dc892e2560022884e1ddea491821 | 2022-02-22T13:58:39 | framework/json/configuration/beaconMapSchema.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"definitions": {
"Endpoint": {
"properties": {
"endpoints": {
"additionalProperties": {
"$ref": "#/definitions/RelatedEndpoint"
},
"description": "Optional. A list describing additional endpoints implemented by this Beacon instance for that entry type. Additional details on the endpoint parameters, supported HTTP verbs, etc. could be obtained by parsing the OpenAPI definition referenced in the `openAPIEndpointsDefinition` attribute.",
"minProperties": 0,
"type": "object"
},
"entryType": {
"description": "",
"type": "string"
},
"filteringTermsUrl": {
"description": "Optional. Returns the list of filtering terms that could be applied to this entry type. It is added here for convenience of the Beacon clients, so they don't need to parse the OpenAPI endpoints definition to get that endpoint. Also, in very simple Beacons, that endpoint could be the one of the few implemented, together with \u00b4rootUrl` and \u00b4singleEntryUrl`, in which case the whole map of endpoints is found in the current Map.",
"format": "uri",
"type": "string"
},
"openAPIEndpointsDefinition": {
"description": "Reference to the file that includes the OpenAPI definition of the endpoints implemented in this Beacon instance. The referenced file MUST BE a valid OpenAPI definition file, as it is expected that the Beacon clients (e.g. a Beacon Network) should be able to parse it to discover additional details on the supported verbs, parameters, etc.",
"type": "string"
},
"rootUrl": {
"description": "The base url for this entry type. Returns a list of entries. It is added here for convenience of the Beacon clients, so they don't need to parse the OpenAPI endpoints definition to get that base endpoint. Also, in very simple Beacons, that endpoint could be the only one implemented, together with \u00b4singleEntryUrl`, in which case the whole map of endpoints is found in the current Map.",
"format": "uri",
"type": "string"
},
"singleEntryUrl": {
"description": "Optional, but recommended. Returns only one instance of this entry, identified by an `id`. It is added here for convenience of the Beacon clients, so they don't need to parse the OpenAPI endpoints definition to get that base endpoint. Also, in very simple Beacons, that endpoint could be the only one implemented, together with \u00b4rootUrl`, in which case the whole map of endpoints is found in the current Map.",
"format": "uri",
"type": "string"
}
},
"required": [
"entryType",
"rootUrl"
],
"type": "object"
},
"RelatedEndpoint": {
"properties": {
"returnedEntryType": {
"description": "Which entry type is returned by querying this endpoint. It MUST match one of the entry types defined in the Beacon configuration file (`beaconConfiguration.json`).",
"type": "string"
},
"url": {
"description": "Endpoint URL",
"format": "uri",
"type": "string"
}
},
"required": [
"url",
"returnedEntryType"
],
"type": "object"
}
},
"description": "Map of a Beacon, its entry types and endpoints. It is conceptually similar to a website sitemap.",
"properties": {
"$schema": {
"$ref": "../common/beaconCommonComponents.json#/definitions/$schema"
},
"endpointSets": {
"additionalProperties": {
"$ref": "#/definitions/Endpoint"
},
"description": "List of enpoints included in this Beacon instance. This is list is meant to inform Beacon clients, e.g. a Beacon Network, about the available endpoints, it is not used to generate any automatic list, but could be used for Beacon validation purposes.",
"minProperties": 1,
"type": "object"
}
},
"required": [
"$schema",
"endpointSets"
],
"title": "Beacon Map",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/responses/examples-fullDocuments/beaconInfo-MAX-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"info": {},
"meta": {
"apiVersion": "string",
"beaconId": "string",
"returnedSchemas": [
{
"entityType": "info",
"schema": "beacon-info-v2.0.0"
}
]
},
"response": {
"alternativeUrl": "http://example.org/wiki/Main_Page",
"apiVersion": "v0.3",
"createDateTime": "2012-07-19 or 2017-01-17T20:33:40Z",
"description": "string",
"environment": "dev",
"id": "org.ga4gh.beacon",
"info": {
"additionalInfoKey1": "additionalInfoValue1",
"additionalInfoKey2": [
"additionalInfoValue2",
"additionalInfoValue3"
]
},
"name": "string",
"organization": {
"address": "string",
"contactUrl": "string",
"description": "string",
"id": "string",
"info": {},
"logoUrl": "string",
"name": "string",
"welcomeUrl": "string"
},
"updateDateTime": "2012-07-19 or 2017-01-17T20:33:40Z",
"version": "v0.1",
"welcomeUrl": "http://example.org/wiki/Main_Page"
}
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 1c03b708fdfd3e822886f51f0bb20f658030f76c | 2022-03-28T12:54:26 | models/json/beacon-v2-default-model/cohorts/examples/cohorts-MIN-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"cohortType": "study-defined",
"id": "cohort0001",
"name": "GCAT Genomes for Life"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 88ce636abaea54fb56d832322e9cd16b78c151ae | 2022-06-20T09:38:05 | models/json/beacon-v2-default-model/genomicVariations/requestParameters.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"g_variant": {
"properties": {
"alternateBases": {
"$ref": "./requestParametersComponents.json#/definitions/AlternateBases"
},
"aminoacidChange": {
"description": "Aminoacid alteration of interest. Format 1 letter",
"examples": [
"V600E",
"M734V"
],
"type": "string"
},
"assemblyId": {
"$ref": "./requestParametersComponents.json#/definitions/Assembly"
},
"end": {
"description": "Precise or bracketing the end of the variants of interest: * (0-based, exclusive) - see `start` * for bracket queries, provide 2 values (e.g. [111,222]).\"",
"items": {
"format": "int64",
"minimum": 1,
"type": "integer"
},
"maxItems": 2,
"minItems": 0,
"type": "array"
},
"geneId": {
"description": "* A gene identifier * It is strongly suggested to use a symbol following\n the HGNC (https://www.genenames.org) nomenclature.",
"examples": [
"BRAF",
"SCN5A"
],
"type": "string"
},
"genomicAlleleShortForm": {
"description": "HGVSId descriptor",
"examples": [
"NM_004006.2:c.4375C>T"
],
"type": "string"
},
"mateName": {
"$ref": "./requestParametersComponents.json#/definitions/RefSeqId"
},
"referenceBases": {
"$ref": "./requestParametersComponents.json#/definitions/ReferenceBases"
},
"referenceName": {
"$ref": "./requestParametersComponents.json#/definitions/RefSeqId"
},
"start": {
"description": "Precise or fuzzy start coordinate position(s), allele locus (0-based, inclusive). * `start` only:\n - for single positions, e.g. the start of a specified sequence\n alteration where the size is given through the specified `alternateBases`\n - typical use are queries for SNV and small InDels\n - the use of `start` without an `end` parameter requires the use of\n `alternateBases`\n* `start` and `end`:\n - for searching any variant falling fully or partially within the range\n between `start` and `end` (a.k.a. \"range query\")\n - additional use of `variantType` OR `alternateBases` can limit the\n scope of the query\n - by convention, partial overlaps of variants with the indicated genomic\n range are accepted; for specific overlap requirements the 4-parameter\n \"Bracket Queries\" should be employed\n* 2 values in both `start` and `end` for constructing a \"Bracket Query\":\n - can be used to match any contiguous genomic interval, e.g. for querying\n imprecise positions\n - identifies all structural variants starting between `start[0]` and `start[1]`,\n and ending between `end[0]` <-> `end[1]`\n - single or double sided precise matches can be achieved by setting\n `start[1]=start[0]+1` and `end[1]=end[0]+1`",
"items": {
"format": "int64",
"minimum": 0,
"type": "integer"
},
"maxItems": 2,
"minItems": 1,
"type": "array"
},
"variantMaxLength": {
"description": "* Maximum length in bases of a genomic variant. * This is an optional parameter without prescribed use. While a length is\n commonly available for structural variants such as copy number variations,\n it is recommended that length based queries should also be supported for\n variants with indicated referenceBases and alternateBases, to enable\n length-specific wildcard queries.",
"format": "int64",
"minimum": 1,
"type": "integer"
},
"variantMinLength": {
"description": "* Minimum length in bases of a genomic variant * This is an optional parameter without prescribed use. While a length is\n commonly available for structural variants such as copy number variations,\n it is recommended that length based queries should also be supported for\n variants with indicated referenceBases and alternateBases, to enable\n length-specific wildcard queries.",
"format": "int64",
"minimum": 0,
"type": "integer"
},
"variantType": {
"description": "The `variantType` is used to query variants which are not defined through a sequence of one or more bases using the `alternateBases` parameter. Examples here are e.g. structural variants: * DUP\n - increased allelic count of material from the genomic region between\n `start` and `end` positions\n - no assumption about the placement of the additional sequences is being\n made (i.e. no _in situ_ requirement as tandem duplications)\n* DEL: deletion of sequence following `start` * BND: breakend, i.e. termination of the allele at position `start` or in\n the `startMin` => `startMax` interval, or fusion of the sequence to distant\n partner\nEither `alternateBases` or `variantType` is required, with the exception of range queries (single\\ `start` and `end` parameters).",
"type": "string"
}
},
"type": "object"
}
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | a45ccc786aba78e1e393bb4c087c1d87d9ae5306 | 2023-10-06T14:14:36 | models/json/beacon-v2-default-model/common/age.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age value definition. Provenance: GA4GH Phenopackets v2 `Age`",
"properties": {
"iso8601duration": {
"description": "Represents age as a ISO8601 duration (e.g., P40Y10M05D).",
"example": "P32Y6M1D",
"type": "string"
}
},
"required": [
"iso8601duration"
],
"title": "Age",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | f3f93ef9f94f0164a185d36dd45045fc1a179c14 | 2022-12-21T19:45:33 | framework/json/responses/sections/beaconCountResponseSection.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Payload definition for the \"count\" response.",
"properties": {
"exists": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/Exists"
},
"numTotalResults": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/NumTotalResults",
"description": "Total number of results."
}
},
"required": [
"exists",
"numTotalResults"
],
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 3e6093cf1b20ac74bc021c315511094f930be1ef | 2022-02-22T11:21:39 | framework/json/requests/examples-sections/beaconRequestMeta-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"apiVersion": "2.0",
"requestedSchemas": [
{
"entityType": "EntryTypeA",
"schema": "entry-typeA-schema-v0.1"
}
]
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | eb8958fad3a04499d41f7f528292d29d2f23ccbf | 2022-11-16T09:22:52 | models/json/beacon-v2-default-model/genomicVariations/requestParameters.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"g_variant": {
"properties": {
"alternateBases": {
"$ref": "./requestParametersComponents.json#/definitions/AlternateBases"
},
"aminoacidChange": {
"description": "Aminoacid alteration of interest. Format 1 letter",
"examples": [
"V600E",
"M734V"
],
"type": "string"
},
"assemblyId": {
"$ref": "./requestParametersComponents.json#/definitions/Assembly"
},
"end": {
"description": "Precise or bracketing the end of the variants of interest: * (0-based, exclusive) - see `start` * for bracket queries, provide 2 values (e.g. [111,222]).\"",
"items": {
"format": "int64",
"minimum": 1,
"type": "integer"
},
"maxItems": 2,
"minItems": 0,
"type": "array"
},
"geneId": {
"description": "* A gene identifier * It is strongly suggested to use a symbol following\n the HGNC (https://www.genenames.org) nomenclature.",
"examples": [
"BRAF",
"SCN5A"
],
"type": "string"
},
"genomicAlleleShortForm": {
"description": "HGVSId descriptor",
"examples": [
"NM_004006.2:c.4375C>T"
],
"type": "string"
},
"mateName": {
"$ref": "./requestParametersComponents.json#/definitions/RefSeqId"
},
"referenceBases": {
"$ref": "./requestParametersComponents.json#/definitions/ReferenceBases"
},
"referenceName": {
"$ref": "./requestParametersComponents.json#/definitions/RefSeqId"
},
"start": {
"description": "Precise or fuzzy start coordinate position(s), allele locus (0-based, inclusive). * `start` only:\n - for single positions, e.g. the start of a specified sequence\n alteration where the size is given through the specified `alternateBases`\n - typical use are queries for SNV and small InDels\n - the use of `start` without an `end` parameter requires the use of\n `alternateBases`\n* `start` and `end`:\n - for searching any variant falling fully or partially within the range\n between `start` and `end` (a.k.a. \"range query\")\n - additional use of `variantType` OR `alternateBases` can limit the\n scope of the query\n - by convention, partial overlaps of variants with the indicated genomic\n range are accepted; for specific overlap requirements the 4-parameter\n \"Bracket Queries\" should be employed\n* 2 values in both `start` and `end` for constructing a \"Bracket Query\":\n - can be used to match any contiguous genomic interval, e.g. for querying\n imprecise positions\n - identifies all structural variants starting between `start[0]` and `start[1]`,\n and ending between `end[0]` <-> `end[1]`\n - single or double sided precise matches can be achieved by setting\n `start[1]=start[0]+1` and `end[1]=end[0]+1`",
"items": {
"format": "int64",
"minimum": 0,
"type": "integer"
},
"maxItems": 2,
"minItems": 1,
"type": "array"
},
"variantMaxLength": {
"description": "* Maximum length in bases of a genomic variant. * This is an optional parameter without prescribed use. While a length is\n commonly available for structural variants such as copy number variations,\n it is recommended that length based queries should also be supported for\n variants with indicated referenceBases and alternateBases, to enable\n length-specific wildcard queries.",
"format": "int64",
"minimum": 1,
"type": "integer"
},
"variantMinLength": {
"description": "* Minimum length in bases of a genomic variant * This is an optional parameter without prescribed use. While a length is\n commonly available for structural variants such as copy number variations,\n it is recommended that length based queries should also be supported for\n variants with indicated referenceBases and alternateBases, to enable\n length-specific wildcard queries.",
"format": "int64",
"minimum": 0,
"type": "integer"
},
"variantType": {
"description": "The `variantType` is used to query variants which are not defined through a sequence of one or more bases using the `alternateBases` parameter. Examples here are e.g. structural variants: * DUP\n - increased allelic count of material from the genomic region between\n `start` and `end` positions\n - no assumption about the placement of the additional sequences is being\n made (i.e. no _in situ_ requirement as tandem duplications)\n* DEL: deletion of sequence following `start` The Beacon model is not prescriptive with regard to the values allowed for `variantType` with use of extended types (such as from `EFO:0030063`) being possible. However, a support for the basic CNV types above - where represented in the data - is recommended. Either `alternateBases` or `variantType` is required, with the exception of range queries (single `start` and `end` parameters).",
"type": "string"
}
},
"type": "object"
}
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/responses/sections/beaconInfoResults.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"definitions": {
"BeaconOrganization": {
"description": "Organization owning the Beacon.",
"properties": {
"address": {
"description": "Address of the organization.",
"type": "string"
},
"contactUrl": {
"description": "URL with the contact for the Beacon operator/maintainer, e.g. link to a contact form (RFC 3986 format) or an email (RFC 2368 format).",
"type": "string"
},
"description": {
"description": "Description of the organization.",
"type": "string"
},
"id": {
"description": "Unique identifier of the organization.",
"type": "string"
},
"info": {
"description": "Additional unspecified metadata about the host Organization.",
"example": {
"additionalInfoKey": "additionalInfoValue"
},
"type": "object"
},
"logoUrl": {
"description": "URL to the logo (PNG/JPG/SVG format) of the organization (RFC 3986 format).",
"type": "string"
},
"name": {
"description": "Name of the organization.",
"type": "string"
},
"welcomeUrl": {
"description": "URL of the website of the organization (RFC 3986 format).",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
},
"description": "Metadata describing a Beacon instance.",
"properties": {
"alternativeUrl": {
"description": "Alternative URL to the API, e.g. a restricted version of this Beacon (RFC 3986 format).",
"example": "http://example.org/wiki/Main_Page",
"type": "string"
},
"apiVersion": {
"description": "Version of the API provided by the Beacon.",
"example": "v2.0",
"type": "string"
},
"createDateTime": {
"description": "The time the Beacon was created (ISO 8601 format).",
"example": "2012-07-19 or 2017-01-17T20:33:40Z",
"type": "string"
},
"description": {
"description": "Description of the Beacon.",
"type": "string"
},
"environment": {
"description": "Environment the service is running in. Use this to distinguish\nbetween production, development and testing/staging deployments.",
"enum": [
"prod",
"test",
"dev",
"staging"
],
"example": "dev",
"type": "string"
},
"id": {
"description": "Unique identifier of the Beacon. Use reverse domain name notation.",
"example": "org.ga4gh.Beacon",
"type": "string"
},
"info": {
"description": "Additional unspecified metadata about the Beacon service.",
"example": {
"additionalInfoKey1": "additionalInfoValue1",
"additionalInfoKey2": [
"additionalInfoValue2",
"additionalInfoValue3"
]
},
"type": "object"
},
"name": {
"description": "Name of the Beacon.",
"type": "string"
},
"organization": {
"$ref": "#/definitions/BeaconOrganization"
},
"updateDateTime": {
"description": "The time the Beacon was updated in (ISO 8601 format).",
"example": "2012-07-19 or 2017-01-17T20:33:40Z",
"type": "string"
},
"version": {
"description": "Version of the Beacon.",
"example": "v0.1",
"type": "string"
},
"welcomeUrl": {
"description": "URL to the welcome page for this Beacon (RFC 3986 format).",
"example": "http://example.org/wiki/Main_Page",
"type": "string"
}
},
"required": [
"id",
"name",
"apiVersion",
"environment",
"organization"
],
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 89ed443fecde703f259d5ec169ceeede37db72f9 | 2022-03-09T07:58:30 | models/json/beacon-v2-default-model/genomicVariations/filteringTerms.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"filteringTerms": [
{
"ftType": "alphanumeric",
"id": "gene"
},
{
"ftType": "alphanumeric",
"id": "aminoacidChanges"
}
]
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 3e6093cf1b20ac74bc021c315511094f930be1ef | 2022-02-22T11:21:39 | framework/json/responses/examples-fullDocuments/beaconErrorResponse_example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"error": {
"errorCode": 400,
"errorMessage": "Bad request. Missing parameter 'id'."
},
"meta": {
"apiVersion": "v2.0",
"beaconId": "org.example.beacon.v2",
"receivedRequestSummary": {
"apiVersion": "v2.0",
"filters": [
"BTO:0000199",
"PATO:0000383"
],
"pagination": {
"limit": 10,
"skip": 1
},
"requestParameters": [
{
"entity": "individual",
"parameters": [
{
"id": "123"
},
{
"position": "1234556"
}
]
}
],
"requestedSchemas": [
{
"entityType": "Individual",
"schema": "ga4gh-phenopacket-individual-v0.1"
}
]
},
"returnedSchemas": []
}
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | bf2d78821c80404be777c9f0df35f79e8424bbd6 | 2022-03-24T08:35:39 | models/json/beacon-v2-default-model/common/disease.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Diseases diagnosed e.g. to an individual, defined by diseaseID, age of onset, stage, level of severity, outcome and the presence of family history. Similarities to GA4GH Phenopackets v2 `Disease`",
"properties": {
"ageOfOnset": {
"$ref": "./timeElement.json",
"examples": [
{
"age": {
"iso8601duration": "P32Y6M1D"
},
"ageGroup": {
"id": "NCIT:C49685",
"label": "Adult 18-65 Years Old"
}
},
{
"ageRange": {
"end": {
"iso8601duration": "P59Y"
},
"start": {
"iso8601duration": "P18Y"
}
}
},
{
"age": {
"iso8601duration": "P2M4D"
}
}
]
},
"diseaseCode": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json",
"description": "Disease identifier. Value from disease ontologies such as HPO, OMIM, Orphanet, MONDO, e.g. lactose intolerance (HP:0004789, ICD10CM:E73). Provenance: GA4GH Phenopackets v2 `Disease.term`",
"examples": [
{
"id": "HP:0004789",
"label": "lactose intolerance"
},
{
"id": "ICD10CM:E73",
"label": "lactose intolerance"
},
{
"id": "OMIM:164400",
"label": "Spinocerebellar ataxia 1"
}
]
},
"familyHistory": {
"description": "Boolean indicating determined or self-reported presence of family history of the disease.",
"examples": [
true
],
"type": "boolean"
},
"notes": {
"description": "Unstructured text to describe additional properties of this disease instance.",
"examples": [
"Some free text"
],
"type": "string"
},
"severity": {
"$ref": "./commonDefinitions.json#/definitions/SeverityLevel",
"examples": [
{
"id": "HP:0012828",
"label": "Severe"
},
{
"id": "HP:0012826",
"label": "Moderate"
}
]
},
"stage": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json",
"description": "Ontology term from Ontology for General Medical Science (OGMS), e.g. acute onset (OGMS:0000119). Provenance: GA4GH Phenopackets v2 `Disease.disease_stage`",
"examples": [
{
"id": "OGMS:0000119",
"label": "acute onset"
},
{
"id": "OGMS:0000117",
"label": "asymptomatic"
},
{
"id": "OGMS:0000106",
"label": "remission"
}
]
}
},
"required": [
"diseaseCode"
],
"title": "Disease",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/common/basicElement.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of the basic element, which is root for most other objects.",
"properties": {
"id": {
"description": "A (unique) identifier of the element.",
"type": "string"
},
"name": {
"description": "A distinctive name for the element.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Basic Element",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/common/examples/referenceToAnSchema-MAX-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A longer textual description for the element.",
"id": "RTAEex1",
"name": "Reference to schema one with all its properties.",
"referenceToSchemaDefinition": "https://example-schemas.org/an-schema-address.json",
"schemaVersion": "v1.0"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | eb8958fad3a04499d41f7f528292d29d2f23ccbf | 2022-11-16T09:22:52 | models/json/beacon-v2-default-model/genomicVariations/requestParametersComponents.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"AlternateBases": {
"description": "Alternate bases for this variant (starting from `start`). * Accepted values: `[ACGTN]*` * N is a wildcard, that denotes the position of any base,\n and can be used as a standalone base of any type or within a partially known\n sequence. As example, a query of `ANNT` the Ns can take take any form of [ACGT]\n and will match `ANNT`, `ACNT`, `ACCT`, `ACGT` ... and so forth.\n* an *empty value* is used in the case of deletions with the maximally trimmed,\n deleted sequence being indicated in `ReferenceBases`\n* Categorical variant queries, e.g. such *not* being represented through\n sequence & position, make use of the `variantType` parameter.\n* either `alternateBases` or `variantType` is required.",
"pattern": "^([ACGTUNRYSWKMBDHV\\-\\.]*)$",
"type": "string"
},
"Assembly": {
"description": "Genomic assembly accession and version as RefSqeq assembly accession (e.g. \"GCF_000001405.39\") or a versioned assembly name or synonym such as UCSC Genome Browser assembly (e.g. \"hg38\") or Genome Reference Consortium Human (e.g. \"GRCh38.p13\") names.",
"example": [
"GCF_000001405.39",
"hg38",
"GRCh38.p13"
],
"type": "string"
},
"RefSeqId": {
"description": "Reference sequence id for genomic reference sequence in which variant coordinates are given, e.g. \"NC_000009.12\" for human chromosome 9 in the GRCh38 assembly. The use of the assembly specific RefSeqId is recommended although alternatively names, synonymous or aliases e.g. \"chr9\" could be used in conjunction with an `Assembly` parameter.",
"example": [
"NC_000009.12",
"chr9",
"NC_012920.1"
],
"type": "string"
},
"ReferenceBases": {
"description": "Reference bases for this variant (starting from `start`). * Accepted values: `[ACGTN]*` * N is a wildcard, that denotes the position of any base,\n and can be used as a standalone base of any type or within a partially known\n sequence. As example, a query of `ANNT` the Ns can take take any form of [ACGT]\n and will match `ANNT`, `ACNT`, `ACCT`, `ACGT` ... and so forth.\n* an *empty value* is used in the case of insertions with the maximally trimmed, inserted\n sequence being indicated in `AlternateBases`",
"pattern": "^([ACGTUNRYSWKMBDHV\\-\\.]*)$",
"type": "string"
}
},
"description": "Component definitions used in `requestParameters`."
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 8de7dd4a5b930eac822073d21939eb4e92a06335 | 2022-07-22T14:00:24 | bin/adhoc/beaconCommonComponents.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"$schema": {
"$comment": "TO REVIEW: adding a `format` or `regex` attribute that validates correctly against a file path (relative).",
"description": "Refers to the JSON Schema which describes the set of valid attributes for this particular document type. This attribute is mostly used in schemas that should be tested in Beacon implementations.",
"type": "string"
},
"ApiVersion": {
"description": "an API version.",
"example": "v2.0",
"type": "string"
},
"BeaconError": {
"description": "Beacon-specific error.",
"properties": {
"errorCode": {
"description": "Entry not found",
"examples": [
"404"
],
"format": "int32",
"type": "integer"
},
"errorMessage": {
"examples": [
"the provided parameters are incomplete. 'xyz' is missing."
],
"type": "string"
}
},
"required": [
"errorCode"
],
"type": "object"
},
"BeaconId": {
"description": "the Id of a Beacon. Usually a reversed domain string, but any URI is acceptable. The purpose of this attribute is, in the context of a Beacon network, to disambiguate responses coming from different Beacons.",
"example": "org.example.beacon.v2",
"type": "string"
},
"CURIE": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"Exists": {
"description": "Indicator of whether any record was observed in any of the collections queried. This should be non-null.",
"examples": [
true
],
"type": "boolean"
},
"Filters": {
"description": "Ontology based filters. A CURIE syntax is encouraged to be used.",
"example": [
"BTO:0000199",
"PATO:0000383"
],
"items": {
"type": "string"
},
"type": "array"
},
"Granularity": {
"default": "boolean",
"description": "Granularity or level of detail of the response:\n* `boolean`: returns true/false' responses * `count`: adds the total number of positive results found * `aggregated`: returns summary, aggregated or distribution like responses * `record`: returns details for every row. In cases where a Beacon prefers\n to return records with fewer than allattributes, different strategies have\n to be considered w/o adding them to the current design, e.g.:\n - keeping non-mandatory attributes empty\n - Beacon to provide a minimal record definition",
"enum": [
"boolean",
"count",
"aggregated",
"record"
],
"type": "string"
},
"Handover": {
"description": "A handover is a typed link for attaching actionable links to results, non purely informational, requests. The goal of the handovers is to list the different actions available, e.g.:\n* a link to a request access page * linking to a file for download, e.g. a VCF file\nAnother common scenario is to provide a fast summary response (e.g. BeconCountResponse) and to provide access to different endpoints for the entities matched by the query using temporary access tokens in the handover URLs.",
"properties": {
"handoverType": {
"$ref": "#/definitions/HandoverType"
},
"note": {
"description": "An optional text including considerations on the handover link provided.",
"example": "This handover link provides access to a summarized VCF.",
"type": "string"
},
"url": {
"description": "URL endpoint to where the handover process could progress, in RFC3986 format",
"example": "https://api.mygenomeservice.org/Handover/9dcc48d7-fc88-11e8-9110-b0c592dbf8c0/",
"format": "uri",
"type": "string"
}
},
"required": [
"handoverType",
"url"
],
"type": "object"
},
"HandoverType": {
"$ref": "./ontologyTerm.json",
"description": "Handover type, as an Ontology_term object with CURIE syntax for the `id` value. Use `CUSTOM` for the `id` when no ontology is available.",
"examples": [
{
"id": "EFO:0004157",
"label": "BAM format"
},
{
"id": "CUSTOM",
"label": "download genomic variants in .pgxseg file format"
}
]
},
"IncludeResultsetResponses": {
"default": "HIT",
"description": "Indicator of whether responses from every Resultset should be included in the response to this request or just the ones with positive, negative results or no details at all. If null (not specified), the default value of 'HIT' is assumed. This parameter allows for returning boolean/counting results although the Beacon instance is capable to return record level details.",
"enum": [
"ALL",
"HIT",
"MISS",
"NONE"
],
"examples": [
"ALL",
"HIT",
"MISS",
"NONE"
],
"type": "string"
},
"Info": {
"description": "Placeholder to allow the Beacon to return any additional information that is necessary or could be of interest in relation to the query or the entry returned. It is recommended to encapsulate additional informations in this attribute instead of directly adding attributes at the same level than the others in order to avoid collision in the names of attributes in future versions of the specification.",
"type": "object"
},
"Limit": {
"default": 10,
"description": "Size of the page. Use `0` to return all the results or the maximum allowed by the Beacon, if there is any.",
"example": 10,
"minimum": 0,
"type": "integer"
},
"ListOfHandovers": {
"description": "Set of handovers to be added in one section the response.",
"items": {
"$ref": "#/definitions/Handover",
"description": "Requested schema to be used for individuals in the response."
},
"type": "array"
},
"ListOfSchemas": {
"description": "Set of schemas to be used in the response to a request.",
"items": {
"$ref": "#/definitions/SchemasPerEntity"
},
"type": "array"
},
"NonFilteredQueriesAllowed": {
"default": true,
"description": "Switch that declares if this Beacon instance, for a given entry type, admits queries that does not include any element that restrict returning all the results, like filters, parameters, ids, etc. The default value is 'true' for backward compatibility and for clarity in the request-response dialog.",
"type": "boolean"
},
"NumTotalResults": {
"description": "Total number of results. NOT the number of results returned in this batch, but the total obtained by the query.",
"examples": [
123
],
"minimum": 0,
"type": "integer"
},
"PageToken": {
"description": "A hash or similar that allows the server to use it as a cursor over a query. It could be or not a readable value, like a word or a key. E.g. it could be an encrypted value of primary keys to navigate next and previous page.",
"example": "ab0sc&fe1dd",
"type": "string"
},
"Pagination": {
"description": "Pagination to apply or that has been applied on the results.",
"properties": {
"currentPage": {
"$ref": "#/definitions/PageToken",
"description": "Token of the returned page. To be used only in the response to allow the client to check if the returned page is the one requested."
},
"limit": {
"$ref": "#/definitions/Limit"
},
"nextPage": {
"$ref": "#/definitions/PageToken",
"description": "Token of the next page. Used to navigate forward. If empty, it is assumed that no more pages are available"
},
"previousPage": {
"$ref": "#/definitions/PageToken",
"description": "Token of the previous page. Used to navigate backwards. If empty, it is assumed that the current page is the first one."
},
"skip": {
"$ref": "#/definitions/Skip"
}
},
"type": "object"
},
"SchemasPerEntity": {
"description": "Schema to be used for the requested entry type in the response.",
"properties": {
"entityType": {
"$comment": "TO REVIEW: Should that refer to a concept d? or would that include an undesired dependency to the configuration?",
"example": "Individual",
"type": "string"
},
"schema": {
"$comment": "TO DO: Add the correct format as 'uri' or 'regex'",
"examples": [
"./ga4gh-beacon-dataset-v2.0.0",
"https://www.example.org/schemas/ga4gh-beacon-dataset-v2.0.0.json"
],
"type": "string"
}
},
"type": "object"
},
"Skip": {
"default": 0,
"description": "* In the request: number of pages to skip * In the response: number of pages that has been skipped",
"example": 0,
"minimum": 0,
"type": "integer"
},
"TestMode": {
"default": false,
"description": "Used for indicating that a request or response is done in a test context e.g. for compliance testing i.e. to evaluate the acceptance/understanding of a request and the structure of the returned response by the Beacon instance. A TRUE `testMode` parameter DOES NOT require that the Beacon instance is a test instance, but that this specific request-response cycle is a testing one. When `true` the Beacon instance MUST respond the request but it SHOULD use virtual or non-sensitive data. Here, what is being evaluated is the acceptance/understanding of a request and the structure of the returned response by the Beacon instance.",
"type": "boolean"
}
},
"description": "Definition of relatively simple components used in different points of the Beacon specification, both in requests and responses, therefore not associated exclusively with one or the other. Separate schema documents are provided for complex components.",
"title": "Beacon Common Components",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 62d704d7190d1586fae17f25216cc965c3459aa1 | 2023-06-16T08:19:50 | models/json/beacon-v2-default-model/common/complexValue.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"TypedQuantity": {
"properties": {
"quantity": {
"$ref": "./quantity.json",
"description": "Quantity denoting the outcome of the measurement",
"example": {
"quentity": {
"unit": {
"id": "NCIT:C49670",
"label": "Millimeter of Mercury"
}
}
}
},
"quantityType": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json",
"description": "OntologyClass to describe the type of the measurement. Renamed compared to GA4GH Phenopackets v2 `ComplexValue.TypedQuantity.type`",
"example": {
"id": "NCIT:C25298",
"label": "Systolic Blood Pressure"
}
}
},
"required": [
"typedQuantities"
]
}
},
"description": "Definition of a complex value class. Provenance: GA4GH Phenopackets v2 `TypedQuantity`",
"properties": {
"typedQuantities": {
"description": "List of quantities required to fully describe the complex value",
"items": {
"$ref": "#/definitions/TypedQuantity"
},
"type": "array"
}
},
"title": "Complex Value",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 86d8c3bebb92dc892e2560022884e1ddea491821 | 2022-02-22T13:58:39 | framework/json/common/ontologizedElement.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"allOf": [
{
"$ref": "./elementWithDescription.json"
},
{
"properties": {
"ontologyTermForThisType": {
"$ref": "./ontologyTerm.json"
}
},
"required": [
"ontologyTermForThisType"
],
"type": "object"
}
],
"description": "Definition of the basic element which includes a description and a type defined by an ontology.",
"title": "Element with description and a type defined by an ontology",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | f3f93ef9f94f0164a185d36dd45045fc1a179c14 | 2022-12-21T19:45:33 | framework/json/responses/sections/beaconSummaryResponseSection.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Beacon results summary section.",
"properties": {
"exists": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/Exists"
},
"numTotalResults": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/NumTotalResults"
}
},
"required": [
"exists"
],
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 3e6093cf1b20ac74bc021c315511094f930be1ef | 2022-02-22T11:21:39 | framework/json/configuration/examples/beaconMap-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"endpointSets": {
"dataset": {
"endpoints": {
"exampleEntries": {
"returnedEntryType": "exampleEntry",
"url": "https://exampleBeacons.org/datasets/{id}/exampleEntries"
}
},
"entryType": "dataset",
"filteringTermsUrl": "https://exampleBeacons.org/datasets/{id}/filteringTerms",
"openAPIEndpointsDefinition": "./datasets/endpoints.json",
"rootUrl": "https://exampleBeacons.org/datasets",
"singleEntryUrl": "https://exampleBeacons.org/datasets/{id}"
},
"exampleEntry": {
"entryType": "exampleEntry",
"filteringTermsUrl": "https://exampleBeacons.org/exampleEntries/{id}/filteringTerms",
"openAPIEndpointsDefinition": "./exampleEntries/endpoints.json",
"rootUrl": "https://exampleBeacons.org/exampleEntries",
"singleEntryUrl": "https://exampleBeacons.org/exampleEntries/{id}"
}
}
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 3e6093cf1b20ac74bc021c315511094f930be1ef | 2022-02-22T11:21:39 | framework/json/configuration/examples/entriesCollectionDefinition_MIN_example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"aCollectionOf": [
{
"id": "exampleEntry",
"name": "Example entries"
}
],
"defaultSchema": {
"id": "datasetDefaultSchema",
"name": "Default schema for datasets",
"referenceToSchemaDefinition": "./datasets/defaultSchema.json",
"schemaVersion": "v.2"
},
"id": "dataset",
"name": "Dataset",
"ontologyTermForThisType": {
"id": "NCIT:C47824",
"label": "Data set"
},
"partOfSpecification": "Beacon v2.0"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/responses/beaconErrorResponse.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "An unsuccessful operation.",
"properties": {
"error": {
"$ref": "../common/beaconCommonComponents.json#/definitions/BeaconError",
"description": "Returning an error."
},
"meta": {
"$ref": "./sections/beaconResponseMeta.json",
"description": "Information about the response that could be relevant for the Beacon client in order to interpret the results."
}
},
"required": [
"meta",
"error"
],
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/responses/beaconResultsetsResponse.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Beacon response that includes record level details, grouped in Resultsets.",
"properties": {
"beaconHandovers": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity/main/framework/json/common/beaconCommonComponents.json#/definitions/ListOfHandovers",
"description": "List of handovers that apply to the whole response, not to any resultset or result in particular."
},
"info": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity/main/framework/json/common/beaconCommonComponents.json#/definitions/Info",
"description": "Additional details that could be of interest. Provided to clearly enclose any attribute that is not part of the Beacon specification."
},
"meta": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity/main/framework/json/responses/sections/beaconResponseMeta.json",
"description": "Information about the response that could be relevant for the Beacon client in order to interpret the results."
},
"response": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity/main/framework/json/responses/sections/beaconResultsets.json",
"description": "Response for queries that recovers any result."
},
"responseSummary": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity/main/framework/json/responses/sections/beaconSummaryResponseSection.json",
"description": "Response summary, including Boolean and optionally results count."
}
},
"required": [
"meta",
"responseSummary",
"response"
],
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/responses/examples-sections/beaconResponseMeta-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"apiVersion": "v2.0",
"beaconId": "org.example.beacon.v2",
"receivedRequestSummary": {
"apiVersion": "2.0",
"pagination": {
"limit": 10,
"skip": 0
},
"requestedGranularity": "count",
"requestedSchemas": [
{
"entityType": "EntryTypeB",
"schema": "entry-typeB-schema-v1.0"
}
],
"testMode": true
},
"returnedGranularity": "count",
"returnedSchemas": [
{
"entityType": "EntryTypeB",
"schema": "entry-typeB-schema-v1.0"
}
]
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | d07ef1626321f7428374a4f68d864dfa5e98370f | 2022-06-21T09:50:37 | framework/json/requests/filteringTerms.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"definitions": {
"AlphanumericFilter": {
"description": "Filter results based on operators and values applied to alphanumeric fields.",
"properties": {
"id": {
"description": "Field identfier to be queried.",
"example": "age",
"type": "string"
},
"operator": {
"default": "=",
"description": "Defines how the value relates to the field `id`.",
"enum": [
"=",
"<",
">",
"!",
">=",
"<="
],
"example": ">",
"type": "string"
},
"scope": {
"description": "The entry type to which the filter applies",
"example": "biosamples",
"type": "string"
},
"value": {
"description": "Alphanumeric search term to be used within the query which can contain wildcard characters (%) to denote any number of unknown characters. Values can be assocatied with units if applicable.",
"example": "P70Y",
"type": "string"
}
},
"required": [
"id",
"operator",
"value"
],
"type": "object"
},
"CustomFilter": {
"description": "Filter results to include records that contain a custom term defined by this Beacon.",
"properties": {
"id": {
"description": "Custom filter terms should contain a unique identifier.",
"example": "demographic.ethnicity:asian",
"type": "string"
},
"scope": {
"description": "The entry type to which the filter applies",
"example": "biosamples",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"FilteringTerm": {
"anyOf": [
{
"$ref": "#/definitions/OntologyFilter"
},
{
"$ref": "#/definitions/AlphanumericFilter"
},
{
"$ref": "#/definitions/CustomFilter"
}
]
},
"OntologyFilter": {
"description": "Filter results to include records that contain a specific ontology term.",
"properties": {
"id": {
"description": "Term ID to be queried, using CURIE syntax where possible.",
"example": "HP:0002664",
"type": "string"
},
"includeDescendantTerms": {
"default": true,
"description": "Define if the Beacon should implement the ontology hierarchy, thus query the descendant terms of `id`.",
"type": "boolean"
},
"scope": {
"description": "The entry type to which the filter applies",
"example": "biosamples",
"type": "string"
},
"similarity": {
"default": "exact",
"description": "Allow the Beacon to return results which do not match the filter exactly, but do match to a certain degree of similarity. The Beacon defines the semantic similarity model implemented and how to apply the thresholds of 'high', 'medium' and 'low' similarity.",
"enum": [
"exact",
"high",
"medium",
"low"
],
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
},
"description": "Filtering terms are the main means to select subsets of records from a Beacon response. While the name implies the application to a generated response, in practice implementations may apply them at the query stage. Note: In the processing of Beacon v2.0 requests multiple filters are assumed to be chained by the logical AND operator.",
"items": {
"$ref": "#/definitions/FilteringTerm"
},
"title": "Filtering Term Element",
"type": "array"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 89ed443fecde703f259d5ec169ceeede37db72f9 | 2022-03-09T07:58:30 | models/json/beacon-v2-default-model/common/phenotypicFeature.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {},
"description": "Used to describe a phenotype that characterizes the subject or biosample.",
"properties": {
"evidence": {
"$ref": "./evidence.json",
"description": "The evidence for an assertion of the observation of a type. RECOMMENDED."
},
"excluded": {
"default": false,
"description": "(from Phenopackets v.2) Flag to indicate whether the disease was observed or not. Default is \u2018false\u2019, in other words the disease was observed. Therefore it is only required in cases to indicate that the disease was looked for, but found to be absent. More formally, this modifier indicates the logical negation of the OntologyClass used in the 'featureType' field. CAUTION It is imperative to check this field for correct interpretation of the disease!",
"type": "boolean"
},
"featureType": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "Term denoting the phenotypic feature, preferably using a value from Human Phenotype Ontology (HPO)",
"examples": [
{
"id": "HP:0000002",
"label": "Abnormality of body height"
},
{
"id": "HP:0002006",
"label": "Facial cleft"
},
{
"id": "HP:0012469",
"label": "Infantile spasms"
}
]
},
"modifiers": {
"description": "For instance one or more terms from HPO Clinical Modifier (HP:0012823). This subontology is designed to provide terms to characterize and specify the phenotypic abnormalities defined in the Phenotypic abnormality subontology, with respect to severity, laterality, age of onset, and other aspects. [ HPO:probinson ] ",
"examples": [
{
"id": "HP:0032500",
"label": "Exacerbated by tobacco use"
},
{
"id": "HP:4000053",
"label": "Displaced fracture"
}
],
"items": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json"
},
"type": "array"
},
"notes": {
"description": "Unstructured text to describe additional properties of this phenotypic feature.",
"example": "Some free text",
"type": "string"
},
"onset": {
"$ref": "./timeElement.json",
"description": "Age or time at which the feature was first observed."
},
"resolution": {
"$ref": "./timeElement.json",
"description": "Age or time at which the feature resolved or abated."
},
"severityLevel": {
"$ref": "./commonDefinitions.json#/definitions/SeverityLevel"
}
},
"required": [
"featureType"
],
"title": "PhenotypicFeature",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 86d8c3bebb92dc892e2560022884e1ddea491821 | 2022-02-22T13:58:39 | framework/json/responses/examples-sections/beaconResultsets-MID-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"resultSets": [
{
"exists": true,
"id": "correctWithResults",
"results": [
{
"id": "BEex1",
"name": "Basic Element example one"
}
],
"resultsCount": 1,
"type": "dataset"
},
{
"exists": false,
"id": "correctWOresults",
"type": "dataset"
}
]
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 89ed443fecde703f259d5ec169ceeede37db72f9 | 2022-03-09T07:58:30 | models/json/beacon-v2-default-model/cohorts/examples/cohorts-MID-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"cohortDataTypes": [
{
"id": "OGMS:0000015",
"label": "clinical history"
},
{
"id": "OBI:0000070",
"label": "genotyping assay"
},
{
"id": "OMIABIS:0000060",
"label": "survey data"
}
],
"cohortDesign": {
"id": "OMIABIS:0001019",
"label": "longitudinal study design"
},
"cohortId": "cohort0001",
"cohortInclusionCriteria": {
"ageRange": {
"end": {
"iso8601duration": "P40Y"
},
"start": {
"iso8601duration": "P18Y"
}
},
"genders": [
{
"id": "NCIT:C16576",
"label": "female"
},
{
"id": "NCIT:C20197",
"label": "male"
}
],
"locations": [
{
"id": "GAZ:00004501",
"label": "Catalonia Autonomous Community"
}
]
},
"cohortName": "GCAT Genomes for Life",
"cohortSize": 20000,
"cohortType": "study-defined"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 86d8c3bebb92dc892e2560022884e1ddea491821 | 2022-02-22T13:58:39 | framework/json/responses/examples-fullDocuments/beaconCollectionsResponse-MID-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"meta": {
"apiVersion": "v2.0",
"beaconId": "org.example.beacon.v2",
"receivedRequestSummary": {
"apiVersion": "2.0",
"pagination": {
"limit": 10,
"skip": 0
},
"requestedSchemas": [
{
"entityType": "dataset",
"schema": "dataset-schema-v1.0"
}
]
},
"returnedSchemas": [
{
"entityType": "dataset",
"schema": "dataset-schema-v1.0"
}
]
},
"response": {
"collections": [
{
"$schema": "https://schemas-fake-depot.org/beaconv2/datasetSchema.json",
"createDateTime": "2011-01-11T11:11:11Z",
"dataUseConditions": {
"duoDataUse": [
{
"id": "DUO:0000007",
"label": "disease specific research",
"modifiers": [
{
"id": "HP:0001631"
}
],
"version": "2021-02-23"
}
]
},
"description": "This is the first dataset",
"id": "Dataset1",
"name": "Dataset One",
"updateDateTime": "2011-01-11T11:11:11Z",
"version": "v1"
},
{
"$schema": "https://schemas-fake-depot.org/beaconv2/datasetSchema.json",
"createDateTime": "2012-02-22T22:22:22Z",
"dataUseConditions": {
"duoDataUse": [
{
"id": "DUO:0000042",
"label": "general research use",
"version": "2021-02-23"
}
]
},
"description": "This is the second dataset",
"id": "Dataset2",
"name": "Dataset Two",
"updateDateTime": "2012-02-22T22:22:22Z",
"version": "v2"
}
]
},
"responseSummary": {
"exists": true
}
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | e2190ef3a9248c63f2963f4fb568a7190990dfec | 2023-09-05T09:15:17 | framework/json/responses/sections/beaconFilteringTermsResults.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"definitions": {
"FilteringTerm": {
"description": "Entities can be filtered using this term.",
"properties": {
"id": {
"description": "The field id in the case of numeric or alphanumeric fields, or the term id in the case of ontology or custom terms. CURIE syntax in the case of an ontology term.",
"examples": [
"NCIT:C8936",
"HP:0008773"
],
"type": "string"
},
"label": {
"description": "This would be the \"preferred Label\" in the case of an ontology term.",
"examples": [
"B Lymphoblastic Leukemia/Lymphoma",
"Aplasia/Hypoplasia of the middle ear"
],
"type": "string"
},
"scopes": {
"description": "Entry types this filter may be applied to.",
"examples": [
"[\"individual\", \"biosample\"]"
],
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Either \"custom\", \"alphanumeric\" or ontology/terminology full name. TODO: An ontology ... with a registered prefix does not need a full name so one may better use CURIE to indicate that the resource can be retrieved from the id. This also will allow to provide an enum here.",
"examples": [
"Human Phenotype Ontology",
"alphanumeric"
],
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"Resource": {
"description": "Description of an ontology resource defined externally to this beacon implementation, such as MeSH or EFO, based on the phenopackets resource object (https://phenopacket-schema.readthedocs.io/en/latest/resource.html)",
"properties": {
"id": {
"description": "Preferably OBO ID representing the resource; alternatively a URI pointing towards the definitions may be used if not in OBO.",
"examples": [
"hp"
],
"type": "string"
},
"iriPrefix": {
"description": "The full Internationalized Resource Identifier (IRI) prefix",
"examples": [
"http://purl.obolibrary.org/obo/HP_"
],
"type": "string"
},
"name": {
"description": "The name of the ontology referred to by the id element",
"examples": [
"Human Phenotype Ontology"
],
"type": "string"
},
"nameSpacePrefix": {
"description": "The prefix used in the CURIE of an OntologyClass",
"examples": [
"HP"
],
"type": "string"
},
"url": {
"description": "Uniform Resource Locator of the resource",
"examples": [
"http://purl.obolibrary.org/obo/hp.owl"
],
"type": "string"
},
"version": {
"description": "The version of the resource or ontology used to make the annotation",
"examples": [
"17-06-2019"
],
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
},
"description": "Filtering terms and ontology resources utilised in this Beacon.",
"properties": {
"filteringTerms": {
"items": {
"$ref": "#/definitions/FilteringTerm"
},
"type": "array"
},
"resources": {
"items": {
"$ref": "#/definitions/Resource"
},
"type": "array"
}
},
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/configuration/filteringTermsSchema.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"definitions": {
"FilterTerm": {
"properties": {
"ftType": {
"description": "Type of filter term, according to the 'request/filteringTerms.json' schema. * 'ontologyTerm' is a term that belongs to a tree of concepts, hence suitable to operations like 'query by similarity' or 'include all descendants'. Many ontology terms are a value in itself (like 'female'), hence no further information is required to solve the query. * 'alphanumeric' is a field or an ontology term (like 'age') that requires a value to complete the intended query. Only attributes of known schemas SHOULD be used here. For attributes that are not part of the known schemas, the 'custom' type MUST be used. * 'custom' is anything that doesn't fit the previous categories and mainly for custom dictionaries that have no ontology nor a corresponding attribute in the known schemas. Usually only makes sense for close partners that are familiar with the custom dictionary.",
"enum": [
"ontologyTerm",
"alphanumeric",
"custom"
],
"type": "string"
},
"id": {
"description": "Term ID, Field ID or custom term string. For term ID use CURIE syntax where possible.",
"examples": [
"HP:0002664",
"age",
"demographic.ethnicity:subsaharan"
],
"type": "string"
},
"label": {
"description": "Label for the ontology term. For other `ftTypes` add a readable description",
"examples": [
"Neoplasm",
"age in days",
"Ethnic origin from South of the Sahara Desert."
],
"type": "string"
},
"scope": {
"description": "The entry type to which the filter applies",
"examples": [
"biosample",
"individual"
],
"type": "string"
}
},
"required": [
"ftType",
"id"
],
"type": "object"
}
},
"description": "Schema for the Filtering Terms list related to the hosting entry type. It is kept separated to allow updating it independently.",
"properties": {
"filteringTerms": {
"description": "List of filtering terms that could be used to filter this concept in this instance of Beacon.",
"items": {
"$ref": "#/definitions/FilterTerm"
},
"minItems": 0,
"type": "array"
}
},
"required": [
"filteringTerms"
],
"title": "Filtering Terms schema",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | de3d4e6b13a32dc5de7649a40bef266fec5967dd | 2022-03-14T08:33:49 | models/json/beacon-v2-default-model/common/commonDefinitions.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Ethnicity": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "Ethnic background of the individual. Recommended is the use of a value from NCIT Race (NCIT:C17049) ontology term descendants, e.g. NCIT:C126531 (Latin American). A geographic ancestral origin category that is assigned to a population group based mainly on physical characteristics that are thought to be distinct and inherent. [ NCI ]",
"examples": [
{
"id": "NCIT:C42331",
"label": "African"
},
{
"id": "NCIT:C41260",
"label": "Asian"
},
{
"id": "NCIT:C126535",
"label": "Australian"
},
{
"id": "NCIT:C43851",
"label": "European"
},
{
"id": "NCIT:C77812",
"label": "North American"
},
{
"id": "NCIT:C126531",
"label": "Latin American"
},
{
"id": "NCIT:C104495",
"label": "Other race"
}
]
},
"GeographicLocation": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "Country or region of origin of the individual (birthplace or residence place regardless of ethnic origin). Value from GAZ Geographic Location ontology (GAZ:00000448), e.g. GAZ:00002459 (United States of America).",
"examples": [
{
"id": "GAZ:00002955",
"label": "Slovenia"
},
{
"id": "GAZ:00002459",
"label": "United States of America"
},
{
"id": "GAZ:00316959",
"label": "Municipality of El Masnou"
},
{
"id": "GAZ:00000460",
"label": "Eurasia"
}
]
},
"KaryotypicSex": {
"$comments": "Compares to https://github.com/phenopackets/phenopacket-schema/blob/master/docs/karyotypicsex.rst",
"default": "UNKNOWN_KARYOTYPE",
"description": "The chromosomal sex of an individual represented from a selection of options. The values correspond to the ordinal values in the Phenopackets schema where: 0 - UNKNOWN_KARYOTYPE (Untyped or inconclusive karyotyping); 1 - XX (Female); 2 - XY (Male); 3 - XO (Single X chromosome only); 4 - XXY (Two X and one Y chromosome); 5 - XXX (Three X chromosomes); 6 - XXYY (Two X chromosomes and two Y chromosomes); 7 - XXXY (Three X chromosomes and one Y chromosome); 8 - XXXX (Four X chromosomes); 9 - XYY (One X and two Y chromosomes); 10 - OTHER_KARYOTYPE (None of the above types)",
"enum": [
"UNKNOWN_KARYOTYPE",
"XX",
"XY",
"XO",
"XXY",
"XXX",
"XXYY",
"XXXY",
"XXXX",
"XYY",
"OTHER_KARYOTYPE"
],
"type": "string"
},
"SeverityLevel": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "Level/severity ontology when and as applicable to phenotype observed. Value from Human Phenotype Ontology (HP:0012824), e.g `mild`. The intensity or degree of a manifestation. [ HPO:probinson ] ",
"examples": [
{
"id": "HP:0012825",
"label": "Severe"
},
{
"id": "HP:0012829",
"label": "Profound"
},
{
"id": "HP:0012826",
"label": "Moderate"
},
{
"id": "HP:0012825",
"label": "Mild"
},
{
"id": "HP:0012827",
"label": "Bordeline"
}
]
},
"Sex": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "Sex of the individual. Recommended values from NCIT General Qualifier (NCIT:C27993): \"unknown\" (not assessed or not available) - NCIT:C17998; \"female\" - NCIT:C16576; \"male\" - NCIT:C20197",
"examples": [
{
"id": "NCIT:C16576",
"label": "female"
},
{
"id": "NCIT:C20197",
"label": "male"
},
{
"id": "NCIT:C1799",
"label": "unknown"
}
]
},
"Unit": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "The kind of unit. Recommended from NCIT Unit of Category ontology term (NCIT:C42568) descendants",
"examples": [
{
"id": "NCIT:C70575",
"label": "Roentgen"
},
{
"id": "NCIT:C28252",
"label": "Kilogram"
},
{
"id": "NCIT:C28253",
"label": "Milligram"
}
]
}
},
"description": "Definitions for concepts used in several entry types, but that having only one property are not complex enough to require a full independent schema document.",
"title": "Common Definitions"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 89ed443fecde703f259d5ec169ceeede37db72f9 | 2022-03-09T07:58:30 | models/json/beacon-v2-default-model/biosamples/examples/biosample-MIN-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"biosampleStatus": {
"id": "EFO:0009655",
"label": "abnormal sample"
},
"id": "sample-example-0001",
"sampleOriginType": {
"id": "UBERON:0000474",
"label": "female reproductive system"
}
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 89f9aacffcb00b3395ffa9d908cf38c7bb598b5e | 2022-03-23T07:55:42 | models/json/beacon-v2-default-model/common/complexValue.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"TypedQuantity": {
"properties": {
"quantity": {
"$ref": "./quantity.json",
"description": "Quantity denoting the outcome of the measurement",
"example": {
"quentity": {
"unit": {
"id": "NCIT:C49670",
"label": "Millimeter of Mercury"
}
}
}
},
"quantityType": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json",
"description": "OntologyClass to describe the type of the measurement. Renamed compared to GA4GH Phenopackets v2 `ComplexValue.TypedQuantity.type`",
"example": {
"id": "NCIT:C25298",
"label": "Systolic Blood Pressure"
}
}
},
"required": [
"quantityType",
"quantity"
]
}
},
"description": "Definition of a complex value class. Provenance: GA4GH Phenopackets v2 `TypedQuantity`",
"properties": {
"typedQuantities": {
"description": "List of quantities required to fully describe the complex value",
"items": {
"$ref": "#/definitions/TypedQuantity"
},
"type": "array"
}
},
"title": "Complex Value",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 89f9aacffcb00b3395ffa9d908cf38c7bb598b5e | 2022-03-23T07:55:42 | framework/json/responses/beaconMapResponse.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Information about the Beacon. Aimed to Beacon clients like web pages or Beacon networks.",
"properties": {
"meta": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/sections/beaconInformationalResponseMeta.json",
"description": "Information about the response that could be relevant for the Beacon client in order to interpret the results."
},
"response": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/configuration/beaconMapSchema.json",
"description": "Returning the Beacon Map."
}
},
"required": [
"meta",
"response"
],
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 3e6093cf1b20ac74bc021c315511094f930be1ef | 2022-02-22T11:21:39 | framework/json/responses/beaconCollectionsResponse.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Beacon response that includes details about the collections in this Beacon.",
"properties": {
"beaconHandovers": {
"$ref": "../common/beaconCommonComponents.json#/definitions/ListOfHandovers",
"description": "List of handovers that apply to the whole response, not to any resultset or result in particular."
},
"info": {
"$ref": "../common/beaconCommonComponents.json#/definitions/Info",
"description": "Additional details that could be of interest. Provided to clearly enclose any attribute that is not part of the Beacon specification."
},
"meta": {
"$ref": "./sections/beaconResponseMeta.json",
"description": "Information about the response that could be relevant for the Beacon client in order to interpret the results."
},
"response": {
"additionalProperties": true,
"description": "Returning the Beacon Collections list, filtered or unfiltered.",
"properties": {
"collections": {
"items": {
"type": "object"
},
"minItems": 0,
"type": "array"
}
},
"required": [
"collections"
],
"type": "object"
},
"responseSummary": {
"$ref": "./sections/beaconSummaryResponseSection.json",
"description": "Response summary, including Boolean and optionally results count."
}
},
"required": [
"meta",
"responseSummary",
"response"
],
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 7275a36c9838095895f79d4e96b33a0db23f5f99 | 2022-12-21T17:43:28 | framework/json/common/beaconCommonComponents.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"$schema": {
"$comment": "TO REVIEW: adding a `format` or `regex` attribute that validates correctly against a file path (relative).",
"description": "Refers to the JSON Schema which describes the set of valid attributes for this particular document type. This attribute is mostly used in schemas that should be tested in Beacon implementations.",
"type": "string"
},
"ApiVersion": {
"description": "Version of API, e.g. in request or response. Beacon uses a Github-style, \"v\"-prefixed semantic versioning format.",
"examples": [
"v2.0.1",
"v0.3"
],
"type": "string"
},
"BeaconError": {
"description": "Beacon-specific error.",
"properties": {
"errorCode": {
"description": "Entry not found",
"examples": [
"404"
],
"format": "int32",
"type": "integer"
},
"errorMessage": {
"examples": [
"The provided parameters are incomplete: `start` is missing."
],
"type": "string"
}
},
"required": [
"errorCode"
],
"type": "object"
},
"BeaconId": {
"description": "The Id of a Beacon. Usually a reversed domain string, but any URI is acceptable. The purpose of this attribute is, in the context of a Beacon network, to disambiguate responses coming from different Beacons.",
"examples": [
"org.example.beacon.v2",
"org.progenetix.beacon"
],
"type": "string"
},
"CURIE": {
"description": "Definition of an identifier in the CURIE `prefix:local-part` format which is the default type of e.g. ontology term `id` values (used e.g. for filters or external identifiers).",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"Exists": {
"description": "Indicator of whether any record was observed in any of the collections queried. This should be non-null.",
"examples": [
true
],
"type": "boolean"
},
"Filters": {
"description": "Ontology based filters. A CURIE syntax is encouraged to be used.",
"example": [
"BTO:0000199",
"PATO:0000383"
],
"items": {
"type": "string"
},
"type": "array"
},
"Granularity": {
"default": "boolean",
"description": "Level of detail of the response:\n* `boolean`: returns true/false' responses * `count`: adds the total number of positive results found * `aggregated`: returns summary, aggregated or distribution like responses * `record`: returns details for every row. In cases where a Beacon prefers to return records with fewer than allattributes, different strategies have to be considered w/o adding them to the current design, e.g.:\n - keeping non-mandatory attributes empty\n - Beacon to provide a minimal record definition",
"enum": [
"boolean",
"count",
"aggregated",
"record"
],
"type": "string"
},
"Handover": {
"description": "A handover is a typed link for attaching actionable links to results, non purely informational, requests. The goal of the handovers is to list the different actions available, e.g.:\n* a link to a request access page * linking to a file for download, e.g. a VCF file\nAnother common scenario is to provide a fast summary response (e.g. BeconCountResponse) and to provide access to different endpoints for the entities matched by the query using temporary access tokens in the handover URLs.",
"properties": {
"handoverType": {
"$ref": "#/definitions/HandoverType"
},
"note": {
"description": "An optional text including considerations on the handover link provided.",
"example": "This handover link provides access to a summarized VCF.",
"type": "string"
},
"url": {
"description": "URL endpoint to where the handover process could progress, in RFC3986 format",
"example": "https://api.mygenomeservice.org/Handover/9dcc48d7-fc88-11e8-9110-b0c592dbf8c0/",
"format": "uri",
"type": "string"
}
},
"required": [
"handoverType",
"url"
],
"type": "object"
},
"HandoverType": {
"$ref": "./ontologyTerm.json",
"description": "Handover type, as an Ontology_term object with CURIE syntax for the `id` value. Use `CUSTOM` for the `id` when no ontology is available.",
"examples": [
{
"id": "EFO:0004157",
"label": "BAM format"
},
{
"id": "CUSTOM",
"label": "download genomic variants in .pgxseg file format"
}
]
},
"IncludeResultsetResponses": {
"default": "HIT",
"description": "Indicator of whether responses from every Resultset should be included in the response to this request or just the ones with positive, negative results or no details at all. If null (not specified), the default value of 'HIT' is assumed. This parameter allows for returning boolean/counting results although the Beacon instance is capable to return record level details.",
"enum": [
"ALL",
"HIT",
"MISS",
"NONE"
],
"examples": [
"ALL",
"HIT",
"MISS",
"NONE"
],
"type": "string"
},
"Info": {
"description": "Placeholder to allow the Beacon to return any additional information that is necessary or could be of interest in relation to the query or the entry returned. It is recommended to encapsulate additional informations in this attribute instead of directly adding attributes at the same level than the others in order to avoid collision in the names of attributes in future versions of the specification.",
"type": "object"
},
"Limit": {
"default": 10,
"description": "Size of the page. Use `0` to return all the results or the maximum allowed by the Beacon, if there is any.",
"example": 10,
"minimum": 0,
"type": "integer"
},
"ListOfHandovers": {
"description": "Set of handovers to be added in one section the response.",
"items": {
"$ref": "#/definitions/Handover",
"description": "Requested schema to be used for individuals in the response."
},
"type": "array"
},
"ListOfSchemas": {
"description": "Set of schemas to be used in the response to a request.",
"items": {
"$ref": "#/definitions/SchemasPerEntity"
},
"type": "array"
},
"NonFilteredQueriesAllowed": {
"default": true,
"description": "Switch that declares if this Beacon instance, for a given entry type, admits queries that does not include any element that restrict returning all the results, like filters, parameters, ids, etc. The default value is 'true' for backward compatibility and for clarity in the request-response dialog.",
"type": "boolean"
},
"NumTotalResults": {
"description": "Total number of results. NOT the number of results returned in this batch (after pagination) but the total obtained by the query.",
"examples": [
123
],
"minimum": 0,
"type": "integer"
},
"PageToken": {
"description": "A hash or similar that allows the server to retrieve a \"page\", e.g. (a subset of) a query response.",
"example": "ab0sc&fe1dd",
"type": "string"
},
"Pagination": {
"description": "Pagination to apply or that has been applied on the results.",
"properties": {
"currentPage": {
"$ref": "#/definitions/PageToken",
"description": "Token of the returned page. To be used only in the response to allow the client to check if the returned page is the one requested."
},
"limit": {
"$ref": "#/definitions/Limit"
},
"nextPage": {
"$ref": "#/definitions/PageToken",
"description": "Token of the next page. Used to navigate forward. If empty, it is assumed that no more pages are available"
},
"previousPage": {
"$ref": "#/definitions/PageToken",
"description": "Token of the previous page. Used to navigate backwards. If empty, it is assumed that the current page is the first one."
},
"skip": {
"$ref": "#/definitions/Skip"
}
},
"type": "object"
},
"SchemasPerEntity": {
"description": "Schema to be used for the requested entry type in the response.",
"properties": {
"entityType": {
"$comment": "TO REVIEW: Should that refer to a concept definition? Or would that include an undesired dependency to the configuration?",
"example": "Individual",
"type": "string"
},
"schema": {
"$comment": "TO DO: Add the correct format as 'uri' or 'regex'",
"examples": [
"./ga4gh-beacon-dataset-v2.0.0",
"https://www.example.org/schemas/ga4gh-beacon-dataset-v2.0.0.json"
],
"type": "string"
}
},
"type": "object"
},
"Skip": {
"default": 0,
"description": "* In the request: number of pages to skip * In the response: number of pages that has been skipped",
"example": 0,
"minimum": 0,
"type": "integer"
},
"TestMode": {
"default": false,
"description": "Used for indicating that a request or response is done in a test context e.g. for compliance testing i.e. to evaluate the acceptance/understanding of a request and the structure of the returned response by the Beacon instance. A TRUE `testMode` parameter DOES NOT require that the Beacon instance is a test instance, but that this specific request-response cycle is a testing one. When `true` the Beacon instance MUST respond the request but it SHOULD use virtual or non-sensitive data. Here, what is being evaluated is the acceptance/understanding of a request and the structure of the returned response by the Beacon instance.",
"type": "boolean"
}
},
"description": "Definition of relatively simple components used in different points of the Beacon specification, both in requests and responses, therefore not associated exclusively with one or the other. Separate schema documents are provided for complex components.",
"title": "Beacon Common Components",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | bc8f02a6a388140c854f3e17da3ccb779f2cbc0b | 2022-08-22T09:50:37 | framework/json/responses/sections/beaconResponseMeta.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Information about the response that could be relevant for the Beacon client in order to interpret the results.",
"properties": {
"apiVersion": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/ApiVersion",
"description": "Version of the Beacon API."
},
"beaconId": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/BeaconId",
"description": "Identifier of the beacon instance."
},
"receivedRequestSummary": {
"$ref": "./beaconReceivedRequestSummary.json",
"description": "Section of the response that summarize the request received as it has been interpreted by the Beacon server."
},
"returnedGranularity": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/Granularity",
"description": "Granularity of the Beacon response. Targeted Beacon could respond or not with the requested granularity. E.g. record level granularity could be requested, but the Beacon could respond only with boolean or count results."
},
"returnedSchemas": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/ListOfSchemas"
},
"testMode": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/TestMode",
"description": "Used for indicating that a response is returned in a test context. Purposed for compliance testing. Information returned could be fake."
}
},
"required": [
"beaconId",
"apiVersion",
"returnedSchemas",
"returnedGranularity",
"receivedRequestSummary"
],
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | fa5d2cdd338e8c183f33f1a7d754f69f2c141525 | 2022-06-24T12:39:58 | models/json/beacon-v2-default-model/common/commonDefinitions.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Ethnicity": {
"$ref": "../../../../framework/json/common/ontologyTerm.json",
"description": "Ethnic background of the individual. Recommended is the use of a value from NCIT Race (NCIT:C17049) ontology term descendants, e.g. NCIT:C126531 (Latin American). A geographic ancestral origin category that is assigned to a population group based mainly on physical characteristics that are thought to be distinct and inherent. [ NCI ]",
"examples": [
{
"id": "NCIT:C42331",
"label": "African"
},
{
"id": "NCIT:C41260",
"label": "Asian"
},
{
"id": "NCIT:C126535",
"label": "Australian"
},
{
"id": "NCIT:C43851",
"label": "European"
},
{
"id": "NCIT:C77812",
"label": "North American"
},
{
"id": "NCIT:C126531",
"label": "Latin American"
},
{
"id": "NCIT:C104495",
"label": "Other race"
}
]
},
"GeographicLocation": {
"$ref": "../../../../framework/json/common/ontologyTerm.json",
"description": "Country or region of origin of the individual (birthplace or residence place regardless of ethnic origin). Value from GAZ Geographic Location ontology (GAZ:00000448), e.g. GAZ:00002459 (United States of America).",
"examples": [
{
"id": "GAZ:00002955",
"label": "Slovenia"
},
{
"id": "GAZ:00002459",
"label": "United States of America"
},
{
"id": "GAZ:00316959",
"label": "Municipality of El Masnou"
},
{
"id": "GAZ:00000460",
"label": "Eurasia"
}
]
},
"KaryotypicSex": {
"$comments": "Compares to https://github.com/phenopackets/phenopacket-schema/blob/master/docs/karyotypicsex.rst",
"default": "UNKNOWN_KARYOTYPE",
"description": "The chromosomal sex of an individual represented from a selection of options. The values correspond to the ordinal values in the Phenopackets schema where: * 0 - UNKNOWN_KARYOTYPE (Untyped or inconclusive karyotyping) * 1 - XX (Female) * 2 - XY (Male) * 3 - XO (Single X chromosome only) * 4 - XXY (Two X and one Y chromosome) * 5 - XXX (Three X chromosomes) * 6 - XXYY (Two X chromosomes and two Y chromosomes) * 7 - XXXY (Three X chromosomes and one Y chromosome) * 8 - XXXX (Four X chromosomes) * 9 - XYY (One X and two Y chromosomes) * 10 - OTHER_KARYOTYPE (None of the above types)",
"enum": [
"UNKNOWN_KARYOTYPE",
"XX",
"XY",
"XO",
"XXY",
"XXX",
"XXYY",
"XXXY",
"XXXX",
"XYY",
"OTHER_KARYOTYPE"
],
"type": "string"
},
"SeverityLevel": {
"$ref": "../../../../framework/json/common/ontologyTerm.json",
"description": "Severity as applicable to phenotype or disease observed. Recommended are values from Human Phenotype Ontology (HP:0012824), e.g `mild`. The intensity or degree of a manifestation. Source: Phenopackets v2",
"examples": [
{
"id": "HP:0012828",
"label": "Severe"
},
{
"id": "HP:0012829",
"label": "Profound"
},
{
"id": "HP:0012826",
"label": "Moderate"
},
{
"id": "HP:0012825",
"label": "Mild"
},
{
"id": "HP:0012827",
"label": "Borderline"
}
]
},
"Sex": {
"$ref": "../../../../framework/json/common/ontologyTerm.json",
"description": "Sex of the individual. Recommended values from NCIT General Qualifier (NCIT:C27993): \"unknown\" (not assessed or not available) - NCIT:C17998; \"female\" - NCIT:C16576; \"male\" - NCIT:C20197",
"examples": [
{
"id": "NCIT:C16576",
"label": "female"
},
{
"id": "NCIT:C20197",
"label": "male"
},
{
"id": "NCIT:C1799",
"label": "unknown"
}
]
},
"Timestamp": {
"description": "Time in date-time ISO8601 string format.",
"examples": [
"1999-08-05T17:21:00+01:00",
"2002-09-21T02:37:00-08:00"
],
"format": "date-time",
"type": "string"
},
"Unit": {
"$ref": "../../../../framework/json/common/ontologyTerm.json",
"description": "The kind of unit. Recommended from NCIT Unit of Category ontology term (NCIT:C42568) descendants",
"examples": [
{
"id": "NCIT:C70575",
"label": "Roentgen"
},
{
"id": "NCIT:C28252",
"label": "Kilogram"
},
{
"id": "NCIT:C28253",
"label": "Milligram"
}
]
}
},
"description": "Definitions for concepts used in several entry types, but that having only one property are not complex enough to require a full independent schema document.",
"title": "Common Definitions"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 9eaada7ca0410f4127d0c324880033e60024d128 | 2022-03-13T12:14:16 | models/json/beacon-v2-default-model/common/commonDefinitions.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"Ethnicity": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "Ethnic background of the individual. Value from NCIT Race (NCIT:C17049) ontology term descendants, e.g. NCIT:C126531 (Latin American). A geographic ancestral origin category that is assigned to a population group based mainly on physical characteristics that are thought to be distinct and inherent. [ NCI ] ",
"examples": [
{
"id": "NCIT:C42331",
"label": "African"
},
{
"id": "NCIT:C41260",
"label": "Asian"
},
{
"id": "NCIT:C126535",
"label": "Australian"
},
{
"id": "NCIT:C43851",
"label": "European"
},
{
"id": "NCIT:C77812",
"label": "North American"
},
{
"id": "NCIT:C126531",
"label": "Latin American"
},
{
"id": "NCIT:C104495",
"label": "Other race"
}
]
},
"GeographicLocation": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "Country or region of origin of the individual (birthplace or residence place regardless of ethnic origin). Value from GAZ Geographic Location ontology (GAZ:00000448), e.g. GAZ:00002459 (United States of America).",
"examples": [
{
"id": "GAZ:00002955",
"label": "Slovenia"
},
{
"id": "GAZ:00002459",
"label": "United States of America"
},
{
"id": "GAZ:00316959",
"label": "Municipality of El Masnou"
},
{
"id": "GAZ:00000460",
"label": "Eurasia"
}
]
},
"KaryotypicSex": {
"$comments": "Compares to https://github.com/phenopackets/phenopacket-schema/blob/master/docs/karyotypicsex.rst",
"default": "UNKNOWN_KARYOTYPE",
"description": "The chromosomal sex of an individual represented from a selection of options. The values correspond to the ordinal values in the Phenopackets schema where: 0 - UNKNOWN_KARYOTYPE (Untyped or inconclusive karyotyping); 1 - XX (Female); 2 - XY (Male); 3 - XO (Single X chromosome only); 4 - XXY (Two X and one Y chromosome); 5 - XXX (Three X chromosomes); 6 - XXYY (Two X chromosomes and two Y chromosomes); 7 - XXXY (Three X chromosomes and one Y chromosome); 8 - XXXX (Four X chromosomes); 9 - XYY (One X and two Y chromosomes); 10 - OTHER_KARYOTYPE (None of the above types)",
"enum": [
"UNKNOWN_KARYOTYPE",
"XX",
"XY",
"XO",
"XXY",
"XXX",
"XXYY",
"XXXY",
"XXXX",
"XYY",
"OTHER_KARYOTYPE"
],
"type": "string"
},
"SeverityLevel": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "Level/severity ontology when and as applicable to phenotype observed. Value from Human Phenotype Ontology (HP:0012824), e.g `mild`. The intensity or degree of a manifestation. [ HPO:probinson ] ",
"examples": [
{
"id": "HP:0012825",
"label": "Severe"
},
{
"id": "HP:0012829",
"label": "Profound"
},
{
"id": "HP:0012826",
"label": "Moderate"
},
{
"id": "HP:0012825",
"label": "Mild"
},
{
"id": "HP:0012827",
"label": "Bordeline"
}
]
},
"Sex": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "Sex of the individual. Value from NCIT General Qualifier (NCIT:C27993): 'unknown' (not assessed or not available) (NCIT:C17998), 'female' (NCIT:C16576), or 'male', (NCIT:C20197).",
"examples": [
{
"id": "NCIT:C16576",
"label": "female"
},
{
"id": "NCIT:C20197",
"label": "male"
},
{
"id": "NCIT:C1799",
"label": "unknown"
}
]
},
"Unit": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity-testing/main/framework/json/common/ontologyTerm.json",
"description": "The kind of unit. Recommended from NCIT Unit of Category ontology term (NCIT:C42568) descendants",
"examples": [
{
"id": "NCIT:C70575",
"label": "Roentgen"
},
{
"id": "NCIT:C28252",
"label": "Kilogram"
},
{
"id": "NCIT:C28253",
"label": "Milligram"
}
]
}
},
"description": "Definitions for concepts used in several entry types, but that having only one property are not complex enough to require a full independent schema document.",
"title": "Common Definitions"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 1c03b708fdfd3e822886f51f0bb20f658030f76c | 2022-03-28T12:54:26 | models/json/beacon-v2-default-model/common/dataUseConditions.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"definitions": {
"DUODataUse": {
"allOf": [
{
"description": "Data Use Ontology codes and additional information associated with a data object (e.g. sample, dataset)."
},
{
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json"
},
{
"properties": {
"modifiers": {
"examples": [
{
"id": "EFO:0001645",
"label": "coronary artery disease"
},
{
"id": "EFO:0001655"
}
],
"items": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json"
},
"type": "array"
},
"version": {
"examples": [
"17-07-2016"
],
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
}
],
"examples": [
{
"id": "DUO:0000007",
"label": "disease specific research",
"modifiers": [
{
"id": "EFO:0001645",
"label": "coronary artery disease"
}
],
"version": "17-07-2016"
},
{
"id": "DUO:0000004",
"label": "no restriction",
"version": "2022-03-23"
}
]
}
},
"description": "Data use conditions",
"properties": {
"duoDataUse": {
"items": {
"$ref": "#/definitions/DUODataUse"
},
"minItems": 1,
"type": "array"
}
},
"title": "Data Use Conditions",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | b154ddaeb17b88ca39f6e0396feba4447ade12de | 2024-04-11T13:35:03 | models/json/beacon-v2-default-model/common/complexValue.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {
"TypedQuantity": {
"properties": {
"quantity": {
"$ref": "./quantity.json",
"description": "Quantity denoting the outcome of the measurement",
"example": {
"quentity": {
"unit": {
"id": "NCIT:C49670",
"label": "Millimeter of Mercury"
}
}
}
},
"quantityType": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json",
"description": "OntologyClass to describe the type of the measurement. Renamed compared to GA4GH Phenopackets v2 `ComplexValue.TypedQuantity.type`",
"example": {
"id": "NCIT:C25298",
"label": "Systolic Blood Pressure"
}
}
},
"required": [
"quantityType",
"quantity"
]
}
},
"description": "Definition of a complex value class. Provenance: GA4GH Phenopackets v2 `TypedQuantity`",
"properties": {
"typedQuantities": {
"description": "List of quantities required to fully describe the complex value",
"items": {
"$ref": "#/definitions/TypedQuantity"
},
"type": "array"
}
},
"required": [
"typedQuantities"
],
"title": "Complex Value",
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/common/examples/basicElement-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"id": "BEex1",
"name": "Basic Element example one"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 7275a36c9838095895f79d4e96b33a0db23f5f99 | 2022-12-21T17:43:28 | framework/json/responses/sections/beaconResponseMeta.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Information about the response that could be relevant for the Beacon client in order to interpret the results.",
"properties": {
"apiVersion": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/ApiVersion"
},
"beaconId": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/BeaconId"
},
"receivedRequestSummary": {
"$ref": "./beaconReceivedRequestSummary.json"
},
"returnedGranularity": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/Granularity",
"description": "Granularity of the Beacon response which may differ from the requested one. For details see the prototype definition."
},
"returnedSchemas": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/ListOfSchemas"
},
"testMode": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/TestMode"
}
},
"required": [
"beaconId",
"apiVersion",
"returnedSchemas",
"returnedGranularity",
"receivedRequestSummary"
],
"type": "object"
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 86d8c3bebb92dc892e2560022884e1ddea491821 | 2022-02-22T13:58:39 | framework/json/responses/examples-fullDocuments/beaconErrorResponse_example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"error": {
"errorCode": 400,
"errorMessage": "Bad request. Missing parameter 'id'."
},
"meta": {
"apiVersion": "v2.0",
"beaconId": "org.example.beacon.v2",
"receivedRequestSummary": {
"apiVersion": "v2.0",
"filters": [
"BTO:0000199",
"PATO:0000383"
],
"pagination": {
"limit": 10,
"skip": 1
},
"requestParameters": [
{
"entity": "individual",
"parameters": [
{
"id": "123"
},
{
"position": "1234556"
}
]
}
],
"requestedSchemas": [
{
"entityType": "Individual",
"schema": "ga4gh-phenopacket-individual-v0.1"
}
]
},
"returnedSchemas": []
}
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 3e6093cf1b20ac74bc021c315511094f930be1ef | 2022-02-22T11:21:39 | framework/json/requests/examples-sections/filteringTerms-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"filters": [
{
"id": "HP:0002664",
"includeDescendantTerms": true,
"scope": "biosamples",
"similarity": "exact"
},
{
"id": "age",
"operator": ">=",
"scope": "individuals",
"value": "P70Y"
},
{
"id": "demographic.ethnicity:asian",
"scope": "cohorts"
}
]
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 86d8c3bebb92dc892e2560022884e1ddea491821 | 2022-02-22T13:58:39 | framework/json/responses/examples-fullDocuments/beaconConfigurationResponse-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"info": {},
"meta": {
"apiVersion": "string",
"beaconId": "string",
"returnedSchemas": [
{
"entityType": "info",
"schema": "beacon-map-v2.0.0"
}
]
},
"response": {
"$schema": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2-unity/main/framework/json/configuration/beaconConfigurationSchema.json",
"entryTypes": {
"dataset": {
"aCollectionOf": [
{
"id": "exampleEntry",
"name": "Example entries"
}
],
"additionallySupportedSchemas": [],
"defaultSchema": {
"id": "datasetDefaultSchema",
"name": "Default schema for datasets",
"referenceToSchemaDefinition": "./datasets/defaultSchema.json",
"schemaVersion": "v.2"
},
"description": "A Dataset is a collection of records, like rows in a database or cards in a cardholder.",
"endpoint": "/datasets",
"filteringTermsReference": "./datasets/filteringTerms.json",
"id": "dataset",
"name": "Dataset",
"ontologyTermForThisType": {
"id": "NCIT:C47824",
"label": "Data set"
},
"partOfSpecification": "Beacon v2.0"
},
"exampleEntry": {
"additionallySupportedSchemas": [],
"defaultSchema": {
"id": "ExampleEntryTypeDefaultschema",
"name": "Default schema for an example entries",
"referenceToSchemaDefinition": "./exampleEntry/defaultSchema.json",
"schemaVersion": "v.2"
},
"description": "A generic entry type to allow testing and playing with the specification.",
"endpoint": "./exampleEntries",
"filteringTermsReference": "./exampleEntry/filteringTerms.json",
"id": "exampleEntry",
"name": "Example Entry",
"ontologyTermForThisType": {
"id": "NCIT:C20181",
"label": "Conceptual Entity"
},
"partOfSpecification": "Beacon v2.0"
}
},
"maturityAttributes": {
"productionStatus": "DEV"
},
"securityAttributes": {
"defaultGranularity": "boolean",
"securityLevels": [
"PUBLIC",
"REGISTERED",
"CONTROLLED"
]
}
}
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 030747a0ef492bd79dc53d3eaf9f6c16ceae236a | 2022-02-22T13:50:28 | framework/json/responses/examples-sections/beaconResultsetEmpty-example.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"resultSets": [
{
"exists": false,
"id": "correctEmptyResultSet",
"type": "dataset"
}
]
} | CC0-1.0 | en |
ga4gh-beacon/beacon-v2 | 89f9aacffcb00b3395ffa9d908cf38c7bb598b5e | 2022-03-23T07:55:42 | models/json/beacon-v2-default-model/common/measurement.json | 21 | 2024-05-27T06:03:09.146153Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of a measurement class. Provenance: GA4GH Phenopackets v2 `Measurement`",
"properties": {
"assayCode": {
"$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/ontologyTerm.json",
"description": "Class that describes the assay used to produce the measurement. Renamed compared to GA4GH Phenopackets v2 `Measurement.assay`",
"example": {
"id": "LOINC:26515-7",
"label": "Platelets [#/volume] in Blood"
}
},
"date": {
"description": "Date of measurement. Addition compared to Phenopackets model.",
"format": "date",
"type": "string"
},
"measurementValue": {
"description": "The result of the measurement",
"oneOf": [
{
"$ref": "./value.json"
},
{
"$ref": "./complexValue.json"
}
]
},
"notes": {
"description": "Unstructured text to describe this measurement. Addition compared to Phenopackets model.",
"example": "Some free text",
"type": "string"
},
"observationMoment": {
"$ref": "./timeElement.json",
"description": "Moment in time at which measurement was performed. RECOMMENDED. Renamed compared to GA4GH Phenopackets v2 `Measurement.time_observed`",
"example": {
"age": {
"iso8601duration": "P53Y8M"
}
}
},
"procedure": {
"$ref": "./procedure.json",
"description": "Clinical procedure performed to acquire the sample used for the measurement",
"example": {
"code": {
"id": "NCIT:C5189",
"label": "Radical Cystoprostatectomy"
}
}
}
},
"required": [
"assayCode",
"measurementValue"
],
"title": "Measurement",
"type": "object"
} | CC0-1.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/schemas/ControlType.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/ControlType.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "POWER_ENVELOPE_BASED_CONTROL: Identifier for the Power Envelope Based Control type\nPOWER_PROFILE_BASED_CONTROL: Identifier for the Power Profile Based Control type\nOPERATION_MODE_BASED_CONTROL: Identifier for the Operation Mode Based Control type\nFILL_RATE_BASED_CONTROL: Identifier for the Demand Driven Based Control type\nDEMAND_DRIVEN_BASED_CONTROL: Identifier for the Fill Rate Based Control type\nNOT_CONTROLABLE: Identifier that is to be used if no control is possible. Resources of this type can still provide measurements and forecast\nNO_SELECTION: Identifier that is to be used if no control type is or has been selected. ",
"enum": [
"POWER_ENVELOPE_BASED_CONTROL",
"POWER_PROFILE_BASED_CONTROL",
"OPERATION_MODE_BASED_CONTROL",
"FILL_RATE_BASED_CONTROL",
"DEMAND_DRIVEN_BASED_CONTROL",
"NOT_CONTROLABLE",
"NO_SELECTION"
],
"title": "ControlType"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b41a8ced359056a53175ca84d0b7696b368e3afd | 2022-10-13T08:29:57 | s2-json-schema/schemas/Timer.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/Timer.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"diagnostic_label": {
"description": "Human readable name/description of the Timer. This element is only intended for diagnostic purposes and not for HMI applications.",
"type": "string"
},
"duration": {
"$ref": "../schemas/Duration.schema.json",
"description": "The time it takes for the Timer to finish after it has been started"
},
"finished_at": {
"description": "Indicates when the Timer will be finished. If the DateTimeStamp is in the future, the timer is not yet finished. If the DateTimeStamp is in the past, the timer is finished. If the timer was never started, the value can be an arbitrary DateTimeStamp in the past.",
"format": "date-time",
"type": "string"
},
"id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the Timer. Must be unique in the scope of the OMBC.SystemDescription, FRBC.ActuatorDescription or DDBC.ActuatorDescription in which it is used."
}
},
"required": [
"id",
"duration",
"finished_at"
],
"title": "Timer"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b41a8ced359056a53175ca84d0b7696b368e3afd | 2022-10-13T08:29:57 | s2-json-schema/schemas/PEBC.PowerEnvelopeLimitType.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/PEBC.PowerEnvelopeLimitType.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "UPPER_LIMIT: Indicating the upper limit of a PEBC.PowerEnvelope (see Clause\u00a07.6.2)\nLOWER_LIMIT: Indicating the lower limit of a PEBC.PowerEnvelope (see Clause\u00a07.6.2)",
"enum": [
"UPPER_LIMIT",
"LOWER_LIMIT"
],
"title": "PEBC_PowerEnvelopeLimitType"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b41a8ced359056a53175ca84d0b7696b368e3afd | 2022-10-13T08:29:57 | s2-json-schema/schemas/PowerValue.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/PowerValue.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"commodity_quantity": {
"$ref": "../schemas/CommodityQuantity.schema.json",
"description": "The power quantity the value refers to"
},
"value": {
"description": "Power value expressed in the unit associated with the CommodityQuantity",
"type": "number"
}
},
"required": [
"commodity_quantity",
"value"
],
"title": "PowerValue"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b831b6f1f19f824f32269ecd6ac6a6e250e7af80 | 2023-09-21T12:56:11 | s2-json-schema/messages/OMBC.Instruction.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/OMBC.Instruction.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"abnormal_condition": {
"description": "Indicates if this is an instruction during an abnormal condition",
"type": "boolean"
},
"execution_time": {
"description": "Indicates the moment the execution of the instruction shall start. When the specified execution time is in the past, execution must start as soon as possible.",
"format": "date-time",
"type": "string"
},
"id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the instruction. Must be unique in the scope of the Resource Manager, for at least the duration of the session between Resource Manager and CEM."
},
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "OMBC.Instruction",
"type": "string"
},
"operation_mode_factor": {
"description": "The number indicates the factor with which the OMBC.OperationMode should be configured. The factor should be greater than or equal than 0 and less or equal to 1.",
"type": "number"
},
"operation_mode_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the OMBC.OperationMode that should be activated"
}
},
"required": [
"message_type",
"message_id",
"id",
"execution_time",
"operation_mode_id",
"operation_mode_factor",
"abnormal_condition"
],
"title": "OMBC_Instruction"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b831b6f1f19f824f32269ecd6ac6a6e250e7af80 | 2023-09-21T12:56:11 | s2-json-schema/messages/PPBC.EndInterruptionInstruction.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/PPBC.EndInterruptionInstruction.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"abnormal_condition": {
"description": "Indicates if this is an instruction during an abnormal condition",
"type": "boolean"
},
"execution_time": {
"description": "Indicates the moment PPBC.PowerSequence interruption shall end. When the specified execution time is in the past, execution must start as soon as possible.",
"format": "date-time",
"type": "string"
},
"id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the Instruction. Must be unique in the scope of the Resource Manager, for at least the duration of the session between Resource Manager and CEM."
},
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "PPBC.EndInterruptionInstruction",
"type": "string"
},
"power_profile_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the PPBC.PowerProfileDefinition of which the PPBC.PowerSequence interruption is being ended by the CEM."
},
"power_sequence_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the PPBC.PowerSequence for which the CEM wants to end the interruption."
},
"sequence_container_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the PPBC.PowerSequnceContainer of which the PPBC.PowerSequence interruption is being ended by the CEM."
}
},
"required": [
"message_type",
"message_id",
"id",
"power_profile_id",
"sequence_container_id",
"power_sequence_id",
"execution_time",
"abnormal_condition"
],
"title": "PPBC_EndInterruptionInstruction"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/messages/DDBC.Instruction.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/DDBC.Instruction.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"abnormal_condition": {
"description": "Indicates if this is an instruction during an abnormal condition",
"type": "boolean"
},
"actuator_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the actuator this Instruction belongs to."
},
"execution_time": {
"description": "Indicates the moment the execution of the instruction shall start",
"format": "date-time",
"type": "string"
},
"id": {
"$ref": "../schemas/ID.schema.json",
"description": "Identifier of this DDBC.Instruction. Must be unique in the scope of the Resource Manager, for at least the duration of the session between Resource Manager and CEM."
},
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "DDBC.Instruction",
"type": "string"
},
"operation_mode_factor": {
"description": "The number indicates the factor with which the OMBC.OperationMode should be configured. The factor should be greater than or equal to 0 and less or equal to 1.",
"type": "number"
},
"operation_mode_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the DDBC.OperationMode"
}
},
"required": [
"message_type",
"message_id",
"id",
"execution_time",
"abnormal_condition",
"actuator_id",
"operation_mode_id",
"operation_mode_factor"
],
"title": "DDBC_Instruction"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b41a8ced359056a53175ca84d0b7696b368e3afd | 2022-10-13T08:29:57 | s2-json-schema/schemas/PPBC.PowerSequenceContainerStatus.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/PPBC.PowerSequenceContainerStatus.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"power_profile_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the PPBC.PowerProfileDefinition of which the data element \u2018sequence_container_id\u2019 refers to. "
},
"progress": {
"$ref": "../schemas/Duration.schema.json",
"description": "Time that has passed since the selected sequence has started. A value must be provided, unless no sequence has been selected or the selected sequence hasn\u2019t started yet."
},
"selected_sequence_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of selected PPBC.PowerSequence. When no ID is given, no sequence was selected yet."
},
"sequence_container_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the PPBC.PowerSequenceContainer this PPBC.PowerSequenceContainerStatus provides information about."
},
"status": {
"$ref": "../schemas/PPBC.PowerSequenceStatus.schema.json",
"description": "Status of the selected PPBC.PowerSequence"
}
},
"required": [
"power_profile_id",
"sequence_container_id",
"status"
],
"title": "PPBC_PowerSequenceContainerStatus"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b41a8ced359056a53175ca84d0b7696b368e3afd | 2022-10-13T08:29:57 | s2-json-schema/schemas/PowerForecastElement.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/PowerForecastElement.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"duration": {
"$ref": "../schemas/Duration.schema.json",
"description": "Duration of the PowerForecastElement"
},
"power_values": {
"description": "The values of power that are expected for the given period of time. There shall be at least one PowerForecastValue, and at most one PowerForecastValue per CommodityQuantity.",
"items": {
"$ref": "../schemas/PowerForecastValue.schema.json"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
}
},
"required": [
"duration",
"power_values"
],
"title": "PowerForecastElement"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/messages/PPBC.ScheduleInstruction.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/PPBC.ScheduleInstruction.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"abnormal_condition": {
"description": "Indicates if this is an instruction during an abnormal condition",
"type": "boolean"
},
"execution_time": {
"description": "Start time of the PPBC.PowerSequence.",
"format": "date-time",
"type": "string"
},
"id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the Instruction. Must be unique in the scope of the Resource Manager, for at least the duration of the session between Resource Manager and CEM."
},
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "PPBC.ScheduleInstruction",
"type": "string"
},
"power_profile_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the PPBC.PowerProfileDefinition of which the PPBC.PowerSequence is being selected and scheduled by the CEM."
},
"power_sequence_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the PPBC.PowerSequence that is being selected and scheduled by the CEM."
},
"sequence_container_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the PPBC.PowerSequnceContainer of which the PPBC.PowerSequence is being selected and scheduled by the CEM."
}
},
"required": [
"message_type",
"message_id",
"id",
"power_profile_id",
"sequence_container_id",
"power_sequence_id",
"execution_time",
"abnormal_condition"
],
"title": "PPBC_ScheduleInstruction"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b831b6f1f19f824f32269ecd6ac6a6e250e7af80 | 2023-09-21T12:56:11 | s2-json-schema/messages/DDBC.Instruction.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/DDBC.Instruction.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"abnormal_condition": {
"description": "Indicates if this is an instruction during an abnormal condition",
"type": "boolean"
},
"actuator_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the actuator this Instruction belongs to."
},
"execution_time": {
"description": "Indicates the moment the execution of the instruction shall start. When the specified execution time is in the past, execution must start as soon as possible.",
"format": "date-time",
"type": "string"
},
"id": {
"$ref": "../schemas/ID.schema.json",
"description": "Identifier of this DDBC.Instruction. Must be unique in the scope of the Resource Manager, for at least the duration of the session between Resource Manager and CEM."
},
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "DDBC.Instruction",
"type": "string"
},
"operation_mode_factor": {
"description": "The number indicates the factor with which the OMBC.OperationMode should be configured. The factor should be greater than or equal to 0 and less or equal to 1.",
"type": "number"
},
"operation_mode_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the DDBC.OperationMode"
}
},
"required": [
"message_type",
"message_id",
"id",
"execution_time",
"abnormal_condition",
"actuator_id",
"operation_mode_id",
"operation_mode_factor"
],
"title": "DDBC_Instruction"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/schemas/RoleType.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/RoleType.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "ENERGY_PRODUCER: Identifier for RoleType Producer\nENERGY_CONSUMER: Identifier for RoleType Consumer\nENERGY_STORAGE: Identifier for RoleType Storage",
"enum": [
"ENERGY_PRODUCER",
"ENERGY_CONSUMER",
"ENERGY_STORAGE"
],
"title": "RoleType"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/messages/FRBC.StorageStatus.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/FRBC.StorageStatus.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "FRBC.StorageStatus",
"type": "string"
},
"present_fill_level": {
"description": "Present fill level of the Storage",
"type": "number"
}
},
"required": [
"message_type",
"message_id",
"present_fill_level"
],
"title": "FRBC_StorageStatus"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/messages/OMBC.Status.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/OMBC.Status.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"active_operation_mode_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the active OMBC.OperationMode."
},
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "OMBC.Status",
"type": "string"
},
"operation_mode_factor": {
"description": "The number indicates the factor with which the OMBC.OperationMode should be configured. The factor should be greater than or equal than 0 and less or equal to 1.",
"type": "number"
},
"previous_operation_mode_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the OMBC.OperationMode that was previously active. This value shall always be provided, unless the active OMBC.OperationMode is the first OMBC.OperationMode the Resource Manager is aware of."
},
"transition_timestamp": {
"description": "Time at which the transition from the previous OMBC.OperationMode to the active OMBC.OperationMode was initiated. This value shall always be provided, unless the active OMBC.OperationMode is the first OMBC.OperationMode the Resource Manager is aware of.",
"format": "date-time",
"type": "string"
}
},
"required": [
"message_type",
"message_id",
"active_operation_mode_id",
"operation_mode_factor"
],
"title": "OMBC_Status"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/schemas/ReceptionStatusValues.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/ReceptionStatusValues.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "INVALID_DATA: Message not understood (e.g. not valid JSON, no message_id found). Consequence: Message is ignored, proceed if possible\nINVALID_MESSAGE: Message was not according to schema. Consequence: Message is ignored, proceed if possible\nINVALID_CONTENT: Message contents is invalid (e.g. contains a non-existing ID). Somewhat equivalent to BAD_REQUEST in HTTP.. Consequence: Message is ignored, proceed if possible.\nTEMPORARY_ERROR: Receiver encountered an error. Consequence: Try to send to message again\nPERMANENT_ERROR: Receiver encountered an error which it cannot recover from. Consequence: Disconnect.\nOK: Message processed normally. Consequence: Proceed normally.",
"enum": [
"INVALID_DATA",
"INVALID_MESSAGE",
"INVALID_CONTENT",
"TEMPORARY_ERROR",
"PERMANENT_ERROR",
"OK"
],
"title": "ReceptionStatusValues"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b41a8ced359056a53175ca84d0b7696b368e3afd | 2022-10-13T08:29:57 | s2-json-schema/schemas/ControlType.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/ControlType.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "POWER_ENVELOPE_BASED_CONTROL: Identifier for the Power Envelope Based Control type\nPOWER_PROFILE_BASED_CONTROL: Identifier for the Power Profile Based Control type\nOPERATION_MODE_BASED_CONTROL: Identifier for the Operation Mode Based Control type\nFILL_RATE_BASED_CONTROL: Identifier for the Demand Driven Based Control type\nDEMAND_DRIVEN_BASED_CONTROL: Identifier for the Fill Rate Based Control type\nNOT_CONTROLABLE: Identifier that is to be used if no control is possible. Resources of this type can still provide measurements and forecast\nNO_SELECTION: Identifier that is to be used if no control type is or has been selected. ",
"enum": [
"POWER_ENVELOPE_BASED_CONTROL",
"POWER_PROFILE_BASED_CONTROL",
"OPERATION_MODE_BASED_CONTROL",
"FILL_RATE_BASED_CONTROL",
"DEMAND_DRIVEN_BASED_CONTROL",
"NOT_CONTROLABLE",
"NO_SELECTION"
],
"title": "ControlType"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/messages/SelectControlType.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/SelectControlType.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"control_type": {
"$ref": "../schemas/ControlType.schema.json",
"description": "The ControlType to activate. Must be one of the available ControlTypes as defined in the ResourceManagerDetails"
},
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "SelectControlType",
"type": "string"
}
},
"required": [
"message_type",
"message_id",
"control_type"
],
"title": "SelectControlType"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 5ab1232df3cdb0cd619fe97fafaa269323a9d6ac | 2023-03-07T14:10:37 | s2-json-schema/schemas/Currency.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/Currency.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Currency used when this resource gives cost information",
"enum": [
"AED",
"ANG",
"AUD",
"CHE",
"CHF",
"CHW",
"EUR",
"GBP",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STD",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"UYI",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XOF",
"XPD",
"XPF",
"XPT",
"XSU",
"XTS",
"XUA",
"XXX",
"YER",
"ZAR",
"ZMW",
"ZWL"
],
"title": "Currency",
"type": "string"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/schemas/CommodityQuantity.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/CommodityQuantity.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "ELECTRIC.POWER.L1: Electric power described in Watt on phase 1. If a device utilizes only one phase it should always use L1.\nELECTRIC.POWER.L2: Electric power described in Watt on phase 2. Only applicable for 3 phase devices.\nELECTRIC.POWER.L3: Electric power described in Watt on phase 3. Only applicable for 3 phase devices.\nELECTRIC.POWER.3_PHASE_SYMMETRIC: Electric power described in Watt on when power is equally shared among the three phases. Only applicable for 3 phase devices.\nNATURAL_GAS.FLOW_RATE: Gas flow rate described in liters per second\nHYDROGEN.FLOW_RATE: Gas flow rate described in grams per second\nHEAT.TEMPERATURE: Heat described in degrees Celsius\nHEAT.FLOW_RATE: Flow rate of heat carrying gas or liquid in liters per second\nHEAT.THERMAL_POWER: Thermal power in Watt\nOIL.FLOW_RATE: Oil flow rate described in liters per hour",
"enum": [
"ELECTRIC.POWER.L1",
"ELECTRIC.POWER.L2",
"ELECTRIC.POWER.L3",
"ELECTRIC.POWER.3_PHASE_SYMMETRIC",
"NATURAL_GAS.FLOW_RATE",
"HYDROGEN.FLOW_RATE",
"HEAT.TEMPERATURE",
"HEAT.FLOW_RATE",
"HEAT.THERMAL_POWER",
"OIL.FLOW_RATE"
],
"title": "CommodityQuantity"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/schemas/DDBC.ActuatorDescription.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/DDBC.ActuatorDescription.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"diagnostic_label": {
"description": "Human readable name/description of the actuator. This element is only intended for diagnostic purposes and not for HMI applications.",
"type": "string"
},
"id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this DDBC.ActuatorDescription. Must be unique in the scope of the Resource Manager, for at least the duration of the session between Resource Manager and CEM."
},
"operation_modes": {
"description": "List of all Operation Modes that are available for this actuator. There shall be at least one DDBC.OperationMode.",
"items": {
"$ref": "../schemas/DDBC.OperationMode.schema.json"
},
"maxItems": 100,
"minItems": 1,
"type": "array"
},
"supported_commodites": {
"description": "Commodities supported by the operation modes of this actuator. There shall be at least one commodity",
"items": {
"$ref": "../schemas/Commodity.schema.json"
},
"maxItems": 4,
"minItems": 1,
"type": "array"
},
"timers": {
"description": "List of Timers associated with Transitions for this Actuator. Can be empty.",
"items": {
"$ref": "../schemas/Timer.schema.json"
},
"maxItems": 1000,
"minItems": 0,
"type": "array"
},
"transitions": {
"description": "List of Transitions between Operation Modes. Shall contain at least one Transition.",
"items": {
"$ref": "../schemas/Transition.schema.json"
},
"maxItems": 1000,
"minItems": 1,
"type": "array"
}
},
"required": [
"id",
"supported_commodites",
"operation_modes",
"transitions",
"timers"
],
"title": "DDBC_ActuatorDescription"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b41a8ced359056a53175ca84d0b7696b368e3afd | 2022-10-13T08:29:57 | s2-json-schema/messages/PowerForecast.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/PowerForecast.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"elements": {
"description": "Elements of which this forecast consists. Contains at least one element. Elements must be placed in chronological order.",
"items": {
"$ref": "../schemas/PowerForecastElement.schema.json"
},
"maxItems": 288,
"minItems": 1,
"type": "array"
},
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "PowerForecast",
"type": "string"
},
"start_time": {
"description": "Start time of time period that is covered by the profile.",
"format": "date-time",
"type": "string"
}
},
"required": [
"message_type",
"message_id",
"start_time",
"elements"
],
"title": "PowerForecast"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/messages/ReceptionStatus.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/ReceptionStatus.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"diagnostic_label": {
"description": "Diagnostic label that can be used to provide additional information for debugging. However, not for HMI purposes.",
"type": "string"
},
"message_type": {
"const": "ReceptionStatus",
"type": "string"
},
"status": {
"$ref": "../schemas/ReceptionStatusValues.schema.json",
"description": "Enumeration of status values"
},
"subject_message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "The message this ReceptionStatus refers to"
}
},
"required": [
"message_type",
"subject_message_id",
"status"
],
"title": "ReceptionStatus"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 1f98fc35f18c8410e5596b6c8df908be970fd5c2 | 2023-02-25T15:58:02 | s2-json-schema/schemas/Currency.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/Currency.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Currency used when this resource gives cost information",
"enum": [
"AED",
"ANG",
"AUD",
"CHE",
"CHF",
"CHW",
"EUR",
"GBP",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRO",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STD",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"UYI",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XOF",
"XPD",
"XPF",
"XPT",
"XSU",
"XTS",
"XUA",
"XXX",
"YER",
"ZAR",
"ZMW",
"ZWL"
],
"title": "Currency",
"type": "string"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/messages/SessionRequest.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/SessionRequest.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"diagnostic_label": {
"description": "Optional field for a human readible descirption for debugging purposes",
"type": "string"
},
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "SessionRequest",
"type": "string"
},
"request": {
"$ref": "../schemas/SessionRequestType.schema.json",
"description": "The type of request"
}
},
"required": [
"message_type",
"message_id",
"request"
],
"title": "SessionRequest"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 27f5fd87b4a5d0d6b1f9c0288d7aaae25e306d10 | 2023-02-25T15:59:31 | s2-json-schema/schemas/ID.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/ID.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "An identifier exapressed as a UUID",
"pattern": "[a-zA-Z0-9\\-_:]{2,64}",
"title": "ID",
"type": "string"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b41a8ced359056a53175ca84d0b7696b368e3afd | 2022-10-13T08:29:57 | s2-json-schema/messages/OMBC.Status.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/OMBC.Status.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"active_operation_mode_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the active OMBC.OperationMode."
},
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "OMBC.Status",
"type": "string"
},
"operation_mode_factor": {
"description": "The number indicates the factor with which the OMBC.OperationMode should be configured. The factor should be greater than or equal than 0 and less or equal to 1.",
"type": "number"
},
"previous_operation_mode_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the OMBC.OperationMode that was previously active. This value shall always be provided, unless the active OMBC.OperationMode is the first OMBC.OperationMode the Resource Manager is aware of."
},
"transition_timestamp": {
"description": "Time at which the transition from the previous OMBC.OperationMode to the active OMBC.OperationMode was initiated. This value shall always be provided, unless the active OMBC.OperationMode is the first OMBC.OperationMode the Resource Manager is aware of.",
"format": "date-time",
"type": "string"
}
},
"required": [
"message_type",
"message_id",
"active_operation_mode_id",
"operation_mode_factor"
],
"title": "OMBC_Status"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/schemas/RevokableObjects.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/RevokableObjects.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "PEBC.PowerConstraints: Object type PEBC.PowerConstraints\nPEBC.EnergyConstraint: Object type PEBC.EnergyConstraint\nPEBC.Instruction: Object type PEBC.Instruction\nPPBC.PowerProfileDefinition: Object type PPBC.PowerProfileDefinition\nPPBC.ScheduleInstruction: Object type PPBC.ScheduleInstruction\nPPBC.StartInterruptionInstruction: Object type PPBC.StartInterruptionInstruction\nPPBC.EndInterruptionInstruction: Object type PPBC.EndInterruptionInstruction\nOMBC.SystemDescription: Object type OMBC.SystemDescription\nOMBC.Instruction: Object type OMBC.Instruction\nFRBC.SystemDescription: Object type FRBC.SystemDescription\nFRBC.Instruction: Object type FRBC.Instruction\nDDBC.SystemDescription: Object type DDBC.SystemDescription\nDDBC.Instruction: Object type DDBC.Instruction",
"enum": [
"PEBC.PowerConstraints",
"PEBC.EnergyConstraint",
"PEBC.Instruction",
"PPBC.PowerProfileDefinition",
"PPBC.ScheduleInstruction",
"PPBC.StartInterruptionInstruction",
"PPBC.EndInterruptionInstruction",
"OMBC.SystemDescription",
"OMBC.Instruction",
"FRBC.SystemDescription",
"FRBC.Instruction",
"DDBC.SystemDescription",
"DDBC.Instruction"
],
"title": "RevokableObjects"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b41a8ced359056a53175ca84d0b7696b368e3afd | 2022-10-13T08:29:57 | s2-json-schema/messages/PEBC.PowerConstraints.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/PEBC.PowerConstraints.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"allowed_limit_ranges": {
"description": "The actual constraints. There shall be at least one PEBC.AllowedLimitRange for the UPPER_LIMIT and at least one AllowedLimitRange for the LOWER_LIMIT. It is allowed to have multiple PEBC.AllowedLimitRange objects with identical CommodityQuantities and LimitTypes.",
"items": {
"$ref": "../schemas/PEBC.AllowedLimitRange.schema.json"
},
"maxItems": 100,
"minItems": 2,
"type": "array"
},
"consequence_type": {
"$ref": "../schemas/PEBC.PowerEnvelopeConsequenceType.schema.json",
"description": "Type of consequence of limiting power"
},
"id": {
"$ref": "../schemas/ID.schema.json",
"description": "Identifier of this PEBC.PowerConstraints. Must be unique in the scope of the Resource Manager, for at least the duration of the session between Resource Manager and CEM."
},
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "PEBC.PowerConstraints",
"type": "string"
},
"valid_from": {
"description": "Moment this PEBC.PowerConstraints start to be valid",
"format": "date-time",
"type": "string"
},
"valid_until": {
"description": "Moment until this PEBC.PowerConstraints is valid. If valid_until is not present, there is no determined end time of this PEBC.PowerConstraints.",
"format": "date-time",
"type": "string"
}
},
"required": [
"message_type",
"message_id",
"id",
"valid_from",
"consequence_type",
"allowed_limit_ranges"
],
"title": "PEBC_PowerConstraints"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/schemas/PPBC.PowerSequenceContainer.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/PPBC.PowerSequenceContainer.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of the PPBC.PowerSequenceContainer. Must be unique in the scope of the PPBC.PowerProfileDefinition in which it is used."
},
"power_sequences": {
"description": "List of alternative Sequences where one could be chosen by the CEM",
"items": {
"$ref": "../schemas/PPBC.PowerSequence.schema.json"
},
"maxItems": 288,
"minItems": 1,
"type": "array"
}
},
"required": [
"id",
"power_sequences"
],
"title": "PPBC_PowerSequenceContainer"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 5ab1232df3cdb0cd619fe97fafaa269323a9d6ac | 2023-03-07T14:10:37 | s2-json-schema/schemas/ID.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/ID.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "An identifier exapressed as a UUID",
"pattern": "[a-zA-Z0-9\\-_:]{2,64}",
"title": "ID",
"type": "string"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/schemas/SessionRequestType.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/SessionRequestType.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "RECONNECT: Please reconnect the WebSocket session. Once reconnected, it starts from scratch with a handshake.\nTERMINATE: Disconnect the session (client can try to reconnecting with exponential backoff)",
"enum": [
"RECONNECT",
"TERMINATE"
],
"title": "SessionRequestType"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | 116f0c987110733bd7d35e95715cc53916958c53 | 2022-10-10T10:14:42 | s2-json-schema/messages/RevokeObject.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/messages/RevokeObject.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"message_id": {
"$ref": "../schemas/ID.schema.json",
"description": "ID of this message"
},
"message_type": {
"const": "RevokeObject",
"type": "string"
},
"object_id": {
"$ref": "../schemas/ID.schema.json",
"description": "The ID of object that needs to be revoked"
},
"object_type": {
"$ref": "../schemas/RevokableObjects.schema.json",
"description": "The type of object that needs to be revoked"
}
},
"required": [
"message_type",
"message_id",
"object_type",
"object_id"
],
"title": "RevokeObject"
} | Apache-2.0 | en |
flexiblepower/s2-ws-json | b41a8ced359056a53175ca84d0b7696b368e3afd | 2022-10-13T08:29:57 | s2-json-schema/schemas/FRBC.LeakageBehaviourElement.schema.json | 13 | 2024-05-27T07:07:30.948369Z | {
"$id": "https://raw.githubusercontent.com/flexiblepower/s2-ws-json/main/s2-json-schema/schemas/FRBC.LeakageBehaviourElement.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"fill_level_range": {
"$ref": "../schemas/NumberRange.schema.json",
"description": "The fill level range for which this FRBC.LeakageBehaviourElement applies. The start of the range must be less than the end of the range."
},
"leakage_rate": {
"description": "Indicates how fast the momentary fill level will decrease per second due to leakage within the given range of the fill level.",
"type": "number"
}
},
"required": [
"fill_level_range",
"leakage_rate"
],
"title": "FRBC_LeakageBehaviourElement"
} | Apache-2.0 | en |
Subsets and Splits