update-api-docs

Skill do zarządzania dokumentacją referencyjną API. Pobiera najnowszą specyfikację OpenAPI z serwera produkcyjnego, zastępuje lokalny plik i regeneruje strony dokumentacji za pomocą Docusaurus. Automatyzuje cały proces aktualizacji, od pobrania spec do wygenerowania plików markdown i konfiguracji nawigacji. Idealne dla zespołów utrzymujących dokumentację API w synchronizacji ze zmianami w produkcji.

1. Pobierz najnowszą specyfikację OpenAPI z produkcji, uruchamiając polecenie curl, które pobiera plik openapi.json z serwera cloud.agenta.ai i zapisuje go w katalogu docs/docs/reference/openapi.json. Plik zostanie automatycznie zapisany w formacie minimalnym, zgodnym z istniejącą strukturą repozytorium.

2. Jeśli pracujesz na świeżej kopii repozytorium lub zależności nie zostały zainstalowane, przejdź do katalogu docs i uruchom npm install, aby zainstalować wszystkie wymagane pakiety.

3. Wyczyść istniejące wygenerowane pliki dokumentacji API, uruchamiając npm run clean-api-docs -- agenta w katalogu docs. Argument agenta odnosi się do identyfikatora konfiguracji OpenAPI zdefiniowanego w docusaurus.config.ts.

4. Regeneruj dokumentację API za pomocą npm run gen-api-docs -- agenta. Polecenie wygeneruje indywidualne pliki .api.mdx dla każdego endpointu, pliki .tag.mdx dla kategorii API oraz sidebar.ts dla nawigacji.

5. Opcjonalnie sprawdź wyniki, uruchamiając npm run start w katalogu docs i otwierając http://localhost:5000/docs/reference/api w przeglądarce, aby zweryfikować, czy dokumentacja API renderuje się prawidłowo.