Historia zmian API

Ten dokument zawiera listę zmian w kolejnych wersjach API. Schemat nadawania kolejnych numerów wersji jest opisany na liście konwencji stosowanych w API.

3.14 (2019-04-10)

  • Dodano obsługę artefaktów sprawdzeń
  • Oznaczono jako "deprecated" operacje pobierania treści strony z momentu awarii oraz plików HAR (zastąpione przez artefakty)
  • Zaktualizowano Swagger UI do wersji 3.21.0

3.13 (2019-03-20)

  • Dodano możliwość edycji szablonów tematów powiadomień o zdarzeniach dla kanałów, które je wspierają
  • Dodano możliwość konfiguracji podsumowania raportów: domyślne, tylko podsumowanie lub bez podsumowania - atrybut summary raportów i ich szablonów
  • Dodano wybór sposobu obsługi nieznanych wyników sprawdzeń w zdarzeniach - atrybut unknown_check_results
  • Uporządkowano domyślną kolejność zwracanych zaawansowanych ustawień usług, aby zachowywała spójność dla różnych typów
  • Dodano możliwość powtarzania powiadomień o rozpoczęciu zdarzenia - atrybuty repeated_notifications_interval i repeated_notifications_limit eskalacji
  • Dodano operacje pobierania aktualnych statusów eskalacji
  • Dodano zmienną event_duration_message do szablonów powiadomień

3.12 (2018-11-20)

  • Zaktualizowano interaktywną dokumentację do Swagger UI w wersji 3
  • Dodano wsparcie dla eskalacji powiadomień w wersji beta
    • Zasoby events, escalations, contacts, contact_addresses, contact_suspensions, templates i default_templates
    • Słowniki error_categories, contact_channels i template_variables
    • Atrybut category_ids typów błędów
  • Dodano opis zasad działania nowego mechanizmu generowania raportów
  • Przywrócono możliwość przedefiniowania domyślnych parametrów raportu jednorazowego przy jego tworzeniu
  • Dodano możliwość pobierania podstawowych statystyk szablonów raportów
  • Zakończono fazę beta nowego mechanizmu generowania raportów
  • Zwiększono wydajność pobierania i edycji usług, przeglądania historii i danych do wykresów

3.11 (2018-09-11)

  • Dodano bardziej szczegółową informację o postępie generowania raportu - pola generating_status, generating_progress, rendering_status i rendering_progress obiektów report
  • Wyłączono możliwość wyboru pustej tablicy sekcji w szablonach raportów
  • Zaprzestano prób wysyłki zbyt dużych plików z raportami na maila - w przypadku dużego pliku zostanie przesłana jedynie informacja o możliwości pobrania raportu z Panelu Administracyjnego
  • Znacznie zwiększono wydajność generowania raportów
  • Dodano możliwość generowania wielu raportów równolegle
  • Dodano brakujące sekcje raportów PDF
  • Wprowadzono wiele poprawek wizualnych w raportach PDF
  • Jeszcze bardziej zwiększono wydajność operacji na usługach

3.10 (2018-08-08)

  • Zmiany w wersji beta nowego systemu generowania raportów (zmiany niekompatybilne wstecznie oznaczono przez [!]):
    • [!] Zmieniono nazwę harmonogramów raportów (report_schedules) na "szablony" (report_templates)
    • [!] Usunięto sekcje service_level_by_day, analyses_by_day, checks_by_day, status_changes_by_day oraz performance_by_day
    • [!] Uproszczono operację ręcznego generowania raportu: wymaga podania jedynie identyfikatora szablonu oraz przedziału czasowego
    • [!] Zastąpiono pole avg (średnia) przez sum (suma czasów odpowiedzi) i cnt (liczba sprawdzeń) w sekcjach performance
    • Dodano słownik reporting_plans (dostępne plany cyklicznego generowania raportów) oraz możliwość przypisania ich do szablonów
    • Do raportów dodano opcjonalny identyfikator planu, w ramach którego raport został wygenerowany
    • Dodano obiekt planu do raportów w formacie JSON
    • Zmieniono nazwę pliku w załączniku do wiadomości e-mail z raportem na unikalną
    • Dodano możliwość usuwania raportów będących w trakcie generowania
    • Zwiększono stabilność działania generatora raportów
  • Dodano obsługę angielskich tłumaczeń pól typów błędów
  • Poprawiono kilka problemów dotyczących e-maili z linkiem aktywacyjnym:
    • Dodano brakujące polskie znaki w treści wiadomości
    • Dodano angielskie tłumaczenie, używane w przypadku wyboru języka angielskiego w ustawieniach rejestrowanego konta
    • Dodano wsparcie dla własnych adresów linka aktywacyjnego - parametr custom_activation_uri operacji POST /accounts/register
  • Dodano wsparcie dla jednorazowych zawieszeń powiadomień - atrybut only_notifications obiektów scheduled_suspenions
  • Dodano możliwość opisywania adresów powiadomień - atrybut description obiektów notification_addresses
  • Dodano obsługę operacji tworzenia i usuwania wielu zawieszeń monitoringu lub powiadomień w pojedynczym wywołaniu API - operacje POST /scheduled_suspensions/bulk_create oraz POST /scheduled_suspensions/bulk_delete
  • Naprawiono błąd, w wyniku którego użycie hasła zawierającego znaki spoza zakresu ASCII mogło powodować błąd HTTP 500
  • Wyłączono możliwość wymuszenia analiz zatrzymanych i zawieszonych usług (takie analizy i tak nie były wykonywane)
  • Zmieniono domyślny sposób sortowania list sprawdzeń i analiz na chronologiczny
  • Poprawiono opis pola address obiektów traceroute_diagnostics

