osu-web icon indicating copy to clipboard operation
osu-web copied to clipboard

Add `speed_note_count` to docs

Open HonKLam opened this issue 1 year ago • 4 comments

Resolves #10345

API call for BeatmapDifficultyAttributes looks like this (in osu):

image

So I added the missing speed_note_count to docs and it looks like this now:

image

I also checked the other gamemodes and found some things off:

Taiko

API

image

Docs

image

(peak_difficulty vs approach_rate)

Mania

API

image

Docs

image

(score_multiplier just missing in general?)


Is this intended? Otherwise I can offer to fix it in the docs.

HonKLam avatar Feb 06 '24 23:02 HonKLam

BeatmapDifficultyAttributes depends on the output of osu-beatmap-difficulty-lookup-cache which may change and is better documented else where, in my opinion.

notbakaneko avatar Feb 08 '24 08:02 notbakaneko

and is better documented else where, in my opinion

If BeatmapDifficultyAttributes should not be documented in osu docs, but can be requested via API, where should it be documented then?

Could also put in a note in docs that states that BeatmapDifficultyAttributes is subject to change, but that applies to every endpoint or output, doesn't it?

HonKLam avatar Feb 08 '24 09:02 HonKLam

If BeatmapDifficultyAttributes should not be documented in osu docs, but can be requested via API, where should it be documented then?

the linked project which the endpoint proxies to

Could also put in a note in docs that states that BeatmapDifficultyAttributes is subject to change, but that applies to every endpoint or output, doesn't it?

the code and documentation for other endpoints are in the same repository whereas this one the code is in another castle

nanaya avatar Feb 09 '24 12:02 nanaya

the code and documentation for other endpoints are in the same repository whereas this one the code is in another castle

I will leave it to the other castle then to update the docs if it's more fitting there. If it happens, maybe put a note in osu-web docs that refers to it?

Feel free to close PR or keep it open as a reminder

HonKLam avatar Feb 09 '24 13:02 HonKLam

Will just close this for now.

peppy avatar Jun 12 '24 12:06 peppy