Skip to content
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

currently undocumented #1211

Open
5 of 79 tasks
trwnh opened this issue Apr 30, 2023 · 16 comments
Open
5 of 79 tasks

currently undocumented #1211

trwnh opened this issue Apr 30, 2023 · 16 comments
Labels
API The Mastodon core API help wanted

Comments

@trwnh
Copy link
Member

trwnh commented Apr 30, 2023

webhooks

api

unreleased

things to test / document

env

tootctl

???

  • 3.3.0 object storage failure now returns 503 in some API methods
  • 3.2.0 /api/v1/crypto added but commented out
    • 4.3.0 removed entirely

user guide

  • "lock account" is now "require follow requests"
  • "list this account on the directory" is now "suggest account to others"
  • "hide your network" is now "hide your social graph"
  • change order of dropdown menu on posts to be more intuitive in web UI
  • change option labels on edit profile page
  • change max image dimensions (previously 1280px square, then 1920x1080 unless Change image matrix size limit from 1920×1080px to 4096×4096px mastodon#23322 is merged, but then Change media upload limits and remove client-side resizing mastodon#23726 got merged)
  • can now upload webp, wave, avif, heic
  • custom emoji limit raised from 50kb to 256kb
  • authentication history
  • automatically delete old posts
  • filter search results by author, using from: syntax
  • hint about missing media attachment descriptions
  • timed mutes
  • private boosts
  • explore page
  • relationship manager
  • hashtag normalization
  • full text search params
  • attribution domains

admin guide

project dev guide

client dev guide

technical

@andypiper andypiper added help wanted API The Mastodon core API labels Jun 11, 2023
@andypiper
Copy link
Member

@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 andypiper pinned this issue Dec 11, 2023
@andypiper
Copy link
Member

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

@ThisIsMissEm
Copy link
Contributor

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

@ThisIsMissEm
Copy link
Contributor

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

Docs for 4.3 Add digest to admin/domain_blocks mastodon/mastodon#29092 are in #1417 which is merged.

@ThisIsMissEm
Copy link
Contributor

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: #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
Copy link
Contributor

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

@aaaaalbert
Copy link
Contributor

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

@Reeceeboii
Copy link

@shuuji3
Copy link

shuuji3 commented Aug 24, 2024

For reference, the above registrations[url] was introduced by this PR: mastodon/mastodon#25014

@ThisIsMissEm
Copy link
Contributor

@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
Copy link
Member Author

trwnh commented Nov 17, 2024

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

@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
Copy link
Member Author

trwnh commented Nov 17, 2024

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

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API The Mastodon core API help wanted
Projects
None yet
Development

No branches or pull requests

6 participants