personal-projects/py-wikijs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update documentation to reflect Phase 1 (v0.1.0) completion

Browse Source 
This commit updates all project documentation to accurately reflect
the current implementation status and v0.1.0 MVP release.

**Major Updates:**

1. **CLAUDE.md (v1.1)**:
   - Updated Current Development State to 100% Phase 1 complete
   - Replaced outdated "CURRENT FOCUS: TASK 1.1" section with "PHASE 1 COMPLETE" summary
   - Marked all Phase 1 tasks (1.1-1.7) as complete with 100% status
   - Updated repository structure to show tests/, docs/, examples/ as complete
   - Added Phase 1 Achievement Summary with metrics:
     * 2,641 lines of test code (231 tests, 87%+ coverage)
     * 3,589+ lines of documentation
     * 3 authentication methods implemented
     * Complete Pages API (679 lines)
   - Updated Success Criteria checkboxes to reflect achievements
   - Prepared Phase 2 planning section
   - Added version history entry for v1.1

2. **docs/CHANGELOG.md**:
   - Moved [Unreleased] content to new [0.1.0] release section
   - Added comprehensive v0.1.0 release notes (2025-10-23)
   - Documented all delivered features:
     * Core Implementation (Client, Auth, Pages API, Models, Exceptions, Utilities)
     * Quality Infrastructure (Tests, Coverage, Tools, CI/CD)
     * Documentation (12 files, 3,589+ lines)
     * Project Infrastructure
   - Marked all v0.1.0 Success Criteria as complete
   - Fixed installation URL from GitHub to Gitea
   - Added security notes (input validation, API key masking, SSL verification)

3. **docs/api_reference.md**:
   - Fixed JWT Authentication documentation
   - Changed from username/password pattern to correct token-based pattern
   - Added proper parameters: token, base_url, refresh_token, expires_at
   - Documented JWT features: auto-expiration detection, token refresh, security

**Rationale:**
These updates ensure documentation accurately reflects the actual
implementation, eliminating confusion and providing clear status
for Phase 1 completion and readiness for Phase 2 development.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Claude
2025-10-23 13:59:15 +00:00
parent 7b67ade2f3
commit 6fdff8f95d
3 changed files with 283 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/api_reference.md
View File

@@ -87,16 +87,33 @@ client = WikiJSClient("https://wiki.example.com", auth=auth)
### JWT Authentication
JWT authentication uses token-based authentication with automatic refresh capabilities.
```python
from wikijs.auth import JWTAuth
# Initialize with JWT token and refresh token
auth = JWTAuth(
username="your-username",
password="your-password"
token="eyJ0eXAiOiJKV1QiLCJhbGc...",
base_url="https://wiki.example.com",
refresh_token="refresh_token_here", # Optional: for automatic token refresh
expires_at=1234567890 # Optional: Unix timestamp of token expiration
)
client = WikiJSClient("https://wiki.example.com", auth=auth)
```
**Parameters:**
- **token** (`str`): The JWT token string
- **base_url** (`str`): Wiki.js instance URL (needed for token refresh)
- **refresh_token** (`str`, optional): Refresh token for automatic renewal
- **expires_at** (`float`, optional): Token expiration timestamp (Unix timestamp)
**Features:**
- Automatic token expiration detection
- Automatic token refresh when refresh token is provided
- Configurable refresh buffer (default: 5 minutes before expiration)
- Token masking in logs for security
---
## Pages API