# docapi — API Documentation (geonet-console)

Folder ini adalah **Single Source of Truth** untuk seluruh dokumentasi API geonet-console.

AI Agent dan Developer **wajib** membaca folder ini sebelum menggunakan atau mengembangkan API.
Tidak perlu membuka source code, controller, atau database schema.

---

## Aturan

- Dokumentasi API adalah bagian dari source code.
- Implementasi tanpa dokumentasi dianggap **belum selesai**.
- Setiap perubahan API **wajib** diikuti perubahan dokumentasi di folder ini.
- Markdown menjelaskan business rule. OpenAPI (`api-docs/openapi.json`) menjelaskan spesifikasi teknis.

---

## Struktur

```
docapi/
    README.md               ← file ini
    index.md                ← daftar semua endpoint
    authentication.md       ← panduan autentikasi
    common-response.md      ← format response standar
    common-error.md         ← kode error standar
    pagination.md           ← konvensi paginasi
    versioning.md           ← kebijakan versi API
    integration-guide.md    ← panduan integrasi antar service

    services/
        auth/               ← login, token guide
        service-tokens/     ← CRUD service tokens (microservice Bearer)
        databases/          ← database registry
        ldap/               ← LDAP users & groups
        project-search/     ← Ollama NAS project search
```

---

## Base URL

| Environment | URL |
|-------------|-----|
| Production  | `https://console.gisportal.id/api/v1` |

## Autentikasi

Lihat [`authentication.md`](./authentication.md) untuk panduan lengkap.

Ringkasan: semua endpoint (kecuali `/auth/login`) memerlukan header:

```
Authorization: Bearer <token>
```

Token diperoleh dari `POST /api/v1/auth/login` atau dari API Token yang diterbitkan di halaman `/api-clients`.

---

## Checklist AI Sebelum Membuat Endpoint Baru

- [ ] Endpoint dibuat di `routes/api.php`
- [ ] Controller method dibuat
- [ ] File markdown endpoint dibuat di `docapi/services/{service}/`
- [ ] `docapi/services/{service}/README.md` diperbarui
- [ ] `docapi/index.md` diperbarui
- [ ] Contoh request & response disertakan
- [ ] Error dijelaskan
- [ ] Business rule dijelaskan
- [ ] Audit log dicatat jika endpoint mengubah data