3.9.4 (2018-07-19)

  • Naprawiono obliczanie liczby archiwalnych usług w statystykach kont

3.9.3 (2018-07-16)

  • Naprawiono błąd, w wyniku którego zamiast wartości NULL opcjonalnego zaawansowanego ustawienia usługi mogła być zwracana jej wartość domyślna
  • Naprawiono błąd, w wyniku którego nie było możliwe dodawanie adresów powiadomień i raportów w grupach należących do innego użytkownika bez jawnego określenia pola owner_id

3.9.2 (2018-06-12)

  • Naprawiono błąd, w wyniku którego operacja pobierania maksymalnego przedziału czasowego dla wykresu szybkości działania (GET /services/{_id}/charts/performance/range) mogła zwracać zbyt krótki przedział
  • Naprawiono błąd, w wyniku którego nie było możliwe pobranie udostępnień grup przez dodatkowych użytkowników konta
  • Zaktualizowano odnośnik do rejestracji konta w dokumentacji

3.9.1 (2018-05-25)

  • Poprawiono stabilność mechanizmu generowania raportów
  • Usunięto kilka błędów w dokumentacji

3.9 (2018-05-24)

  • Dodano możliwość pobrania daty utworzenia konta przez jego właściciela (pole created_at obiektów user_data)
  • Dodano pole average_response_time (średnia szybkość działania w ostatniej analizie) do statusów usług
  • Zwiększono wydajność pobierania statystyk konta

3.8.1 (2018-05-08)

  • Poprawiono wydajność pobierania pojedynczych sprawdzeń i analiz (regresja w wersji 3.8)

3.8 (2018-05-08)

  • Zwiększono wydajność pobierania historii sprawdzeń i analiz, zwłaszcza sortowanych po czasie wykonania sprawdzenia lub analizy
  • Dodano pole is_enabled do obiektów stacji monitorujących oraz przywrócono nieużywane już stacje dla potrzeb przeglądania historii
  • Ulepszono algorytm obliczania postępu generowania raportów
  • Dodano wsparcie dla harmonogramu raportów
  • Poprawiono komunikat o niepoprawnym adresie IP występujący w narzędziach diagnostycznych stacji monitorujących
  • Dodano obsługę archiwum usług
  • Dodano możliwość sortowania usług po identyfikatorze i czasie ostatniej analizy
  • Dodano możliwość pobierania zmian stanów usługi, które mają niepustą część wspólną z podanym przedziałem czasowym (parametr intervals operacji GET /services/{_id}/history/status_changes)
  • Dodano nagłówek Content-Language do odpowiedzi API
  • Naprawiono sortowanie napisów zawierających polskie znaki

3.7.2 (2018-04-24)

  • Poprawiono specyfikację OpenAPI pól mogących przyjmować wartości różnych typów
  • Naprawiono działanie wyszukiwania pustych napisów

3.7.1 (2018-04-13)

  • Naprawiono obliczanie statystyk liczby udostępnionych usług dla kont dodatkowych użytkowników

3.7 (2018-02-15)

  • Dodano możliwość tworzenia usług w grupach udostępnionych (nowa flaga uprawnień can_create_services)
  • Uporządkowano autoryzację operacji na kontach:
    • zniesiono wymaganie podania aktualnego hasła dla przy zmianie hasła przez użytkownika konta głównego
    • dodano możliwość edycji kont podrzędnych przez użytkownika konta głównego
    • dodano możliwość edycji własnych kont użytkownikom read-only
    • usunięto możliwość edycji konta głównego przez dodatkowych użytkowników read-write
  • Dodano możliwość filtrowania i sortowania adresów powiadomień po nazwie grupy oraz nazwie i loginie właściciela
  • W API administracyjnym dodano możliwość zakładania kont ze wszystkimi pakietami należącymi do partnera
  • Dodano możliwość dowiązywania dostępnych kanałów powiadomień do pakietów w API administracyjnym
  • Uzupełniono brakujące ograniczenia pól w specyfikacji pakietów
  • Poprawiono błąd, w wyniku którego administratorzy mogli ustanowić konto swoim własnym rodzicem
  • Poprawiono błąd, w wyniku którego administratorzy mogli utworzyć łańcuch rodziców długości większej niż 1 poprzez przypisanie rodzica konta będącego rodzicem innego konta
  • Wyodrębniono błąd logowania "Konto nieaktywowane" (account_not_activated)
  • Doprecyzowano treść polskich komunikatów błędów dotyczących niepoprawnych przedziałów czasowych
  • Dodano możliwość wysyłania raportów PDF na wskazane adresy e-mail po ich wygenerowaniu (pole email_addresses raportów)
  • Dodano nowy typ zaawansowanego ustawienia - tablicę wzorców URL (url_patterns)
  • Poprawiono domyślny komunikat o błędzie w przypadku pustego napisu
  • Udostępniono do odczytu typy usług dostępne w pakietach kont, mogących udostępniać grupy użytkownikowi oraz kontu, którego jest dodatkowym użytkownikiem
  • Poprawiono błąd, w wyniku którego sesje użytkowników zablokowanych kont mogły nie wygasać poprawnie
  • Dodano czyszczenie udostępnień grup przy blokowaniu konta

3.6 (2018-01-04)

  • Dodano informację o postępie generowania raportów - pole progress obiektu report
  • Dodano informację o właścicielu i dacie wygenerowania do dokumentów JSON z raportami
  • Dodano nowe sekcje raportów: service_level_by_week_day, service_level_by_month_day, analyses_by_week_day, analyses_by_month_day, checks_by_week_day, checks_by_month_day, status_changes_by_hour, status_changes_by_day, status_changes_by_week_day, status_changes_by_month_day, performance_by_week_day i performance_by_month_day
  • Ograniczono do 32 dób dopuszczalną długość przedziału czasowego raportów zawierących przynajmniej jedną z sekcji: service_level_by_day, analyses_by_day, checks_by_day, status_changes_by_day i performance_by_day
  • Określono domyślną kolejność sekcji raportów
  • Dodano nagłówki Cache-Control do plików z raportami
  • Zniesiono wymaganie podania numeru telefonu i osoby kontaktowej przy tworzeniu i edycji użytkowników
  • Dodano operację pobierania raportów w formacie PDF
  • Zwiększono wydajność pobierania historii monitoringu oraz danych do wykresów
  • Naprawiono błąd, w wyniku którego mogły być zwracane ujemne czasy odpowiedzi usług

3.5.1 (2017-12-13)

  • Naprawiono zbyt ostrą walidację adresów e-mail w raportach okresowych i danych użytkownika

3.5 (2017-10-23)

  • Dodano możliwość sortowania grup po nazwie oraz loginie konta, do którego należą
  • Dodano obsługę raportów asynchronicznych w wersji beta - zasób /reports
  • Zwiększono wydajność pobierania statusów usług, danych do wykresów i historii działania usług
  • Poprawiono kolejność typów usług na liście available_service_types w pakietach

3.4.1 (2017-10-18)

  • Naprawiono błąd 500 Internal Server Error występujący podczas pobierania wyników zapytań diagnostycznych stacji monitorujących

3.4 (2017-10-04)

  • Dodano wsparcie dla parametrów client_id oraz user_ip_address w operacji logowania (POST /auth_token)
  • Dodano możliwość przeglądania historii logowań do konta (GET /accounts/{_id}/logs/authentications)
  • Zwiększono limit długości przedziału czasowego dla operacji pobierania użytych stacji monitorujących i wykrytych błędów
  • Poprawiono dokładność wyników operacji pobierania danych do wykresów czasu odpowiedzi
  • Naprawiono błąd, w wyniku którego niektóre stacje monitorujące mogły nie być uwzględniane na liście użytych stacji (GET /services/{_id}/charts/performance/used_sensors)
  • Zmieniono domyślną kolejność typów usług i ich limitów, tak aby najpopularniejsze typy były wyżej na liście
  • Zwiększono wydajność pobierania listy (także dowiązywanych) usług, typów, sprawdzeń i ich szczegółów, analiz oraz pakietów, szczególnie przy jawnym określeniu ograniczeń fields oraz embed
  • Zwiększono wydajność pobierania danych do wykresów czasu odpowiedzi dla pojedynczych stacji

