Skip to content

Commit

Permalink
Merge pull request #475 from opengeospatial/Refactor-DataQuery-defini…
Browse files Browse the repository at this point in the history
…tions

Refactor DataQuery definitions
  • Loading branch information
chris-little authored Nov 23, 2023
2 parents c9fd005 + 0d3e474 commit baada5d
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 206 deletions.
36 changes: 36 additions & 0 deletions core/standard/openapi/schemas/collections/DataQuery.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
description: Property to contain any extra metadata information that is specific
to an individual data query
type: object
required:
- title
- description
- output_formats
- default_output_format
- crs_details
properties:
title:
description: title of the query
type: string
example: Position query
description:
description: description of the query
type: string
example: Query to return data for a defined well known text point
output_formats:
description: list of output formats supported by the Position query
type: array
items:
type: string
example:
- CoverageJSON
- GeoJSON
- IWXXM
- GRIB
default_output_format:
description: default output format for the Position query
type: string
crs_details:
description: List of key/value definitions for the CRS's supported by the Position query. The key is the query parameter and the value is the Well Known Text description
type: array
items:
$ref: crsObject.yaml
33 changes: 4 additions & 29 deletions core/standard/openapi/schemas/collections/areaDataQuery.yaml
Original file line number Diff line number Diff line change
@@ -1,36 +1,11 @@
description: Property to contain any extra metadata information that is specific
to an individual data queries
type: object
allOf:
- $ref: DataQuery.yaml
required:
- query_type
properties:
title:
description: title of the query
type: string
example: Area query
description:
description: description of the query
type: string
example: Query to return data for a defined area
query_type:
description: Type of EDR query
type: string
enum:
- area
example: area
output_formats:
description: list of output formats supported by the Area query
type: array
items:
type: string
example:
- CoverageJSON
- GeoJSON
- IWXXM
- GRIB
default_output_format:
description: default output format for the Area query
type: string
crs_details:
description: List of key/value definitions for the CRS's supported by the Area query. The key is the query parameter and the value is the Well Known Text description
type: array
items:
$ref: crsObject.yaml
33 changes: 4 additions & 29 deletions core/standard/openapi/schemas/collections/corridorDataQuery.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,8 @@
description: Property to contain any extra metadata information that is specific
to an individual data queries
type: object
allOf:
- $ref: DataQuery.yaml
required:
- query_type
properties:
title:
description: title of the query
type: string
example: Corridor query
description:
description: description of the query
type: string
example: Query to return data for a defined corridor
query_type:
description: Type of EDR query
type: string
Expand All @@ -32,21 +25,3 @@ properties:
example:
- m
- hPa
output_formats:
description: list of output formats the supported by the Corridor query
type: array
items:
type: string
example:
- CoverageJSON
- GeoJSON
- IWXXM
- GRIB
default_output_format:
description: default output format for the Corridor query
type: string
crs_details:
description: List of key/value definitions for the CRS's supported by the Corridor query. The key is the query parameter and the value is the Well Known Text description
type: array
items:
$ref: crsObject.yaml
39 changes: 7 additions & 32 deletions core/standard/openapi/schemas/collections/cubeDataQuery.yaml
Original file line number Diff line number Diff line change
@@ -1,44 +1,19 @@
description: Property to contain any extra metadata information that is specific
to an individual data queries
type: object
allOf:
- $ref: DataQuery.yaml
required:
- query_type
properties:
title:
description: title of the query
type: string
example: Cube query
description:
description: description of the query
type: string
example: Query to return data for a defined well known text point
query_type:
description: Type of EDR query
type: string
enum:
- cube
example: cube
example: cube
height_units:
description: list of height distance units distance values can be specified in
description: list of z distance units vertical values can be specified in
type: array
items:
type: string
example:
- m
- hPa
output_formats:
description: list of output formats supported by the Cube query
type: array
items:
type: string
example:
- CoverageJSON
- GeoJSON
- IWXXM
- GRIB
default_output_format:
description: default output format of the Cube query
type: string
crs_details:
description: List of key/value definitions for the CRS's supported by the Cube query. The key is the query parameter and the value is the Well Known Text description
type: array
items:
$ref: crsObject.yaml
- hPa
33 changes: 4 additions & 29 deletions core/standard/openapi/schemas/collections/locationsDataQuery.yaml
Original file line number Diff line number Diff line change
@@ -1,36 +1,11 @@
description: Property to contain any extra metadata information that is specific
to an individual data queries
type: object
allOf:
- $ref: DataQuery.yaml
required:
- query_type
properties:
title:
description: title of the query
type: string
example: Locations query
description:
description: description of the query
type: string
example: Query to return data for a defined well known text point
query_type:
description: Type of EDR query
type: string
enum:
- locations
example: locations
output_formats:
description: list of output formats supported by the Locations query
type: array
items:
type: string
example:
- CoverageJSON
- GeoJSON
- IWXXM
- GRIB
default_output_format:
description: default output format of the Locations query
type: string
crs_details:
description: List of key/value definitions for the CRS's supported by the Locations query. The key is the query parameter and the value is the Well Known Text description
type: array
items:
$ref: crsObject.yaml
33 changes: 4 additions & 29 deletions core/standard/openapi/schemas/collections/positionDataQuery.yaml
Original file line number Diff line number Diff line change
@@ -1,36 +1,11 @@
description: Property to contain any extra metadata information that is specific
to an individual data queries
type: object
allOf:
- $ref: DataQuery.yaml
required:
- query_type
properties:
title:
description: title of the query
type: string
example: Position query
description:
description: description of the query
type: string
example: Query to return data for a defined well known text point
query_type:
description: Type of EDR query
type: string
enum:
- position
example: position
output_formats:
description: list of output formats supported by the Position query
type: array
items:
type: string
example:
- CoverageJSON
- GeoJSON
- IWXXM
- GRIB
default_output_format:
description: default output format for the Position query
type: string
crs_details:
description: List of key/value definitions for the CRS's supported by the Position query. The key is the query parameter and the value is the Well Known Text description
type: array
items:
$ref: crsObject.yaml
31 changes: 2 additions & 29 deletions core/standard/openapi/schemas/collections/radiusDataQuery.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
description: Property to contain any extra metadata information that is specific
to an individual data queries
type: object
allOf:
- $ref: DataQuery.yaml
properties:
title:
description: title of the query
type: string
example: Radius query
description:
description: description of the query
type: string
example: Query to return data for a defined well known text point
query_type:
description: Type of EDR query
type: string
Expand All @@ -24,21 +15,3 @@ properties:
example:
- km
- miles
output_formats:
description: list of formats supported by the Radius query
type: array
items:
type: string
example:
- CoverageJSON
- GeoJSON
- IWXXM
- GRIB
default_output_format:
description: default outputformat for the Radius query
type: string
crs_details:
description: List of key/value definitions for the CRS's supported by the Radius query. The key is the query parameter and the value is the Well Known Text description
type: array
items:
$ref: crsObject.yaml
31 changes: 2 additions & 29 deletions core/standard/openapi/schemas/collections/trajectoryDataQuery.yaml
Original file line number Diff line number Diff line change
@@ -1,36 +1,9 @@
description: Property to contain any extra metadata information that is specific
to an individual data queries
type: object
allOf:
- $ref: DataQuery.yaml
properties:
title:
description: title of the query
type: string
example: Trajectory query
description:
description: description of the query
type: string
example: Query to return data for a defined well known text point
query_type:
description: Type of EDR query
type: string
enum:
- trajectory
example: trajectory
output_formats:
description: list of ouputformats supported by the Trajectory query
type: array
items:
type: string
example:
- CoverageJSON
- GeoJSON
- IWXXM
- GRIB
default_output_format:
description: default outputformat for the Trajectory query
type: string
crs_details:
description: List of key/value definitions for the CRS's supported by a Trajectory query. The key is the query parameter and the value is the Well Known Text description
type: array
items:
$ref: crsObject.yaml

0 comments on commit baada5d

Please sign in to comment.