.. sectionauthor:: Kristen OShea <kristen.oshea at dri.edu>

Metadata
========

| The Metadata endpoints are used to return metadata for the datasets available in Climate Engine.


| :ref:`RST /metadata/dataset_dates`
| :ref:`RST /metadata/dataset_variables`
| :ref:`RST /metadata/county_names`

.. _RST /metadata/dataset_dates:

/metadata/dataset_dates
***********************
| Returns dataset start and end/most recent date.
| Returns: json

Resource url example:

.. code-block::

    /metadata/dataset_dates?dataset=GRIDMET

.. list-table:: 
   :widths: 25 5 25 25 25
   :header-rows: 1

   * - NAME
     - REQUIRED
     - DESCRIPTION
     - DEFAULT
     - EXAMPLE
   * - dataset
     - yes
     - The dataset you want the dates for
     - GRIDMET
     - LANDSAT7_TOA
   * - export_format
     - no
     - File format of export
     - json
     - csv, json


.. _RST /metadata/dataset_variables:

/metadata/dataset_variables
***************************
| Returns list of input dataset's variables.
| Returns: json

Resource url example:

.. code-block::

    /metadata/dataset_variables?dataset=GRIDMET

.. list-table::
   :widths: 25 5 25 25 25
   :header-rows: 1

   * - NAME
     - REQUIRED
     - DESCRIPTION
     - DEFAULT
     - EXAMPLE
   * - dataset
     - yes
     - The dataset you want the variables for
     - GRIDMET
     - LANDSAT_SR
   * - export_format
     - no
     - File format of export
     - json
     - csv, json
   

.. _RST /metadata/county_names:

/metadata/county_names
**********************
| Returns list of input state's counties.
| Returns: json

Resource url example:

.. code-block::

    /metadata/county_names?state=OR

.. list-table:: 
   :widths: 25 5 25 25 25
   :header-rows: 1

   * - NAME
     - REQUIRED
     - DESCRIPTION
     - DEFAULT
     - EXAMPLE
   * - state
     - yes
     - The state you want the county names for
     - OR
     - PA
   * - export_format
     - no
     - File format of export
     - json
     - csv, json