Support for APIs

[KathiSchleidt]

In the metadata form, we have a field for a link to an API. While this works well when the API has a clear endpoint where the rest of the API information is available, it breaks down when the API is provided in the form of a library such as under ERA5_monthly_averaged_data

How can we provide information to an API provided as a library. Example from ERA5_monthly_averaged_data:

import cdsapi c = cdsapi.Client() c.retrieve( 'reanalysis-era5-single-levels-monthly-means', { 'product_type': 'monthly_averaged_reanalysis', 'variable': [ '2m_dewpoint_temperature', '2m_temperature', 'ice_temperature_layer_1', 'ice_temperature_layer_2', 'ice_temperature_layer_3', 'ice_temperature_layer_4', 'mean_sea_level_pressure', 'sea_surface_temperature', 'skin_temperature', 'surface_pressure', ], 'year': [ '1940', '1941', '1942', '1943', '1944', '1945', '1946', '1947', '1948', '1949', '1950', '1951', '1952', '1953', '1954', '1955', '1956', '1957', '1958', '1959', '1960', '1961', '1962', '1963', '1964', '1965', '1966', '1967', '1968', '1969', '1970', '1971', '1972', '1973', '1974', '1975', '1976', '1977', '1978', '1979', '1980', '1981', '1982', '1983', '1984', '1985', '1986', '1987', '1988', '1989', '1990', '1991', '1992', '1993', '1994', '1995', '1996', '1997', '1998', '1999', '2000', '2001', '2002', '2003', '2004', '2005', '2006', '2007', '2008', '2009', '2010', '2011', '2012', '2013', '2014', '2015', '2016', '2017', '2018', '2019', '2020', '2021', '2022', '2023', '2024', ], 'month': [ '01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12', ], 'time': '00:00', 'format': 'netcdf', }, 'download.nc')

[KathiSchleidt]

Still waiting

[KathiSchleidt]

@baloola will investigate, propose options for providing such code snippets for API access

[KathiSchleidt]

Consider putting the documentation of the API code in RTD, then provide a link

[KathiSchleidt]

Add the simple example:

import cdsapi c = cdsapi.Client() c.retrieve( 'reanalysis-era5-single-levels-monthly-means', { 'format': 'netcdf', 'product_type': 'monthly_averaged_reanalysis', 'variable': '2m_temperature', 'year': '2023', 'month': '01', 'time': '00:00', }, 'download.nc')

[KathiSchleidt]

Use IANA describes for the link

[KathiSchleidt]

Follow Sentinel-Hub approach shown, use processing instruction code. Provides link to script existing in GitHub repo