Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Addowner andparent fields clarification to docs#35023

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
AlexMaryW wants to merge3 commits intogo-gitea:main
base:main
Choose a base branch
Loading
fromAlexMaryW:add-owner-parent-docs

Conversation

AlexMaryW
Copy link
Contributor

Issue:#9637

Changes introduced: I have clarified the problematic terms (owner and parent) in all affected endpoints.

The changes were made to relevant:

  • HTTP endpoint parameters' descriptions
  • response/request models' fields

This MR is big, but most changes are the same. If you'd like me to break this MR into several smaller ones, let me know :)

@GiteaBotGiteaBot added the lgtm/need 2This PR needs two approvals by maintainers to be considered for merging. labelJul 9, 2025
@github-actionsgithub-actionsbot added modifies/apiThis PR adds API routes or modifies them modifies/goPull requests that update Go code labelsJul 9, 2025
@AlexMaryWAlexMaryWforce-pushed theadd-owner-parent-docs branch 2 times, most recently from211731c to0dec2d1CompareJuly 9, 2025 19:09
Copy link
Member

@techknowlogicktechknowlogick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Amazing, thanks!

@GiteaBotGiteaBot added lgtm/need 1This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2This PR needs two approvals by maintainers to be considered for merging. labelsJul 9, 2025
@silverwindsilverwind added the type/docsThis PR mainly updates/creates documentation labelJul 10, 2025
@wxiaoguang
Copy link
Contributor

Most changes are:

- //   description: owner of the repo+ //   description: username of the user or organization owning the repository

IMO "owner" is already a widely used concept, we can explain it somewhere, and keep the old description. Old description looks clearer

@wxiaoguangwxiaoguang marked this pull request as draftJuly 11, 2025 03:22
@AlexMaryW
Copy link
ContributorAuthor

Most changes are:

- //   description: owner of the repo+ //   description: username of the user or organization owning the repository

IMO "owner" is already a widely used concept, we can explain it somewhere, and keep the old description. Old description looks clearer

Thanks for reviewing the MR! :)

  • A new Gitea user might not be familiar with theowner concept and then the old description sounds confusing (as flagged in thisissue).
  • It's considered good practice to think of API docs as reference material. Hence, we should provide all necessary information in every single endpoint instead of explaining all concepts only once or assuming prior knowledge.
  • Theowner definition in the regular Gitea docs (the only definition I could find) does not match the API definition of theowner. For example, the regular docs state that a user or several of them can be owners of the repo and it is true of the Gitea UI. On the other hand, the API does not allow for many users to own a repo; it can either be a user or an org and the API considers both as the same object. If someone new to the concept reads the regular docs and then goes on to use the API, their understanding ofowner will not be correct.
  • If the definitions ofowner for UI and API differ, we cannot explain the concept in the regular docs and must use the API docs. From my point of view, there isn't a better place to define this concept than in every affected endpoint. How else can we ensure that the definition is easy to find and that every user will have the correct understanding of the concept?

@AlexMaryWAlexMaryW marked this pull request as ready for reviewJuly 15, 2025 18:29
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@wxiaoguangwxiaoguangwxiaoguang left review comments

@techknowlogicktechknowlogicktechknowlogick approved these changes

Assignees
No one assigned
Labels
lgtm/need 1This PR needs approval from one additional maintainer to be merged.modifies/apiThis PR adds API routes or modifies themmodifies/goPull requests that update Go codetype/docsThis PR mainly updates/creates documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

5 participants
@AlexMaryW@wxiaoguang@techknowlogick@silverwind@GiteaBot

[8]ページ先頭

©2009-2025 Movatter.jp