Add Wiki Read Access to REST API and TOD Without Requiring Code Read Permission #3199
kobe opened 1 hour ago

Feature Request: Allow Wiki Access via REST API and TOD Without Code Read Permission

Background

We currently use OneDev Wiki to maintain public project information, functional documentation, business scenarios, and test cases.

OneDev already allows users without Code Read permission to view Wiki pages through the web interface.

However, as we increasingly integrate AI agents (such as Claude Code) into our development and testing workflows, we would like testers to access Wiki content directly through local AI agents.

Currently, there are several limitations:

  • TOD does not provide dedicated Wiki commands or skills.
  • The REST API does not expose dedicated endpoints for accessing Wiki content.
  • Accessing Wiki files through Git requires Code Read permission, which cannot be granted to testers due to source code security requirements.

Proposed Enhancement

Please consider adding read-only Wiki support to the REST API and TOD, allowing AI agents to retrieve Wiki content without requiring access to the project's source code.

Suggested capabilities:

  1. List Wiki Pages: Retrieve the Wiki page hierarchy and available pages within a project.
  2. Read Wiki Pages: Retrieve the raw Markdown content of a specific Wiki page.
  3. Search Wiki Pages (Optional): Search Wiki content by keyword to help AI agents locate relevant documentation efficiently.
  4. TOD Integration: Provide commands such as tod wiki list and tod wiki read, or equivalent AI skills.

Permission Requirements

The key requirement is that Wiki API access should follow the existing Wiki web access permissions rather than requiring Code Read permission.

Specifically:

  • Users who can view Wiki pages through the web interface should also be able to read the same content through the REST API and TOD.
  • Users without Code Read permission must not gain access to the project's source code through these APIs.
  • API access should respect the authenticated user's existing project permissions.
  • Only read-only Wiki access is requested. Wiki editing capabilities are not required.

Expected Workflow

With this enhancement, testers could use local AI agents to:

List Wiki pages via TOD → Read business scenarios and test cases → Analyze documentation with AI → Perform AI-assisted testing.

All of this would be possible without granting access to the underlying source code repository.

Benefits

Since OneDev already exposes Wiki content to authorized users through its web interface, extending this capability to REST API and TOD would provide a consistent permission model across different access methods.

This would:

  • Enable secure AI-assisted testing without exposing source code.
  • Allow testers and AI agents to reuse existing Wiki documentation.
  • Eliminate the need to create separate Wiki repositories or duplicate documentation.
  • Reduce maintenance overhead and improve integration with AI-driven development workflows.

The main goal is to make existing Wiki content accessible to AI agents while preserving OneDev's current source code access restrictions.

1/1
Type
Enhancement
Priority
Normal
Assignee
Labels
No labels
Issue Votes (0)
Watchers (2)
Reference
OD-3199
Please wait...
Connection lost or session expired, reload to recover
Page is in error, reload to recover