alex/tilbudgivern
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
1c44a514b49c3694f5ea9935befd8a6dce13ec85
tilbudgivern/docs/archived/apitest/DOCUMENTATION_INDEX.md
T

235 lines
11 KiB
Markdown
Raw Blame History

# Documentation Index - API Integration Guide
**Purpose:** Quick reference for all documentation files in this project
**Target:** Backend developers integrating into tilbudsgiveren.alw.dk (React application)
---
## 🎯 Start Here
### For React Developers
1. **[README.md](README.md)** - Project overview, quick start, usage examples
2. **[API_INTEGRATION_GUIDE.md](API_INTEGRATION_GUIDE.md)** - **MAIN GUIDE** for backend integration
3. **[EXPANSION_PLAN.md](EXPANSION_PLAN.md)** - Project status and integration roadmap
### For API Endpoint Reference
- All 565 endpoints documented in batch summaries (see below)
- Example scripts in `examples/curl_*.sh` (queries) and `examples/mutation_*.sh` (mutations)
- Test outputs in `examples/output/*.json`
---
## 📚 Main Documentation
### Overview Documents
| File | Purpose | Audience |
|------|---------|----------|
| [README.md](README.md) | Project overview, quick start guide | All developers |
| [API_INTEGRATION_GUIDE.md](API_INTEGRATION_GUIDE.md) | **Complete integration guide** with code examples | Backend + React developers |
| [EXPANSION_PLAN.md](EXPANSION_PLAN.md) | Project status, integration roadmap, phase planning | Project managers + developers |
| [DOCUMENTATION_INDEX.md](DOCUMENTATION_INDEX.md) | This file - documentation overview | All developers |
---
## 📋 Batch Documentation
### Query Batches (Fase 1 - Batch 11)
All queries are **🟢 SAFE** for production (read-only operations).
| Batch | Endpoints | Focus | Summary |
|-------|-----------|-------|---------|
| **Fase 1** | 19 | Core functionality (cases, customers, offers, products) | [README.md](README.md) |
| **Batch 2** | 30 | Extended entities (case/contact/creditor/customer/offer/payment) | [BATCH_2_SUMMARY.md](BATCH_2_SUMMARY.md) |
| **Batch 3** | 30 | Hour/Installation/Invoice/Offer extended | [BATCH_3_SUMMARY.md](BATCH_3_SUMMARY.md) |
| **Batch 4** | 30 | Service/SalesInvoice/Docs/Employee/GPS/Events | [BATCH_4_SUMMARY.md](BATCH_4_SUMMARY.md) |
| **Batch 5** | 30 | VAT/Accounts/Settings/PDF/Suppliers/Schemes | [BATCH_5_SUMMARY.md](BATCH_5_SUMMARY.md) |
| **Batch 6** | 30 | User/Messages/Cars/Pauses/Misc config | [BATCH_6_SUMMARY.md](BATCH_6_SUMMARY.md) |
| **Batch 7** | 16 | Advanced queries/Boligmappa/Reporting | [BATCH_7_SUMMARY.md](BATCH_7_SUMMARY.md) |
| **Batch 8** | 28 | Finance/Salary/Notifications/System | [BATCH_8_SUMMARY.md](BATCH_8_SUMMARY.md) |
| **Batch 9** | 20 | Expenses/Gas/Widgets/Sync/Tax/Units | [BATCH_9_SUMMARY.md](BATCH_9_SUMMARY.md) |
| **Batch 10** | 7 | Reminder settings/Cleanup | [BATCH_10_SUMMARY.md](BATCH_10_SUMMARY.md) |
| **Batch 11** | 15 | Final queries with required parameters | [BATCH_11_SUMMARY.md](BATCH_11_SUMMARY.md) |
| **TOTAL** | **255** | **All queries tested and ready** | ✅ 100% |
### Mutation Batches (Batch 12-22)
| Batch | Endpoints | Safety Level | Focus | Summary |
|-------|-----------|--------------|-------|---------|
| **Batch 12** | 24 | 🟢 Safe | mark, send, set, approve, register, sync | [BATCH_12_SUMMARY.md](BATCH_12_SUMMARY.md) |
| **Batch 13** | 30 | 🟡 Medium | update (account, case, customer, contact, etc.) | [BATCH_13_SUMMARY.md](BATCH_13_SUMMARY.md) |
| **Batch 14** | 30 | 🟡 Medium | update (finance, hours, invoice, offer, product) | [BATCHES_14_15_SUMMARY.md](BATCHES_14_15_SUMMARY.md) |
| **Batch 15** | 18 | 🟡 Medium | update (service, scheme, settings, user, vat) | [BATCHES_14_15_SUMMARY.md](BATCHES_14_15_SUMMARY.md) |
| **Batch 16** | 30 | 🔴 Dangerous | accept, add, bulk, change, clone, convert, copy | [BATCHES_16_22_SUMMARY.md](BATCHES_16_22_SUMMARY.md) |
| **Batch 17** | 30 | 🔴 Dangerous | create (first batch) | [BATCHES_16_22_SUMMARY.md](BATCHES_16_22_SUMMARY.md) |
| **Batch 18** | 30 | 🔴 Dangerous | create (second batch) | [BATCHES_16_22_SUMMARY.md](BATCHES_16_22_SUMMARY.md) |
| **Batch 19** | 30 | 🔴 Dangerous | create (15) + delete (15) | [BATCHES_16_22_SUMMARY.md](BATCHES_16_22_SUMMARY.md) |
| **Batch 20** | 30 | 🔴 Dangerous | delete (first batch) | [BATCHES_16_22_SUMMARY.md](BATCHES_16_22_SUMMARY.md) |
| **Batch 21** | 14 | 🔴 Dangerous | delete (final batch) | [BATCHES_16_22_SUMMARY.md](BATCHES_16_22_SUMMARY.md) |
| **Batch 22** | 44 | 🔴 Dangerous | upload, move, transfer, other | [BATCHES_16_22_SUMMARY.md](BATCHES_16_22_SUMMARY.md) |
| **TOTAL** | **310** | **Mixed** | **All mutations documented** | ✅ 99.7% |
---
## 🔍 Planning Documents
Planning documents were created before each batch to organize work:
### Query Planning
- [BATCH_2_PLAN.md](BATCH_2_PLAN.md) - Batch 2 planning
- [BATCH_3_PLAN.md](BATCH_3_PLAN.md) - Batch 3 planning
- [BATCH_4_PLAN.md](BATCH_4_PLAN.md) - Batch 4 planning
- [BATCH_5_PLAN.md](BATCH_5_PLAN.md) - Batch 5 planning
- [BATCH_6_PLAN.md](BATCH_6_PLAN.md) - Batch 6 planning
- [BATCH_7_PLAN.md](BATCH_7_PLAN.md) - Batch 7 planning
- [BATCH_8_PLAN.md](BATCH_8_PLAN.md) - Batch 8 planning
- [BATCH_9_PLAN.md](BATCH_9_PLAN.md) - Batch 9 planning
- [BATCH_10_PLAN.md](BATCH_10_PLAN.md) - Batch 10 planning
- [BATCH_11_PLAN.md](BATCH_11_PLAN.md) - Batch 11 planning
### Mutation Planning
- [BATCH_12_PLAN.md](BATCH_12_PLAN.md) - Safe mutations planning
- [BATCH_13_PLAN.md](BATCH_13_PLAN.md) - Update mutations planning
- [BATCH_14_PLAN.md](BATCH_14_PLAN.md) - Update mutations planning
- [BATCH_16_PLAN.md](BATCH_16_PLAN.md) - Dangerous mutations planning
**Note:** Planning docs are primarily for project history. Use SUMMARY docs for endpoint reference.
---
## 🎯 Integration Quick Reference
### By Use Case
#### Case Management (35 endpoints)
- **Queries:** `cases`, `case`, `caseStatuses`, `caseTypes`, `caseActivities`, etc.
- **Safe Mutations:** N/A
- **Updates:** `updateCase`, `updateCaseStatus`, `updateCaseType`
- **Creates/Deletes:** `createCase`, `deleteCase`, etc.
- **Documentation:** [BATCH_2_SUMMARY.md](BATCH_2_SUMMARY.md), [BATCH_4_SUMMARY.md](BATCH_4_SUMMARY.md), [BATCH_7_SUMMARY.md](BATCH_7_SUMMARY.md)
#### Customer Management (30 endpoints)
- **Queries:** `customers`, `customer`, `customerGroups`, `customerActivities`, etc.
- **Safe Mutations:** N/A
- **Updates:** `updateCustomer`, `updateContact`, `updateCreditor`
- **Creates/Deletes:** `createCustomer`, `deleteCustomer`, etc.
- **Documentation:** [BATCH_2_SUMMARY.md](BATCH_2_SUMMARY.md), [BATCH_13_SUMMARY.md](BATCH_13_SUMMARY.md)
#### Offer Management (20 endpoints)
- **Queries:** `offers`, `offer`, `offerStatuses`, `offerTypes`, `offerActivities`, etc.
- **Safe Mutations:** `sendOfferEmail`
- **Updates:** `updateOffer`, `updateOfferLine`, `updateOfferStatus`
- **Creates/Deletes:** `createOffer`, `deleteOffer`, etc.
- **Documentation:** [BATCH_2_SUMMARY.md](BATCH_2_SUMMARY.md), [BATCH_3_SUMMARY.md](BATCH_3_SUMMARY.md)
#### Invoice Management (30 endpoints)
- **Queries:** `invoices`, `invoice`, `salesInvoices`, `creditorInvoices`, etc.
- **Safe Mutations:** `sendInvoiceEmail`, `approveCreditorInvoice`
- **Updates:** `updateInvoice`, `updateCreditorInvoice`, `updateSalesInvoice`
- **Creates/Deletes:** `createInvoice`, `deleteInvoice`, etc.
- **Documentation:** [BATCH_3_SUMMARY.md](BATCH_3_SUMMARY.md), [BATCH_4_SUMMARY.md](BATCH_4_SUMMARY.md)
#### Product Management (15 endpoints)
- **Queries:** `products`, `product`, `productGroups`, `productEanNumberExists`, etc.
- **Safe Mutations:** N/A
- **Updates:** `updateProduct`, `updateProductGroup`
- **Creates/Deletes:** `createProduct`, `deleteProduct`, etc.
- **Documentation:** [BATCH_3_SUMMARY.md](BATCH_3_SUMMARY.md), [BATCH_7_SUMMARY.md](BATCH_7_SUMMARY.md)
#### Service Management (12 endpoints)
- **Queries:** `services`, `service`, `serviceTypes`, `serviceStatuses`, etc.
- **Safe Mutations:** N/A
- **Updates:** `updateService`, `updateServiceStatus`
- **Creates/Deletes:** `createService`, `deleteService`, etc.
- **Documentation:** [BATCH_4_SUMMARY.md](BATCH_4_SUMMARY.md), [BATCH_11_SUMMARY.md](BATCH_11_SUMMARY.md)
#### Hour Tracking (15 endpoints)
- **Queries:** `hours`, `hourEntry`, `hourTypes`, `hourAggregate`, etc.
- **Safe Mutations:** N/A
- **Updates:** `updateHourEntry`, `updateHourType`
- **Creates/Deletes:** `createHourEntry`, `deleteHourEntry`, etc.
- **Documentation:** [BATCH_3_SUMMARY.md](BATCH_3_SUMMARY.md), [BATCH_11_SUMMARY.md](BATCH_11_SUMMARY.md)
#### Finance & Accounting (20 endpoints)
- **Queries:** `financeStatistics`, `financeYearToDateStatistics`, `accounts`, etc.
- **Safe Mutations:** N/A
- **Updates:** `updateFinanceAgreement`, `updateAccount`
- **Creates/Deletes:** `createFinanceAgreement`, `deleteAccount`, etc.
- **Documentation:** [BATCH_5_SUMMARY.md](BATCH_5_SUMMARY.md), [BATCH_8_SUMMARY.md](BATCH_8_SUMMARY.md)
#### Documentation & Files (18 endpoints)
- **Queries:** `documents`, `documentTypes`, `documentationFolders`, etc.
- **Safe Mutations:** N/A
- **Updates:** `updateDocument`
- **Creates/Deletes:** `uploadDocument`, `uploadCaseDocument`, `deleteDocument`, etc.
- **Documentation:** [BATCH_4_SUMMARY.md](BATCH_4_SUMMARY.md), [BATCHES_16_22_SUMMARY.md](BATCHES_16_22_SUMMARY.md)
#### Settings & Configuration (50+ endpoints)
- **Queries:** `settings`, `configurations`, `preferences`, `currencies`, etc.
- **Safe Mutations:** `setPreference`, `setNamedPreference`
- **Updates:** `updateSettings`, `updateConfiguration`
- **Creates/Deletes:** Various configuration mutations
- **Documentation:** [BATCH_5_SUMMARY.md](BATCH_5_SUMMARY.md), [BATCH_6_SUMMARY.md](BATCH_6_SUMMARY.md)
#### User & Permissions (10 endpoints)
- **Queries:** `users`, `user`, `userRoles`, `loggedInUser`, etc.
- **Safe Mutations:** N/A
- **Updates:** `updateUser`, `updateUserRole`
- **Creates/Deletes:** `createUser`, `deleteUser`, etc.
- **Documentation:** [BATCH_6_SUMMARY.md](BATCH_6_SUMMARY.md), [BATCH_11_SUMMARY.md](BATCH_11_SUMMARY.md)
#### Schemes (15 endpoints)
- **Queries:** `schemes`, `schemeTypes`, `schemeTemplates`, etc.
- **Safe Mutations:** `approveScheme`, `closeScheme`, `rejectScheme`
- **Updates:** `updateScheme`
- **Creates/Deletes:** `createScheme`, `deleteScheme`, etc.
- **Documentation:** [BATCH_5_SUMMARY.md](BATCH_5_SUMMARY.md), [BATCH_12_SUMMARY.md](BATCH_12_SUMMARY.md)
---
## 🔍 Search Tips
### Finding Specific Endpoints
1. **By Name:** Check [API_INTEGRATION_GUIDE.md](API_INTEGRATION_GUIDE.md) - all 565 endpoints listed by category
2. **By Batch:** Use table above to find which batch contains the endpoint
3. **By Use Case:** Use "Integration Quick Reference" section above
4. **By Safety Level:**
- 🟢 Safe: Queries (Batches 1-11) + Batch 12
- 🟡 Medium: Batches 13-15
- 🔴 Dangerous: Batches 16-22
### Finding Code Examples
1. **Query examples:** `examples/curl_*.sh` (255 scripts)
2. **Mutation examples:** `examples/mutation_*.sh` (310 scripts)
3. **Test outputs:** `examples/output/*.json` (144 files)
4. **Integration examples:** [API_INTEGRATION_GUIDE.md](API_INTEGRATION_GUIDE.md)
---
## 📊 Statistics
- **Total Documentation Files:** 64 markdown files
- **Total Scripts:** 565 (255 queries + 310 mutations)
- **Total Test Outputs:** 144 JSON files
- **Coverage:** 99.8% (565/566 endpoints)
- **Lines of Documentation:** 10,000+ lines
- **Project Duration:** 22 batches completed
---
## 🚀 Next Steps
1. **For new developers:** Start with [README.md](README.md)
2. **For backend integration:** Read [API_INTEGRATION_GUIDE.md](API_INTEGRATION_GUIDE.md)
3. **For project planning:** Check [EXPANSION_PLAN.md](EXPANSION_PLAN.md)
4. **For specific endpoints:** Use batch summaries or search this index
---
**Last Updated:** After Batch 22 completion
**Status:** Documentation complete, ready for integration
**Target:** tilbudsgiveren.alw.dk (React application)
Reference in New Issue View Git Blame Copy Permalink