"Team.units_map" field is an object, not an string array!

[ozgurceozturkce]

Description

The problem experienced due to some uncertainties and deficiencies in the documentation is as follows.

The unit_map field in the Team model defined in Gitea is shown as an string, but the response returns as an object. There is also no model related to the units_map field. Also, as an example in the documentation description, text starts with a object sign '{' and ends with a array sign ']'.

Please see refer to the definition and example of the unit_map field in Team model introduction in documentation at this link.

Gitea Version

1.17.2 and (for doc try.gitea.io - 1.18.0+dev-478-g08609d439)

Can you reproduce the bug on the Gitea demo site?

No

Log Gist

No response

Screenshots

Git Version

2.37.1

Operating System

Windows Server 2022

How are you running Gitea?

Gitea version 1.17.2 executable on Windows Server 2022.

Database

MySQL

[wxiaoguang]

What do you mean?

[ozgurceozturkce]

As seen in the screenshot I attached, the sample json text starts with an object sign but ends with a string sign. It also comes as a model object, not a plain string, and I can get it with a Dictionary<TKey, TValue> but at first I perceived it as an object according to the information here.

[wxiaoguang]

That's a typo in comment and affects nothing, it could be fixed.

[wxiaoguang]

As seen in the screenshot I attached, the sample json text starts with an object sign but ends with a string sign.

It means that the values in the object are strings.

[ozgurceozturkce]

Yes the typo is simple and fixable. I say respectfully, not with the thought of an accusation or problem, I wish there were a little more explanatory and understandable documentation. Of course, the gitea team is doing their best, I'm sure of that and I'm grateful. Also, thank you for your help and explanation. The correction will not be made immediately, but I am closing the issue as done.

[wxiaoguang]

Thank you for your catch and suggestion. The unit_map : { <*>: string } format is generated by Swagger automatically, IIRC it's widely used already for object map? I am not sure it's possible to change it or use other formats at the moment.

The PR #21347 will fix the comment.

---