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

Updates limit Option for favourites #1086

Closed

Conversation

jswright61
Copy link

When exploring the API on ruby.social, I came across an inconsistency between the default parameter documented and the actual API call with that parameter omitted. I have updated the documentation to reflect what is actually occurring.

Note: one change highlighted below is a deletion of a trailing whitespace character. Since it seemed that the standard was to not have trailing whitespace at the ends of lines, I left that change in place.

Previously defaulted to 40, now defaults to 20.
Previously no max value stated, now states max value is 40.

Previously defaulted to 40, now defaults to 20.
Previously no max value stated, now states max value is 40.
@jswright61
Copy link
Author

I suspect that this is a common issue on many endpoints, I did not make further changes because I wanted to make sure the core team wanted this and similar changes before doing the work to explore where the limit parameter differs from the documentation and making those changes where appropriate.

@jswright61
Copy link
Author

I did look for community guidelines and steps for submitting PRs (I didn't look hard, but I did look) and didn't find them. I decided to submit this tiny PR.
I can close it and resubmit a new one according to guidelines if someone would kindly point them out.

@trwnh
Copy link
Member

trwnh commented Dec 7, 2022

I believe this is just a one-off mistake. The default statuses limit is 20. The default accounts limit is 40. Some other controllers have one-off limits. The maximum is twice the default limit.

Likely what happened was that the language for the limit parameter was copied around a lot and in this case it was copied from an accounts method to a statuses method.

In any case, I'll go back and verify all uses of the limit parameter based on whether they target accounts or statuses.

trwnh added a commit to trwnh/mastodocs that referenced this pull request Dec 7, 2022
@trwnh
Copy link
Member

trwnh commented Dec 7, 2022

Added to #1060

Gargron pushed a commit that referenced this pull request Dec 14, 2022
* fix relrefs around trends and related entities

* revert moving caption-links to middle of page

* hide empty menu in table of contents

* clarify edit notifs are only for boosted statuses

* following/followers no longer need auth

* fix typo

* specify cooldown period for account Move

* use the correct cooldown

* add missing parameters to accounts/id/statuses

* link to account_statuses_filter.rb

* fix typo (#1072)

* fix typo (#1073)

* fix link to http sig spec (#1067)

* simply HTTP request examples in api methods docs

* add missing client_secret to oauth/token (#1062)

* Add any, all, none to hashtag timeline

* minor formatting changes

* Update signature requirements and advice

* fix public key -> private key

* clarify use of RSA with SHA256

* Add note about saving your profile after adding rel-me link

* v2 filters api

* comment out params that shouldn't be used in v2 filter api

* admin trends

* remove old todo

* canonical email blocks + scheduled statuses

* remove under-construction warnings from finished pages

* verify api method params with source code

* fix typo (#1088)

* fix broken caption-links (#1100)

* fix formatting of entities (#1094)

* Remove keybase section from user guide (#1093)

* fix typos (#1092)

* Verify limits are accurate (#1086)

* add mention of iframe limitation (#1084)

* Add CORS header to WEB_DOMAIN example (#1083)

* Fix typo (#1081)

* pin http sigs spec at draft 8

* Revert "pin http sigs spec at draft 8"

This reverts commit 9fd5f70.

* add case sensitivity warning to 4.0 roles

* Add url length note to bio (#1087)

* remove follow scope from examples (#1103)

* clarify usage of update_credentials to update profile fields

* add noindex to Account entitity

* remove required hint from technically not required property
@trwnh trwnh mentioned this pull request Dec 16, 2022
@Gargron Gargron closed this in #1110 Feb 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants