{ "openapi": "3.0.1", "info": { "title": "Harmony API conforming to OGC API - Coverages", "description": "Harmony API for requesting coverages for a range of NASA EOSDIS data using thc OGC API - Coverages", "version": "1.0.0" }, "servers": [ { "url": "/{cmrCollectionId}/ogc-api-coverages/1.0.0", "description": "Harmony server", "variables": { "cmrCollectionId": { "default": "no-default-cmr-collection", "description": "The CMR Collection ID for the dataset whose coverage is being accessed" } } } ], "tags": [ { "name": "Capabilities", "description": "Essential characteristics of this API including information about the data." }, { "name": "Coverage", "description": "Access to data (coverage)." } ], "paths": { "/": { "get": { "tags": [ "Capabilities" ], "summary": "landing page of this API", "description": "The landing page provides links to the API definition, the Conformance statements and the metadata about the coverage data in this dataset.", "operationId": "getLandingPage", "responses": { "200": { "description": "links to the API capabilities", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/root" } } } }, "default": { "$ref": "#/components/responses/default" } } } }, "/api": { "get": { "tags": [ "OpenAPI" ], "summary": "this OpenAPI Schema", "description": "Returns the OpenAPI Schema for this coverage endpoint", "operationId": "getSpecification", "responses": { "200": { "description": "this OpenAPI Schema", "content": { "text/openapi+yaml;version=3.0": { "schema": { "type": "string" } } } }, "default": { "$ref": "#/components/responses/default" } } } }, "/conformance": { "get": { "tags": [ "Capabilities" ], "summary": "information about standards that this API conforms to", "description": "list all requirements classes specified in a standard that the server conforms to", "operationId": "getRequirementsClasses", "responses": { "200": { "description": "the URIs of all requirements classes supported by the server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/req-classes" } } } }, "default": { "$ref": "#/components/responses/default" } } } }, "/collections": { "get": { "tags": [ "Capabilities" ], "summary": "Describe the collections in the dataset", "operationId": "describeCollections", "parameters": [ { "name": "limit", "in": "query", "description": "Not yet implemented", "required": false, "style": "form", "explode": false, "schema": { "maximum": 10000, "minimum": 1, "type": "integer", "default": 10 } }, { "name": "bbox", "in": "query", "description": "Not yet implemented", "required": false, "style": "form", "explode": false, "schema": { "maxItems": 6, "minItems": 4, "type": "array", "items": { "type": "number" } } }, { "name": "time", "in": "query", "description": "Not yet implemented", "required": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "f", "in": "query", "description": "The optional f parameter indicates the output format which the server shall provide as part of the response document. It has preference over the HTTP Accept header. The default format is JSON.\n", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "default": "json", "enum": [ "json", "html" ] } } ], "responses": { "200": { "description": "Metadata about the collections shared by this API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/content" } }, "text/html": { "schema": { "type": "string" } } } }, "default": { "$ref": "#/components/responses/default" } } } }, "/collections/{collectionId}": { "get": { "tags": [ "Capabilities" ], "summary": "Describe the {collectionId} collection", "operationId": "describeCollection", "parameters": [ { "name": "collectionId", "in": "path", "description": "Not yet implemented", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Metadata about the {collectionId} collection shared by this API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/collectionInfo" } }, "text/html": { "schema": { "type": "string" } } } }, "default": { "$ref": "#/components/responses/default" } } } }, "/collections/{collectionId}/coverage": { "get": { "tags": [ "Coverage" ], "summary": "(Not yet implemented) description of the coverage offering identified by {collectionId} including envelope", "description": "Not yet implemented", "operationId": "getCoverageOffering", "parameters": [ { "name": "collectionId", "in": "path", "description": "Identifier (name) of a specific collection", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Information about the coverage collection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coverageOffering" } }, "text/html": { "schema": { "type": "string" } } } }, "default": { "$ref": "#/components/responses/default" } } } }, "/collections/{collectionId}/coverage/description": { "get": { "tags": [ "Coverage" ], "summary": "(Not yet implemented) returns the whole coverage description consisting of domainset, rangetype, and metadata (but not the rangeset)", "description": "Not yet implemented", "operationId": "getCoverageDescription", "parameters": [ { "name": "collectionId", "in": "path", "description": "Identifier (name) of a specific collection", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "subset", "in": "query", "description": "Not yet implemented", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A coverage description.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coverageDescription" } }, "text/html": { "schema": { "type": "string" } } } }, "default": { "$ref": "#/components/responses/default" } } } }, "/collections/{collectionId}/coverage/domainset": { "get": { "tags": [ "Coverage" ], "summary": "(Not yet implemented) retrieve a coverages domainset; use content negotiation to request HTML or GeoJSON", "description": "Not yet implemented", "operationId": "getCoverageDomainSet", "parameters": [ { "name": "collectionId", "in": "path", "description": "Identifier (name) of a specific collection", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "subset", "in": "query", "description": "Not yet implemented", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A coverages domainset.", "content": { "application/json": { "schema": { "$ref": "http://schemas.opengis.net/cis/1.1/json/coverage-schema.json#/definitions/domainSet" } }, "text/html": { "schema": { "type": "string" } } } }, "default": { "$ref": "#/components/responses/default" } } } }, "/collections/{collectionId}/coverage/rangetype": { "get": { "tags": [ "Coverage" ], "summary": "(Not yet implemented) retrieve a coverage's rangetype; use content negotiation to request HTML or GeoJSON", "description": "Not yet implemented", "operationId": "getCoverageRangeType", "parameters": [ { "$ref": "#/components/parameters/collectionId" } ], "responses": { "200": { "description": "A coverage's rangetype.", "content": { "application/geo+json": { "schema": { "$ref": "http://schemas.opengis.net/cis/1.1/json/coverage-schema.json#/definitions/rangeType" } }, "text/html": { "schema": { "type": "string" } } } }, "default": { "$ref": "#/components/responses/default" } } } }, "/collections/{collectionId}/coverage/metadata": { "get": { "tags": [ "Coverage" ], "summary": "(Not yet implemented) retrieve a coverage's metadata; use content negotiation to request HTML or GeoJSON", "description": "Not yet implemented", "operationId": "getCoverageMetadata", "parameters": [ { "$ref": "#/components/parameters/collectionId" } ], "responses": { "200": { "description": "A coverage's metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coverageMetadata" } }, "text/html": { "schema": { "type": "string" } } } }, "default": { "$ref": "#/components/responses/default" } } } }, "/collections/{collectionId}/coverage/rangeset": { "get": { "tags": [ "Coverage" ], "summary": "Retrieve a coverage's rangeset", "description": "Retrieve the coverage's rangeset, i.e. its data values in their native format", "operationId": "getCoverageRangeset", "parameters": [ { "$ref": "#/components/parameters/collectionId" }, { "$ref": "#/components/parameters/outputCrs" }, { "$ref": "#/components/parameters/subset" }, { "$ref": "#/components/parameters/interpolation" }, { "$ref": "#/components/parameters/scaleExtent" }, { "$ref": "#/components/parameters/scaleSize" }, { "$ref": "#/components/parameters/concatenate" }, { "$ref": "#/components/parameters/granuleId" }, { "$ref": "#/components/parameters/point" }, { "$ref": "#/components/parameters/width" }, { "$ref": "#/components/parameters/height" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/forceAsync" }, { "$ref": "#/components/parameters/serviceId" }, { "$ref": "#/components/parameters/maxResults" }, { "$ref": "#/components/parameters/skipPreview" }, { "$ref": "#/components/parameters/ignoreErrors" }, { "$ref": "#/components/parameters/destinationUrl" }, { "$ref": "#/components/parameters/granuleName" }, { "$ref": "#/components/parameters/grid" }, { "$ref": "#/components/parameters/extend" }, { "$ref": "#/components/parameters/variable" }, { "$ref": "#/components/parameters/average" }, { "$ref": "#/components/parameters/label" }, { "$ref": "#/components/parameters/pixelSubset" } ], "responses": { "200": { "description": "A coverage's range set.", "content": { "image/*": { "schema": { "$ref": "#/components/schemas/rangeSetImage" } }, "application/*": { "schema": { "$ref": "#/components/schemas/rangeSetImage" } } } }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "Coverage" ], "summary": "Retrieve a coverage's rangeset", "description": "Retrieve the coverage's rangeset, i.e. its data values in their native format", "operationId": "postCoverageRangeset", "parameters": [ { "$ref": "#/components/parameters/collectionId" }, { "$ref": "#/components/parameters/outputCrs" }, { "$ref": "#/components/parameters/subset" }, { "$ref": "#/components/parameters/interpolation" }, { "$ref": "#/components/parameters/scaleExtent" }, { "$ref": "#/components/parameters/scaleSize" }, { "$ref": "#/components/parameters/concatenate" }, { "$ref": "#/components/parameters/granuleId" }, { "$ref": "#/components/parameters/point" }, { "$ref": "#/components/parameters/width" }, { "$ref": "#/components/parameters/height" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/forceAsync" }, { "$ref": "#/components/parameters/serviceId" }, { "$ref": "#/components/parameters/maxResults" }, { "$ref": "#/components/parameters/skipPreview" }, { "$ref": "#/components/parameters/ignoreErrors" }, { "$ref": "#/components/parameters/destinationUrl" }, { "$ref": "#/components/parameters/granuleName" }, { "$ref": "#/components/parameters/grid" }, { "$ref": "#/components/parameters/extend" }, { "$ref": "#/components/parameters/variable" }, { "$ref": "#/components/parameters/average" }, { "$ref": "#/components/parameters/label" }, { "$ref": "#/components/parameters/pixelSubset" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "shapefile": { "type": "string", "format": "binary" } } }, "encoding": { "shapefile": { "contentType": "application/geo+json,application/shapefile+zip,application/vnd.google-earth.kml+xml" } } } } }, "responses": { "200": { "description": "A coverage's range set.", "content": { "image/*": { "schema": { "$ref": "#/components/schemas/rangeSetImage" } }, "application/*": { "schema": { "$ref": "#/components/schemas/rangeSetImage" } } } }, "default": { "$ref": "#/components/responses/default" } } } }, "/collections/{collectionId}/coverage/all": { "get": { "tags": [ "Coverage" ], "summary": "(Not yet implemented) retrieve a coverages rangeset; use content negotiation to request HTML or GeoJSON", "description": "Not yet implemented", "operationId": "getCoverageAll", "parameters": [ { "$ref": "#/components/parameters/collectionId" }, { "$ref": "#/components/parameters/subset" }, { "$ref": "#/components/parameters/rangeSubset" }, { "$ref": "#/components/parameters/scaleFactor" }, { "$ref": "#/components/parameters/scaleAxis" }, { "$ref": "#/components/parameters/scaleSize" }, { "$ref": "#/components/parameters/scaleExtent" }, { "$ref": "#/components/parameters/subsettingCrs" }, { "$ref": "#/components/parameters/outputCrs" }, { "$ref": "#/components/parameters/interpolation" } ], "responses": { "200": { "description": "A full coverage.", "content": { "application/multipart+related": { "schema": { "$ref": "#/components/schemas/coverageMultipart" } }, "image/*": { "schema": { "$ref": "#/components/schemas/rangeSetImage" } }, "application/*": { "schema": { "$ref": "#/components/schemas/rangeSetImage" } }, "text/html": { "schema": { "type": "string" } } } }, "default": { "$ref": "#/components/responses/default" } } } } }, "components": { "responses": { "default": { "description": "An error occured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exception" } }, "text/html": { "schema": { "type": "string" } } } } }, "schemas": { "exception": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } } }, "root": { "required": [ "links" ], "type": "object", "properties": { "links": { "type": "array", "example": [ { "href": "http://data.example.org/", "rel": "self", "type": "application/json", "title": "this document" }, { "href": "http://data.example.org/api", "rel": "service", "type": "application/openapi+json;version=3.0", "title": "the API definition" }, { "href": "http://data.example.org/conformance", "rel": "conformance", "type": "application/json", "title": "OGC conformance classes implemented by this API" }, { "href": "http://data.example.org/collections", "title": "Metadata about the resource collections" } ], "items": { "$ref": "#/components/schemas/link" } } } }, "req-classes": { "required": [ "conformsTo" ], "type": "object", "properties": { "conformsTo": { "type": "array", "example": [ "http://www.opengis.net/spec/ogcapi-common/1.0/conf/core", "http://www.opengis.net/spec/ogcapi-common/1.0/conf/collections", "http://www.opengis.net/spec/ogcapi-common/1.0/conf/oas3", "http://www.opengis.net/spec/ogcapi-common/1.0/conf/html", "http://www.opengis.net/spec/ogcapi-common/1.0/conf/geojson", "http://www.opengis.net/spec/ogcapi-coverages/1.0/conf/core" ], "items": { "type": "string" } } } }, "link": { "required": [ "href" ], "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string", "example": "prev" }, "type": { "type": "string", "example": "application/geo+json" }, "hreflang": { "type": "string", "example": "en" } } }, "content": { "required": [ "collections", "links" ], "type": "object", "properties": { "links": { "type": "array", "example": [ { "href": "http://data.example.org/collections.json", "rel": "self", "type": "application/json", "title": "this document" }, { "href": "http://data.example.org/collections.html", "rel": "alternate", "type": "text/html", "title": "this document as HTML" }, { "href": "http://schemas.example.org/1.0/foobar.xsd", "rel": "describedBy", "type": "application/xml", "title": "XML schema for Acme Corporation data" } ], "items": { "$ref": "#/components/schemas/link" } }, "collections": { "type": "array", "items": { "$ref": "#/components/schemas/collectionInfo" } } } }, "collectionInfo": { "required": [ "links", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "identifier of the collection used, for example, in URIs", "example": "buildings" }, "title": { "type": "string", "description": "human readable title of the collection", "example": "Buildings" }, "description": { "type": "string", "description": "a description of the data in the collection", "example": "Buildings in the city of Bonn." }, "links": { "type": "array", "example": [ { "href": "http://data.example.org/collections/buildings/items", "rel": "item", "type": "application/geo+json", "title": "Buildings" }, { "href": "http://example.org/concepts/building.html", "rel": "describedBy", "type": "text/html", "title": "Coverage for buildings" } ], "items": { "$ref": "#/components/schemas/link" } }, "extent": { "$ref": "#/components/schemas/extent" }, "crs": { "type": "array", "description": "The coordinate reference systems in which geometries may be retrieved. Coordinate reference systems are identified by a URI. The first coordinate reference system is the coordinate reference system that is used by default. This is always \"http://www.opengis.net/def/crs/OGC/1.3/CRS84\", i.e. WGS84 longitude/latitude.", "items": { "type": "string" }, "default": [ "http://www.opengis.net/def/crs/OGC/1.3/CRS84" ] } } }, "extent": { "type": "object", "properties": { "crs": { "type": "string", "description": "Coordinate reference system of the coordinates in the spatial extent (property `spatial`). In the Core, only WGS84 longitude/latitude is supported. Extensions may support additional coordinate reference systems.", "default": "http://www.opengis.net/def/crs/OGC/1.3/CRS84", "enum": [ "http://www.opengis.net/def/crs/OGC/1.3/CRS84" ] }, "spatial": { "maxItems": 6, "minItems": 4, "type": "array", "description": "West, north, east, south edges of the spatial extent. The minimum and maximum values apply to the coordinate reference system WGS84 longitude/latitude that is supported in the Core. If, for example, a projected coordinate reference system is used, the minimum and maximum values need to be adjusted.", "example": [ -180, -90, 180, 90 ], "items": { "type": "number" } }, "trs": { "type": "string", "description": "Temporal reference system of the coordinates in the temporal extent (property `temporal`). In the Core, only the Gregorian calendar is supported. Extensions may support additional temporal reference systems.", "default": "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian", "enum": [ "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian" ] }, "temporal": { "maxItems": 2, "minItems": 2, "type": "array", "description": "Begin and end times of the temporal extent.", "example": [ "2011-11-11T12:22:11.000Z", "2012-11-24T12:32:43.000Z" ], "items": { "type": "string", "format": "dateTime" } } } }, "coverageOffering": { "type": "string" }, "coverageDescription": { "type": "string" }, "coverageMetadata": { "type": "string" }, "coverageMultipart": { "type": "string" }, "rangeSetImage": { "type": "string" } }, "parameters": { "limit": { "name": "limit", "in": "query", "description": "The optional limit parameter limits the number of items that are\npresented in the response document.\n\nOnly items are counted that are on the first level of the collection in\nthe response document. Nested objects contained within the explicitly\nrequested items shall not be counted.\n\n* Minimum = 1\n* Maximum = 10000\n* Default = 10\n", "required": false, "style": "form", "explode": false, "schema": { "maximum": 10000, "minimum": 1, "type": "integer", "default": 10 } }, "bbox": { "name": "bbox", "in": "query", "description": "Only collections that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (elevation or depth):\n* Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Lower left corner, coordinate axis 3 (optional) * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 * Upper right corner, coordinate axis 3 (optional)\nThe coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter `bbox-crs`.\nFor WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).\nIf a collection has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.\n", "required": false, "style": "form", "explode": false, "schema": { "maxItems": 6, "minItems": 4, "type": "array", "items": { "type": "number" } } }, "point": { "name": "point", "in": "query", "description": "Only collections that have a geometry that contains a spatial point are selected. The spatial point is provided as two numbers:\n* Longitude, coordinate axis 1 * Latitude, coordinate axis 2\nThe coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84).\n", "required": false, "style": "form", "explode": false, "schema": { "maxItems": 2, "minItems": 2, "type": "array", "items": { "type": "number" } } }, "time": { "name": "time", "in": "query", "description": "Either a date-time or a period string that adheres to RFC 3339. Examples:\n* A date-time: \"2018-02-12T23:20:50Z\" * A period: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\" or \"2018-02-12T00:00:00Z/P1M6DT12H31M12S\"\nOnly collections that have a temporal property that intersects the value of `time` are selected.\nIf a collection has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.", "required": false, "style": "form", "explode": false, "schema": { "type": "string" } }, "collectionId": { "name": "collectionId", "in": "path", "description": "Names or concept ids of the UMM-Var variables to be retrieved, or \"all\" to retrieve all variables within the CMR collection(s).\nMultiple variables may be retrieved by separating them with a comma. This API interprets OGC \"collections\" to be\nequivalent to CMR \"variables\" which produces some overloading in the name. In this document, a \"collection\" is\na CMR / UMM-Var variable and a \"CMR collection\" is a CMR / UMM-C collection.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, "granuleId": { "name": "granuleId", "in": "query", "description": "The CMR Granule ID for the granule which should be retrieved", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "subset": { "name": "subset", "in": "query", "description": " get a subset of the coverage by slicing or trimming among one axis. Harmony supports the axes \"lat\" and \"lon\" for spatial subsetting, and \"time\" for temporal, regardless of the names of those axes in the data files. Harmony also supports arbitrary dimension names for subsetting on numeric ranges for that dimension.\nExamples: - Subset to the lat/lon bounding box with southwest corner (-10, -10) and northeast corner (10, 10) subset=lat(-10:10)&subset=lon(-10:10) - Subset to all latitudes north of -10 degrees and all longitudes west of 10 degrees subset=lat(-10:*)&subset=lon(*:10) - Subset to only points with latitudes from -10 to 10 degrees, disregarding longitude subset=lat(-10:10) - Subset to the first month of 2020 subset=time(\"2020-01-01T00:00:00Z\":\"2020-02-01T00:00:00Z\") - Subset on arbitrary dimension \"vertical\" with a value between 0 and 20 subset=vertical(0:20)\nFor full syntax and examples, see https://github.com/opengeospatial/ogc_api_coverages/blob/master/standard/clause_9_subset.adoc", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, "rangeSubset": { "name": "rangeSubset", "in": "query", "description": "subset the resulting coverage by choosing and/or rearrange particular fields", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "scaleFactor": { "name": "scaleFactor", "in": "query", "description": "scale the resulting coverage either among all axes by a given factor", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "scaleAxis": { "name": "scaleAxis", "in": "query", "description": "scale the resulting coverage either among one axis by a given factor", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "scaleSize": { "name": "scaleSize", "in": "query", "description": "scale the resulting coverage either among one axis to a given size", "required": false, "style": "form", "explode": false, "schema": { "minItems": 2, "maxItems": 2, "type": "array", "items": { "type": "number", "minimum": 0 } } }, "scaleExtent": { "name": "scaleExtent", "in": "query", "description": "scale the resulting coverage either among one axis to a given extent", "required": false, "style": "form", "explode": false, "schema": { "minItems": 4, "maxItems": 4, "type": "array", "items": { "type": "number" } } }, "subsettingCrs": { "name": "subsettingcrs", "in": "query", "description": "specify the projection in which the subsets are expressed", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "outputCrs": { "name": "outputcrs", "in": "query", "description": "reproject the output coverage to the given CRS. Recognizes CRS types that can be inferred by gdal, including EPSG codes, Proj4 strings, and OGC URLs (http://www.opengis.net/def/crs/...)", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "interpolation": { "name": "interpolation", "in": "query", "description": "specify the interpolation method used during reprojection and scaling", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "width": { "name": "width", "in": "query", "description": "number of columns to return in the output coverage", "required": false, "schema": { "type": "integer", "minimum": 1 } }, "height": { "name": "height", "in": "query", "description": "number of rows to return in the output coverage", "required": false, "schema": { "type": "integer", "minimum": 1 } }, "format": { "name": "format", "in": "query", "description": "the output mime type to return", "required": false, "schema": { "type": "string", "example": [ "application/x-zarr", "image/tiff", "image/png" ] } }, "forceAsync": { "name": "forceAsync", "in": "query", "description": "if \"true\", override the default API behavior and always treat the request as asynchronous", "required": false, "schema": { "type": "string" } }, "serviceId": { "name": "serviceId", "in": "query", "description": "Either the CMR concept ID or the name in services.yml for the UMM-S service chain to invoke. Useful for testing a service chain against a collection not yet configured for use with that service chain.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "maxResults": { "name": "maxResults", "in": "query", "description": "limits the number of input granules processed in the request", "required": false, "schema": { "type": "integer", "minimum": 1 } }, "concatenate": { "name": "concatenate", "in": "query", "description": "requests results to be concatenated into a single result", "required": false, "schema": { "type": "string" } }, "skipPreview": { "name": "skipPreview", "in": "query", "description": "if \"true\", override the default API behavior and never auto-pause jobs", "required": false, "schema": { "type": "string" } }, "ignoreErrors": { "name": "ignoreErrors", "in": "query", "description": "if \"true\", continue processing a request to completion even if some items fail. If \"false\",\nimmediately fail the request on the first failure. Defaults to true.\n", "required": false, "schema": { "type": "string" } }, "destinationUrl": { "name": "destinationUrl", "in": "query", "description": "destination url specified by the client, currently only s3 link url is supported\n(e.g. s3://my-bucket-name/mypath) and will result in the job being run asynchronously\n", "required": false, "schema": { "type": "string" } }, "granuleName": { "name": "granuleName", "in": "query", "description": "passed to the CMR search as the readable_granule_name parameter. Supports * and ? wildcards\nfor multiple and single character matches. Wildcards can be used any place in the name,\nbut leading wildcards are discouraged as they require a lot of resources for the underlying\nsearch.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "grid": { "name": "grid", "in": "query", "description": "the name of the output grid to use for regridding requests. The name must match the UMM\ngrid name in the CMR.\n", "required": false, "schema": { "type": "string" } }, "extend": { "name": "extend", "in": "query", "description": "the name or concept id of the variable to extend\n", "required": false, "schema": { "type": "string" } }, "variable": { "name": "variable", "in": "query", "description": "the names or concept ids of the variables to subset\n", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "average": { "name": "average", "in": "query", "description": "requests the data to be averaged over time or area\n", "required": false, "schema": { "type": "string" } }, "label": { "name": "label", "in": "query", "description": "the labels for the job\n", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "minLength": 1 } } }, "pixelSubset": { "name": "pixelSubset", "in": "query", "description": "if \"true\", pixel subset will be performed by the service", "required": false, "schema": { "type": "string" } } } } }