3.3.1 (2017-09-11)

  • Poprawiono niepoprawną wartość pola last_check_status_change_time statusu nowo utworzonej usługi.

3.3 (2017-09-05)

  • Dodano wsparcie dla filtrów dopasowujących dla wybranych pól
  • Dodano uwzględnianie niedostępności starej historii w polach last_analysis_id, last_ok_analysis_id i last_failure_analysis_id statusów działania usług
  • Poszerzono listę przykładów użycia API w dokumentacji
  • Dodano dokumentację formatu powiadomień HTTP JSON POST
  • Dodano możliwosć:
    • sortowania, filtrowania i wyszukiwania usług po nazwie typu
    • filtrowania i wyszukiwania sprawdzeń po nazwie stacji monitorującej i nazwie typu błędu
  • Naprawiono błąd, w wyniku którego mogły być niepoprawnie zwracane puste dane do wykresów szybkości działania
  • Naprawiono błąd, w wyniku którego status działania usługi mógł być niepoprawnie zwracany jako "nieznany"
  • Dodano brakujące punkty na lewo od wybranego przedziału na wykresach czasu odpowiedzi
  • Dodano operację pobierania logów wysłanych powiadomień dla konta
  • Dodano operację pobierania logów ostatnich zmian stanów usług należących do konta
  • Dodano operację pobierania statystyk konta
  • Dodano możliwość pobierania treści strony z momentu awarii bez kompresji zip (operacja GET /services/{_id}/history/analyses/{_analysis_id}/checks/{_sensor_id}/uncompressed_content)

3.2.4 (2017-08-08)

  • Poprawiono błąd, przez który niektóre ze statystyk liczby sprawdzeń we wskazanym stanie jej działania mogły nie być zwracane poprawnie.

3.2.3 (2017-08-08)

  • Naprawiono błąd, w wyniku którego możliwe było wielokrotne przypisanie tej samej stacji monitorującej do grupy.

3.2.2 (2017-08-04)

  • Naprawiono błąd mogący powodować zwrócenie pustej listy statystyk sprawdzeń dla wpisu w dzienniku zdarzeń
  • Naprawiono niedziałające dowiązywanie usługi do zaplanowanego zawieszenia monitoringu

3.2.1 (2017-07-28)

  • Naprawiono błąd 404 mogący występować podczas pobierania niektórych wpisów w dzienniku awarii.

3.2 (2017-07-05)

  • Zniesiono warunek okrągłych godzin UTC obowiązujący na końcach przedziałów w statystykach Service Level i danych do wykresów dostępności
  • Dodano obsługę aliasu main_account identyfikatora konta w adresach URL zasobów
  • Dodano pole duration do historii zmian stanów działania usług

3.1.2 (2017-07-03)

  • Poprawiono domyślne sortowanie wartości w słownikach notification_modes i recovery_notification_modes.

3.1.1 (2017-06-02)

  • Dodano brakujące punkty na lewo od przedziału czasowego na wykresach czasu odpowiedzi z rozbiciem na kroki.

3.1 (2017-06-02)

  • Dodano nagłówki Cache-Control do słowników, stacji monitorujących, historii, danych do wykresów, szczegółów sprawdzeń i plików HAR
  • Dodano możliwość zmiany i dowiązywania języka konta przez administratorów
  • Dodano obsługę stref czasowych: słownik time_zones oraz atrybut time_zone_id konta
  • Zoptymalizowano wydajność pobierania grup (także dowiązywanych) jeśli pole fields nie zawiera sensor_ids
  • Dodano liczbę wykonanych analiz do statystyk systemu (operacja GET /system/stats)
  • Dodano listę pakietów dostępnych publicznie i możliwość wyboru pakietu innego niż PODSTAWOWY przy rejestracji konta
  • Ujednolicono format danych do wykresu czasu odpowiedzi: dodano pola sensor_id i path_step do wszystkich serii oraz pole a (być może o wartości NULL) do wszystkich punktów
  • Dodano ID analizy do wykresu z rozbiciem na kroki, jeśli punkt dotyczy danych z jednej analizy
  • Dodano aliasy last_analysis, last_ok_analysis i last_failure_analysis do wszystkich operacji zawierających ID analizy w adresie URL
  • Dodano operacje obsługujące powiadomienia push w aplikacji mobilnej (tag mobile)
  • Zwiększono długość przedziału czasowego, z którego można pobierać historię sprawdzeń i analiz działania usługi (dostępny przedział jest dynamiczny i zależy od liczby faktycznie wykonanych sprawdzeń)
  • Dodano operację pobierania informacji o dostępności historii i szacunkowej liczbie sprawdzeń usługi w wybranym przedziale czasowym
  • Dozwolono na znak spacji w miejsce "+" na 20 pozycji czasu podawanego w formacie RFC3339 w parametrach GET
  • Poprawiono domyślną walidację loginów użytkowników (znak "." w loginie uniemożliwiał zalogowanie za pomocą /auth_token)

