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

Merged
lunny merged 4 commits intogo-gitea:mainfromAlexMaryW:add-owner-parent-docs
Jul 23, 2025

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
@wxiaoguang
Copy link
Contributor

wxiaoguang commentedJul 20, 2025
edited
Loading

I would still suggest to avoid repeating the "owner" explanation hundreds of times.

Could you revert these changes? We can do it better by adding a "Concept" table on the UI, explain everything one time at one place.

image

@AlexMaryW
Copy link
ContributorAuthor

AlexMaryW commentedJul 20, 2025
edited
Loading

Sure, your approach makes sense. I reverted the changes, could you please take another look?

Could you please elaborate on the 'Concept' table in the UI? I don't understand where you'd like to put it (e.g. under the "This documentation describes the Gitea API" or outside of the API docs?). I'd be happy to write it if possible.

@wxiaoguang
Copy link
Contributor

wxiaoguang commentedJul 21, 2025
edited
Loading

Thank you very much. Will make some more changes, IMO:

  • It doesn't need to explain the "owner" if it is used as "repo.owner" or "repo_owner_name", the variable name is already clear enough.
  • IssueMeta.Owner is "owner of the issue's repo" (but not "owner of the issue")
  • Added a TODO in "swagger/ui.tmpl": add Help & Glossary to help users understand the API, and explain some concepts like "Owner"

@github-actionsgithub-actionsbot added the modifies/templatesThis PR modifies the template files labelJul 21, 2025
@GiteaBotGiteaBot added lgtm/doneThis PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1This PR needs approval from one additional maintainer to be merged. labelsJul 22, 2025
@lunnylunny added the reviewed/wait-mergeThis pull request is part of the merge queue. It will be merged soon. labelJul 23, 2025
@lunnylunnyenabled auto-merge (squash)July 23, 2025 06:19
@lunnylunny merged commitc10c420 intogo-gitea:mainJul 23, 2025
26 checks passed
@GiteaBotGiteaBot added this to the1.25.0 milestoneJul 23, 2025
@GiteaBotGiteaBot removed the reviewed/wait-mergeThis pull request is part of the merge queue. It will be merged soon. labelJul 23, 2025
zjjhot added a commit to zjjhot/gitea that referenced this pull requestJul 28, 2025
* giteaofficial/main:  [skip ci] Updated translations via Crowdin  Fix migrate input box bug (go-gitea#35166)  [skip ci] Updated translations via Crowdin  Only hide dropzone when no files have been uploaded (go-gitea#35156)  Change some columns from text to longtext and fix column wrong type caused by xorm (go-gitea#35141)  [skip ci] Updated translations via Crowdin  Add `owner` and `parent` fields clarification to docs (go-gitea#35023)  Improve language in en-US locale strings (go-gitea#35124)
@go-giteago-gitea locked asresolvedand limited conversation to collaboratorsOct 21, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.

Reviewers

@techknowlogicktechknowlogicktechknowlogick approved these changes

@wxiaoguangwxiaoguangwxiaoguang approved these changes

Assignees

No one assigned

Labels

lgtm/doneThis PR has enough approvals to get merged. There are no important open reservations anymore.modifies/apiThis PR adds API routes or modifies themmodifies/goPull requests that update Go codemodifies/templatesThis PR modifies the template filestype/docsThis PR mainly updates/creates documentation

Projects

None yet

Milestone

1.25.0

Development

Successfully merging this pull request may close these issues.

6 participants

@AlexMaryW@wxiaoguang@techknowlogick@lunny@silverwind@GiteaBot

[8]ページ先頭

©2009-2025 Movatter.jp