forge/forge
9
6
Fork 3
Code Issues 77 Pull requests 1 Projects 2 Wiki Activity Actions

REST API: Create private issue & foundational work #168

New issue
Closed
opened 2025-09-08 11:16:11 +00:00 by nilsph · 2 comments
nilsph commented 2025-09-08 11:16:11 +00:00 (Migrated from codeberg.org)
Copy link

Story

As a user of Forgejo,
I want to create private issues via the REST API,
so I can work on private issues using the web API.

Acceptance Criteria

  • Data structures are adapted for private issues.
  • Internal API is adapted to accommodate both. #329
  • A migration exists which modifies the DB schema appropriately. Tables should be created properly on a new installation, but existing installations should get new columns etc.
  • Functions and methods used for creating public issues are adapted so they can create either.

Background

  • This contains foundational work for everything else, I’ll probably refine AC and maybe will create new tickets as things become clearer.
  • Upstream wants separate tables for public issues (that exist already) and private issues (that don’t).
  • XORM maps one type to one database table XORM can dispatch one type to multiple tables via the Table()/TableName() methods => yet we need two types for public and private issues (the existing Issue is public, the new PrivateIssue will contain private ones), at least for querying via XORM Engine’s Find() method. However, this throws off many internal mechanisms of XORM (which creates variables of the same type internally when e.g. querying tables but gets things wrong when it comes to columns that need to be set one way or the other for the type to make sense).
  • Previously, upstream suggested to add a boolean attribute IsPublic so that it would default to false if unset. However, this throws off so much of the existing code base that I suggested the opposite (IsPrivate) because XORM lets us validate or set things on the "load from or store into DB" boundary through AfterLoad(), BeforeInsert(), BeforeUpdate() methods (and we can easily control this on the boundary where we convert one type into the other). This way we can a) ensure that a private issue is only stored in the DB through the PrivateIssue type (and let Issue refuse to do so for variables which represent a private issue and vice versa) and b) set IsPrivate accordingly when loading so we don’t have to store it in the DB (the fact that an issue is stored in one or the other table is information enough). They asked me to implement unit tests verifying this behavior (to ensure XORM does as it advertises), but I would do that anyway.
# Story As a user of Forgejo, I want to create private issues via the REST API, so I can work on private issues using the web API. # Acceptance Criteria - [x] Data structures are adapted for private issues. - [x] Internal API is adapted to accommodate both. #329 - [x] A migration exists which modifies the DB schema appropriately. Tables should be created properly on a new installation, but existing installations should get new columns etc. - [x] Functions and methods used for creating public issues are adapted so they can create either. # Background - This contains foundational work for everything else, I’ll probably refine AC and maybe will create new tickets as things become clearer. - Upstream wants separate tables for public issues (that exist already) and private issues (that don’t). - ~~XORM maps one type to one database table~~ XORM can dispatch one type to multiple tables via the Table()/TableName() methods => yet we need two types for public and private issues (the existing `Issue` is public, the new `PrivateIssue` will contain private ones), at least for querying via XORM Engine’s Find() method. **However**, this throws off many internal mechanisms of XORM (which creates variables of the same type internally when e.g. querying tables but gets things wrong when it comes to columns that need to be set one way or the other for the type to make sense). - Previously, upstream suggested to add a boolean attribute `IsPublic` so that it would default to `false` if unset. However, this throws off so much of the existing code base that I suggested the opposite (`IsPrivate`) because XORM lets us validate or set things on the "load from or store into DB" boundary through `AfterLoad()`, `BeforeInsert()`, `BeforeUpdate()` methods (and we can easily control this on the boundary where we convert one type into the other). This way we can a) ensure that a private issue is only stored in the DB through the `PrivateIssue` type (and let `Issue` refuse to do so for variables which represent a private issue and vice versa) and b) set `IsPrivate` accordingly when loading so we don’t have to store it in the DB (the fact that an issue is stored in one or the other table is information enough). They asked me to implement unit tests verifying this behavior (to ensure XORM does as it advertises), but I would do that anyway.
ryanlerch added this to the Sprint 12 project 2025-11-03 04:07:04 +00:00
ryanlerch modified the project from Sprint 12 to Backlog 2025-11-03 04:10:21 +00:00
nphilipp modified the project from Backlog to Sprint 12 2025-11-17 10:29:10 +00:00
nphilipp commented 2025-12-01 12:22:23 +00:00
Member
Copy link

As discussed, bumping story points because this proved to be more involved than initially estimated.

As discussed, bumping story points because this proved to be more involved than initially estimated.
humaton modified the project from Sprint 12 to Sprint 13 2026-01-26 10:44:00 +00:00
nphilipp commented 2026-02-19 17:24:58 +00:00
Member
Copy link

Implemented in my feature branch, in "feat: Private Issues: Foundational changes" and "feat: Private Issues: Allow creating through API".

Implemented in [my feature branch](https://codeberg.org/nilsph/forgejo/src/branch/forgejo--private-issues), in "feat: Private Issues: Foundational changes" and "feat: Private Issues: Allow creating through API".
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
test
docs
No results found.
Labels
Clear labels   
Backlog Status
Needs Review
Work items that have been created or updated but need review, refinement, or approval before they can be considered ready for sprint planning.

  
Backlog Status
Ready
Work items that have been reviewed, refined, and are ready to be committed to a sprint. These items have clear requirements and could be worked on immediately when capacity is available.

  
Chore

Tasks that are necessary but don't directly deliver new value to the end-user. These are internal tasks like updating a library, managing user accounts, or setting up a new service.

  
points
01
A task that is simple, small, and has very little uncertainty. It should be easy enough for any team member to pick up and complete quickly, without a lot of discussion or research.

  
points
02
This is a task that is slightly more complex or larger than a "1." It might involve two or three simple steps, but the outcome is still very clear and there's little uncertainty.

  
points
03
medium-sized task with some noticeable complexity. It might require a bit more thought or collaboration. The steps are well-defined, but it's not a trivial change.

  
points
05
a significant piece of work. It has more complexity and a higher degree of uncertainty than smaller tasks. It might require some research, a design discussion, or collaboration across multiple teams.

  
points
08
complex task with a lot of uncertainty. It's often the largest size that a team will consider for a single sprint. It likely requires a detailed breakdown and multiple team members to complete.

  
points
13
Any task that feels like it's a "13" or more is considered an Epic. These are too large and uncertain to be worked on in a single sprint.

  
Priority
High
This is for work that is critical and needs to be addressed in the next sprint. It's often for urgent bugs, important features, or a major piece of technical debt that is blocking other work.

  
Priority
Low
This is for work that is good to do but not urgent. It's a candidate for being worked on when there's extra time or when it rises in importance. It can stay in the backlog for a longer period.

  
Priority
Medium
This is for important work that should be done soon, but isn't as urgent as a high-priority item. It will likely be considered for the next 1-2 sprints.

  
Sprint Status
Blocked
Indicates the work cannot proceed. There is a dependency or an issue that is preventing the team from completing the task. This is a flag for the Scrum Master to help unblock the team.

  
Sprint Status
Done
Work items that have been completed, reviewed, and integrated. No further work is needed within the current sprint.

  
Sprint Status
In Progress
This label is for work that a developer is actively working on. This is usually what you'll see on the "In Progress" column of your project board.

  
Sprint Status
Review
This indicates that the work is complete, but it is now in a review state. This could mean a peer code review, a QA check, or a review by the Product Owner.

  
Sprint Status
To Do
Work items that are committed to the sprint but haven't been started yet. These items are ready to be picked up by team members.

  
Technical Debt

work that improves the codebase without adding new features. It's work that pays down the "debt" you've accumulated, such as refactoring a messy piece of code, improving test coverage.

  
Work Item
Bug
Issues where the system is not working as intended or designed. Bugs represent deviations from expected behavior.

  
Work Item
Epic

  
Work Item
Spike

  
Work Item
Task

  
Work Item
User Story

  
Backlog Status
Needs Review
Work items that have been created or updated but need review, refinement, or approval before they can be considered ready for sprint planning.

  
Backlog Status
Ready
Work items that have been reviewed, refined, and are ready to be committed to a sprint. These items have clear requirements and can be worked on immediately when capacity is available.

  
chore

Work that needs to be done but doesn't add new functionality or fix bugs. Maintenance tasks that keep the system running smoothly and the codebase clean.

  
documentation

Work focused on creating, updating, or improving documentation for users, developers, or system administrators.

  
points
01
A task that is simple, small, and has very little uncertainty. It should be easy enough for any team member to pick up and complete quickly, without a lot of discussion or research.

  
points
02
This is a task that is slightly more complex or larger than a "1." It might involve two or three simple steps, but the outcome is still very clear and there's little uncertainty.

  
points
03
Medium-sized task with some noticeable complexity. It might require a bit more thought or collaboration. The steps are well-defined, but it's not a trivial change.

  
points
05
A significant piece of work. It has more complexity and a higher degree of uncertainty than smaller tasks. It might require some research, a design discussion, or collaboration across multiple teams.

  
points
08
Complex task with a lot of uncertainty. It's often the largest size that a team will consider for a single sprint. It likely requires a detailed breakdown and multiple team members to complete.

  
points
13
Any task that feels like it's a "13" or more is considered an Epic. These are too large and uncertain to be worked on in a single sprint and should be broken down.

  
Priority
High
This is for work that is critical and needs to be addressed in the next sprint. It's often for urgent bugs, important features, or a major piece of technical debt that is blocking other work.

  
Priority
Low
This is for work that is good to do but not urgent. It's a candidate for being worked on when there's extra time or when it rises in importance. It can stay in the backlog for a longer period.

  
Priority
Medium
This is for important work that should be done soon, but isn't as urgent as a high-priority item. It will likely be considered for the next 1-2 sprints.

  
Sprint Status
Blocked
Work items that cannot progress due to external dependencies, blockers, or issues that need resolution.

  
Sprint Status
Done
Work items that have been completed, reviewed, and integrated. No further work is needed within the current sprint.

  
Sprint Status
In Progress
Work items currently being worked on by a team member. Active development, research, or implementation is happening.

  
Sprint Status
Review
Work items that are complete but need review, testing, or approval before being marked as done.

  
Sprint Status
To Do
Work items that are committed to the sprint but haven't been started yet. These items are ready to be picked up by team members.

  
Technical Debt

Work that addresses shortcuts, workarounds, or suboptimal implementations that were done previously to meet deadlines. These items improve code quality, maintainability, or performance without adding new features.

  
Work Item
Bug
Issues where the system is not working as intended or designed. Bugs represent deviations from expected behavior.

  
Work Item
Epic
Large initiatives that are broken down into multiple smaller work items (user stories, tasks, bugs). Epics represent significant features or projects that span multiple sprints.

  
Work Item
Spike
Time-boxed research, investigation, or proof-of-concept work to reduce uncertainty or explore solutions. Spikes help inform future development decisions.

  
Work Item
Task
Used to break down larger user stories into smaller, manageable implementation pieces. They focus on the specific technical steps needed to deliver the user story's value.

  
Work Item
User Story
User-facing features or functionality that can be framed from a user perspective, describing what someone wants to accomplish and why.

No labels
Backlog Status
Needs Review
Backlog Status
Ready
Chore
points
01
points
02
points
03
points
05
points
08
points
13
Priority
High
Priority
Low
Priority
Medium
Sprint Status
Blocked
Sprint Status
Done
Sprint Status
In Progress
Sprint Status
Review
Sprint Status
To Do
Technical Debt
Work Item
Bug
Work Item
Epic
Work Item
Spike
Work Item
Task
Work Item
User Story
Backlog Status
Needs Review
Backlog Status
Ready
chore
documentation
points
01
points
02
points
03
points
05
points
08
points
13
Priority
High
Priority
Low
Priority
Medium
Sprint Status
Blocked
Sprint Status
Done
Sprint Status
In Progress
Sprint Status
Review
Sprint Status
To Do
Technical Debt
Work Item
Bug
Work Item
Epic
Work Item
Spike
Work Item
Task
Work Item
User Story
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Sprint 14
Assignees
Clear assignees
No assignees
nphilipp
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Blocks
#113 Private Issues
forge/forge
Reference
forge/forge#168
No description provided.