3.0.4 (2017-05-16)

  • Naprawiono kilka wewnętrznych błędów i problemów.

3.0.3 (2017-05-02)

  • Naprawiono rzadki błąd 500 Internal Server Error mogący występować przy wykonywaniu zapytań HTTP innych niż GET, HEAD i OPTIONS.

3.0.2 (2017-04-20)

  • Dodano brakujący kod błędu language_not_found do specyfikacji operacji tworzących i modyfikujących konta.

3.0.1 (2017-04-11)

  • Naprawiono błąd, w wyniku którego dla pojedynczej analizy mogła być niepoprawnie zwracana pusta lista sprawdzeń.

3.0 (2017-04-11)

Pierwsza stabilna wersja API z serii 3.*. Zmiany łamiące wsteczną kompatybilność z wersją 3.0-beta3 oznaczono za pomocą [!].

  • [!] Zastąpiono pole extended_settings typów usług przez dowiązywalną tablicę obiektów extended_setting_formats
  • [!] Usunięto zasób /reports
  • [!] Zmieniono nazwę zasobu legacy_report_addresses na periodic_report_addresses
  • [!] Zmieniono nazwę pól grup legacy_*_reports na periodic_*_reports
  • [!] Zmieniono nazwy pól:
    • enabled_notification_channels na notification_channel_ids w usługach
    • notification_conditions na notification_condition_ids w usługach
    • notifications_mode na notification_mode_id w usługach
    • recovery_notifications_mode na recovery_notification_mode_id w usługach
    • available_notification_channels na available_notification_channel_ids w pakietach
    • channel na notification_channel_id w adresach powiadomień
    • is_enabled na is_active w usługach
    • status na summary w statusach działania usługi
  • [!] Zmieniono nazwy operacji modyfikujących wiele usług jednocześnie: bulk_enable na bulk_activate oraz bulk_disable na bulk_pause
  • [!] Zmieniono nazwy błędów API: incorrect_login_data na incorrect_authentication_data oraz login_required na authentication_required
  • Dodano możliwość sortowania sprawdzeń (checks) po nazwie stacji monitorującej i nazwie typu błędu
  • Dodano operację pobierania statystyk systemu (GET /system/stats)
  • Poprawiono błąd, przez który pobieranie niektórych z analiz i sprawdzeń mogło zwracać błąd 404
  • Dodano wsparcie dla nowego kanału powiadomień "E-mail uproszczony"
  • Poszerzono obsługę wersji językowych:
    • Dodano angielskie tłumaczenia nazw miejscowości, krajów i kontynentów
    • Dodano angielskie tłumaczenia opisów zaawansowanych ustawień usług
    • Dodano atrybut language_id do kont użytkowników
  • Dozwolono na pobieranie pakietów kont, które udostępniają grupy kontu użytkownika i nadrzędnemu
  • Dodano zasoby słownikowe: kanały powiadomień, warunki powiadomień, tryby powiadomień, tryby powiadomień o końcu awarii oraz języki
  • Dodano możliwość dowiązywania zasobów słownikowych:
    • włączonych kanałów powiadomień do usługi
    • włączonych warunków powiadomień do usługi
    • ustawionego trybu powiadomień do usługi
    • ustawionego trybu powiadomień o końcu awarii do usługi
    • dostępnych kanałów powiadomień do pakietów
    • kanału powiadomień do adresu powiadomień
    • języka do konta
  • Poprawiono wydajność pobierania usług, ich typów oraz danych historycznych i do wykresów.

3.0-beta3 (2017-03-02)

  • Publiczna wersja beta API 3.0