zelo72
/
documentation
mirror of https://github.com/mastodon/documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity
937 Commits 9 Branches 11 Tags 58 MiB
Commit Graph

115 Commits

Author SHA1 Message Date
tateisu b0951be2f7 (API) profile metadata fields (#611) 
* add fields_attributes in /api/v1/accounts/update_credentials

* add fields in Accounts and verify_credentials

* add fields in Accounts and verify_credentials

* add fields in Accounts and verify_credentials
 2018-05-15 11:30:27 +02:00
Mike Burns bca5452970 The only_media query param is public and tag only (#599) 
Per [a discussion elsewhere], the `only_media` query param does not work
on the home timeline API.

[a discussion elsewhere]: https://github.com/tootsuite/mastodon/issues/6603#issuecomment-383099654
 2018-04-22 19:32:00 +02:00
codl c2e5d5d665 document idempotency-key header (#581) 2018-03-25 19:33:13 +02:00
Eugen Rochko fde17f034a
Update API docs in preparation for 2.3.0 (#563) 2018-03-09 13:30:07 +01:00
Thomas 461a176035 Adds following parameter in /accounts/search (#518) 
`following` parameter allows to search users for adding them to a list.
 2018-01-13 19:07:54 +01:00
Ornithologist Coder cc78b4a90c Fixes typo (Lists -> List) (#510) 2018-01-02 20:07:28 +01:00
Ornithologist Coder ab91b5b072 Moves List and Lists around (#509) 
* Moves List and Lists around

to keep methods and entities sorted alphabetically.

* Updates Lists descriptions
 2018-01-02 19:41:31 +01:00
Ornithologist Coder a02f68e765 Moves Custom Emojis do Instances (#507) 
* Moves Emojis to own section

Since they're not part of the `/api/v1/status*` family.

* Moves to Custom Emojis to Instances
 2018-01-01 20:37:21 +01:00
Ornithologist Coder 615aba5697 Updates Status.emojis information (#508) 
`emojis` is not nullable. Instead, it returns an empty array
when no emojis are used.

```
"emojis": []
```
 2018-01-01 20:36:59 +01:00
nightpool 996878c5be add description of form-data uploades (#496) 
this glosses over the use of data or external uris with paperclip because it's kind of complicated and I don't have the best handle on the edge-cases, but I can take a look at that if it seems useful.
 2017-12-22 14:34:12 +01:00
s e8ba704983 Update API.md with some missing response fields (#495) 
* Update API.md with some missing response fields

* A few additional clarifications in API.md
 2017-12-22 00:14:45 -06:00
Thomas c4652e6193 Update API.md (#490) 
Update Relationship entity with the attribute "muting_notifications"
 2017-12-17 15:08:30 +01:00
Thomas 152d4045f2 Update API.md (#489) 
Update mute call with the parameter 'notifications'
 2017-12-17 15:08:21 +01:00
Thomas 8cd6b13533 Update API.md (#488) 
Replace the attribute "moved_to_account" by "moved" in the entity Account
 2017-12-17 15:07:59 +01:00
Lorenz Diener 9b09bdf9f8 Fix /api/v1/accounts/:id/lists docs (#484) 2017-12-13 20:34:31 +01:00
Eugen Rochko 4b8f6e1726
Update API.md 2017-12-13 15:43:16 +01:00
Eugen Rochko 4bb149c73f
Add information about new APIs in 2.1 2017-12-13 15:12:12 +01:00
Thomas 2480655d4f Update API.md (#468) 
Fetching custom emoji for an instance
 2017-11-29 16:09:56 +01:00
lambadalambda 63d7897f9b
Fix reblog documentation bug 
Reblogging returns the reblog, not the target status.
 2017-11-13 09:45:36 +01:00
roikale b798364d82 Document return value of updating credentials (#448) 2017-11-10 16:55:46 +01:00
Thomas d406335309 Update API.md (#444) 
Adds methods to pin/unpin a status
 2017-11-08 15:21:26 +01:00
Thomas 25205f4a42 Update API.md (#443) 
Adds "pinned" parameter in GET /api/v1/accounts/:id/statuses
 2017-11-08 15:21:02 +01:00
Thomas 7c05a8eee5 Update API.md (#442) 
Updates "Fetching a user's notifications":
Introduces the array parameter "exclude_types" which allows to filter notifications by its types (ie: "follow", "favourite", "reblog", "mention")
 2017-11-07 15:26:26 +01:00
moko256 a0f77af200 Add document of emoji 2017-10-20 23:51:22 +09:00
Akira 53f52cdddc Add reference to Array. (#370) 
Array for query parameter is now used only for this method, and I missed this explanation.
So this link may be helpful.
 2017-09-21 04:19:47 +02:00
Alex Schroeder 2c4c2abadc Clarify how sensitive and spoiler_text are related (#378) 2017-09-21 04:15:37 +02:00
Alex Schroeder cdb2316ec3 Clarify what domain_blocking means (#368) 2017-09-19 16:38:01 +02:00
Akira b9a2914e8d update API (#389) 
* update API

Since #4833, /api/v1/reports.comment is limited to 1000 characters.

* Update API.md
 2017-09-19 16:30:58 +02:00
stom79 5457849bac Update API.md (#359) 2017-07-30 12:53:07 +02:00
Eugen Rochko 4487f6017e Update API documentation 
Fix #336 - Add conversation mute/unmute docs
 2017-07-29 22:01:21 +02:00
Alex Schroeder a6e51236ba API.md: fix link to named anchor (#345) 
Use #relationship instead of #relationships.
 2017-07-25 16:47:29 +02:00
ティン・ルーフ 5f5292f5d3 don't encourage people to use base64 avatar and header image uploads 
a potential resolution to tootsuite/mastodon#3804, achieved by not
encouraging people to use upload methods without filenames

my rationale for this being the right solution is that it brings it to
parity with the media upload method, which has already proven to be
enough for library developers to understand. it should be enough that,
early in the docs, it says that 'When a file parameter is mentioned, a
form-encoded upload is expected.'

i wouldn't mind so much if the base64 upload method didn't expose such
an insidious bug, but even if it didn't, it seems reasonable to want to
encourage developers to upload all media in a consistent way
 2017-06-18 13:28:46 +01:00
Moritz Manner 9c35223837 fixed typo in API documentation 2017-06-14 17:15:28 +02:00
happycoloredbanana 48e893e5a0 fix max_id description 2017-06-05 00:24:28 +03:00
Ornithologist Coder cefb4b2f4c Removes id parameter from documentation 
`id` is neither a query item (GET) nor part of the body (POST), therefore should not be in the parameter table.
 2017-06-02 17:08:59 +02:00
Eugen Rochko c7fc284a44 Revert documentation for unfinished feature 2017-06-02 14:00:28 +02:00
Eugen Rochko 8b5d2ba471 Fix API docs by adding missing attributes and methods, fix example 
nginx config by removing overly specific configuration options
that confuse more than they help
 2017-05-26 17:29:47 +02:00
Ornithologist Coder d7b090f0af Adds notifications/dismiss/:id (Fixes #265) 
@Kimik0 noticed the endpoint was missing. Read more about it here #265
 2017-05-25 17:46:01 +02:00
Eugen Rochko 998efd960a Merge pull request #264 from ornithocoder/patch-2 
Adds language to Status
 2017-05-25 14:24:14 +02:00
Ornithologist Coder 0854f0f365 Adds language to Status 
Based on:

* #1772
* #3209
 2017-05-25 10:31:17 +02:00
Ornithologist Coder 390f2a747f Reflects the latest API version 
The API.md document should reflect the currently API version and, for the current version, Mastodon's version is always present. Therefore, the version attribute it's not nullable.
 2017-05-25 09:04:29 +02:00
Michael Smith 2e99c08902 Document "mute boosts" functionality (#260) 2017-05-24 23:50:16 +02:00
happycoloredbanana 82bd43c03d Fix optionality of resolve 2017-05-20 11:31:40 +03:00
Ornithologist Coder 9210f6de9f Moves libraries to a separate file (#229) 2017-05-10 23:35:12 -07:00
Valerii Hiora 7dfe07e07c Fixed nullability for `Attachment.text_url` (#238) 
`text_url` can be `null` for remote images
 2017-05-10 15:34:52 +02:00
Ornithologist Coder 87550bdc7c Changes on ruby arrays as parameters (#226) 2017-05-09 14:14:33 +02:00
Ornithologist Coder 08eb89f04b Adds nullability description to Entities section (#227) 
* Adds nullability description to Entities section

* fix typo
 2017-05-09 10:00:01 +02:00
Ornithologist Coder fb31b2a7c5 s/Javascript/JavaScript/g (#225) 2017-05-09 00:46:56 -07:00
Ornithologist Coder 1591adb863 Adds nullability information to entities (#189) 
It helps developers building applications and libraries.
 2017-05-08 17:45:42 -07:00
Aaron Power 9e88129b92 Added mastodon account to Mammut (#191) 2017-05-08 14:30:52 -07:00