aboutsummaryrefslogtreecommitdiffstats
path: root/apps/weather_status/lib/ResponseDefinitions.php
blob: 17d7cebf76e88728e8cb00d14dd8ce374d7e3363 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCA\WeatherStatus;

/**
 * https://api.met.no/doc/ForecastJSON compact format according to https://docs.api.met.no/doc/locationforecast/datamodel
 * @psalm-type WeatherStatusForecast = array{
 *     time: string,
 *     data: array{
 *         instant: array{
 *             details: array{
 *                 air_pressure_at_sea_level: numeric,
 *                 air_temperature: numeric,
 *                 cloud_area_fraction: numeric,
 *                 relative_humidity: numeric,
 *                 wind_from_direction: numeric,
 *                 wind_speed: numeric,
 *             },
 *         },
 *         next_12_hours: array{
 *             summary: array{
 *                 symbol_code: string,
 *             },
 *             details: array{
 *                 precipitation_amount?: numeric,
 *             },
 *         },
 *         next_1_hours: array{
 *             summary: array{
 *                 symbol_code: string,
 *             },
 *             details: array{
 *                 precipitation_amount?: numeric,
 *             },
 *         },
 *         next_6_hours: array{
 *             summary: array{
 *                 symbol_code: string,
 *             },
 *             details: array{
 *                 precipitation_amount?: numeric,
 *             },
 *         },
 *     },
 * }
 *
 * @psalm-type WeatherStatusSuccess = array{
 *     success: bool,
 * }
 *
 * @psalm-type WeatherStatusMode = array{
 *     mode: int,
 * }
 * @psalm-type WeatherStatusLocation = array{
 *     lat?: string,
 *     lon?: string,
 *     address?: ?string,
 * }
 *
 * @psalm-type WeatherStatusLocationWithSuccess = WeatherStatusLocation&WeatherStatusSuccess
 *
 * @psalm-type WeatherStatusLocationWithMode = WeatherStatusLocation&WeatherStatusMode
 */
class ResponseDefinitions {
}