Skip to content

Add API docs for /v1/info #11268

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
5 tasks done
kurokobo opened this issue Dec 2, 2024 · 0 comments · Fixed by #11269
Closed
5 tasks done

Add API docs for /v1/info #11268

kurokobo opened this issue Dec 2, 2024 · 0 comments · Fixed by #11269
Labels
📚 documentation Improvements or additions to documentation

Comments

@kurokobo
Copy link
Contributor

kurokobo commented Dec 2, 2024

Self Checks

  • I have searched for existing issues search for existing issues, including closed ones.
  • I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
  • [FOR CHINESE USERS] 请务必使用英文提交 Issue,否则会被关闭。谢谢!:)
  • Please do not modify this template :) and fill in all the required fields.

1. Is this request related to a challenge you're experiencing? Tell me about your story.

Yes, there is an endpoint /v1/info which can be used to gather app name and its description (and tags by #11242), but this endpoint is not documented at all.
This should be explicitly documented, as it misleads users into misunderstanding that the name of the app, etc., cannot be obtained from the API.

2. Additional context or comments

No response

3. Can you help us with this feature?

  • I am interested in contributing to this feature.
@dosubot dosubot bot added the 📚 documentation Improvements or additions to documentation label Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant