search

mastodon / documentation

Mastodon documentation
https://docs.joinmastodon.org
GNU Free Documentation License v1.3
1.71k stars 974 forks source link

currently undocumented #1211

Open trwnh opened 1 year ago

trwnh commented 1 year ago

webhooks

api

unreleased

things to test / document

env

tootctl

???

user guide

admin guide

project dev guide

client dev guide

technical

andypiper commented 11 months ago

@trwnh I started to check a few of these off based on some of the recent doc PRs (thinking the list items could be switched over to checklist items). Thanks for keeping this list here!

andypiper commented 11 months ago

Now switched to checklist format 👍🏻 just for convenience of checking things off as updates are merged.

ThisIsMissEm commented 6 months ago

FYI, I'm tracking all the unreleased OAuth changes in #1445

ThisIsMissEm commented 6 months ago

@colleenpridemore at the bottom of the email from github there's an unsubscribe link, or on web in the sidebar of this issue you can manage your subscription – I can't managed that for you

ThisIsMissEm commented 6 months ago

Docs for 4.3 Add digest to admin/domain_blocks https://github.com/mastodon/mastodon/pull/29092 are in https://github.com/mastodon/documentation/pull/1417 which is merged.

ThisIsMissEm commented 6 months ago

On 4.1.0 streaming/metrics, I've started docs here, since between 4.1.0 and now, we've switched Streaming to use the proper prometheus module: https://github.com/mastodon/documentation/pull/1213

I also have a grafana dashboard for Streaming metrics, but I don't know how to make this distributable; but that could go in dist/ in the main repo then

ThisIsMissEm commented 5 months ago

Another undocumented endpoint seems to be Api::V1::Timelines::LinkController at GET /api/v1/timelines/link

aaaaalbert commented 3 months ago

Since 325dc1fc036aff3d19491d326ee7bf0208ee5e3f, you may tick off CONTRIBUTING.md.

Reeceeboii commented 3 months ago

https://docs.joinmastodon.org/entities/Instance/#registrations

registrations[url] is currently undocumented (/app/serializers/rest/instance_serializer.rb#L106)

shuuji3 commented 3 months ago

For reference, the above registrations[url] was introduced by this PR: https://github.com/mastodon/mastodon/pull/25014

ThisIsMissEm commented 5 days ago

@trwnh we can remove all references to crypto from this todo list, as we completely removed crypto APIs for 4.3.0 — e.g., /api/v1/crypto (the scope has already been removed)

trwnh commented 5 days ago

@ThisIsMissEm there's only one reference and it's to note that it was added in 3.2.0 but commented out. i guess if we ever do document it we can then say it was removed entirely in 4.3.0? maybe just a link to the PR will suffice for interested people

ThisIsMissEm commented 5 days ago

@trwnh I would not bother documenting it: it was never used anywhere, never documented, never promoted, and I'm not sure if we even knew if it was feature complete?

trwnh commented 5 days ago

@ThisIsMissEm "documenting" in this case doesn't have to be full API docs, it could just be a one-line mention that this existed at some point even if never used. think of it as a sort of "historical footnote"

ThisIsMissEm commented 5 days ago

@trwnh yeah, and I'm saying that I don't think we even need that footnote for something that was never ready for use. No client support unless you somehow found it in the codebase, and even then it wasn't clear how you actually used it. Additionally adding it now may conflict with potential E2EE from the taskforce on that.

ThisIsMissEm commented 5 days ago

Maybe here we could add a line about deprecating that crypto scope though? https://docs.joinmastodon.org/api/oauth-scopes/#versions