IntersectMBO / IntersectMBO/govtool

💡 Improve API Documentation & Clarify Proposal Discussion Data Access

Open
#3,138 5 comments 0 reactions 1 assignee Assigned to @Ryun1 View on GitHub
🎨 Design Needed 💡 Feature idea 📜 Proposal Pillar
Dominant language
HTML
Stars
21
Forks
29
Avg merge
2d 22h
Merged PRs (30d)
7

Description

### Area

Proposal Pillar

### Is there new design needed?

Yes

### What?

A request for **API access** to the **proposal discussion forum** was raised by **Sandip Pandey**. During the investigation, it was discovered that a third-party tool (**governance-space.com**) is already accessing **proposal data** via the **GovTool API**, highlighting a **communication gap** in API documentation.

To address this, we need to:
1. **Improve API documentation** to clearly define data access policies.
2. **Ensure transparency in how proposal discussion data is retrieved and used.**

[see related discord message](https://discord.com/channels/1136727663583698984/1212344688523214869/1319405701704978452)

### Why?

- Reduces confusion around API availability and data access.
- Ensures transparency in how external tools can interact with GovTool data.
- Supports third-party integrations by providing clear guidelines.
- Prevents redundant API access requests by making information readily available.

### How?

- **Update API documentation** to explicitly state available endpoints, access permissions, and best practices.
- **Clarify data access policies** for external tools, defining what data can be retrieved and under what conditions.
- **Ensure that API consumers have a clear understanding of proposal discussion data access** to prevent inconsistencies.

### (Optional) User Story with acceptance criteria

- [ ] API documentation is updated with clear information on accessing proposal discussion data.
- [ ] Data access policies are defined and published.
- [ ] Third-party tools and users can retrieve API documentation easily.
- [ ] Any ambiguities in current API usage are resolved.
- [ ] Changes are tested and verified for clarity and accuracy.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.