diff --git a/framework/json/requests/filteringTerms.json b/framework/json/requests/filteringTerms.json index f61c867f7..3c0550f7f 100644 --- a/framework/json/requests/filteringTerms.json +++ b/framework/json/requests/filteringTerms.json @@ -5,11 +5,11 @@ "AlphanumericFilter": { "description": "Filter results based on operators and values applied to alphanumeric fields.", "properties": { - "id": { - "description": "Field identfier to be queried.", - "example": "ageOfOnset", - "type": "string" - }, + "id": { + "description": "Field identfier to be queried.", + "example": "ageOfOnset", + "type": "string" + }, "operator": { "default": "=", "description": "Defines how the value relates to the field `id`.", @@ -50,11 +50,11 @@ "example": "demographic.ethnicity:asian", "type": "string" }, - "scope": { - "description": "The entry type to which the filter applies", - "example": "individuals", - "type": "string" - } + "scope": { + "description": "The entry type to which the filter applies", + "example": "individuals", + "type": "string" + } }, "required": [ "id" diff --git a/framework/src/requests/filteringTerms.yaml b/framework/src/requests/filteringTerms.yaml index 66bae1332..23b7cddd0 100644 --- a/framework/src/requests/filteringTerms.yaml +++ b/framework/src/requests/filteringTerms.yaml @@ -59,7 +59,7 @@ definitions: id: type: string description: Field identfier to be queried. - example: age + example: ageOfOnset operator: type: string enum: @@ -74,14 +74,15 @@ definitions: example: '>' value: type: string - description: Alphanumeric search term to be used within the query which can + 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 scope: type: string description: The entry type to which the filter applies - example: biosamples + example: individuals CustomFilter: type: object description: Filter results to include records that contain a custom term defined @@ -96,5 +97,5 @@ definitions: scope: type: string description: The entry type to which the filter applies - example: biosamples + example: individuals additionalProperties: true