clones/friendica
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

api docs: fix indentation

This commit is contained in:
Fabrixxm 2016-02-08 10:34:27 +01:00
parent 870d2f844d
commit a283691149
1 changed files with 66 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

132
doc/api.md
View File

@ -52,20 +52,20 @@ Error body is
json: json:
``` ```
{ {
"error": "Specific error message", "error": "Specific error message",
"request": "API path requested", "request": "API path requested",
"code": "HTTP error code" "code": "HTTP error code"
} }
``` ```
xml: xml:
``` ```
<status> <status>
<error>Specific error message</error> <error>Specific error message</error>
<request>API path requested</request> <request>API path requested</request>
<code>HTTP error code</code> <code>HTTP error code</code>
</status> </status>
``` ```
--- ---
@ -605,47 +605,47 @@ An image used as profile image has only scale 4-6, other images only 0-3
json json
``` ```
{ {
"id": "photo id" "id": "photo id"
"created": "date(YYYY-MM-GG HH:MM:SS)", "created": "date(YYYY-MM-GG HH:MM:SS)",
"edited": "date(YYYY-MM-GG HH:MM:SS)", "edited": "date(YYYY-MM-GG HH:MM:SS)",
"title": "photo title", "title": "photo title",
"desc": "photo description", "desc": "photo description",
"album": "album name", "album": "album name",
"filename": "original file name", "filename": "original file name",
"type": "mime type", "type": "mime type",
"height": "number", "height": "number",
"width": "number", "width": "number",
"profile": "1 if is profile photo", "profile": "1 if is profile photo",
"link": { "link": {
"<scale>": "url to image" "<scale>": "url to image"
... ...
}, },
// if 'scale' is set // if 'scale' is set
"datasize": "size in byte", "datasize": "size in byte",
"data": "base64 encoded image data" "data": "base64 encoded image data"
} }
``` ```
xml xml
``` ```
<photo> <photo>
<id>photo id</id> <id>photo id</id>
<created>date(YYYY-MM-GG HH:MM:SS)</created> <created>date(YYYY-MM-GG HH:MM:SS)</created>
<edited>date(YYYY-MM-GG HH:MM:SS)</edited> <edited>date(YYYY-MM-GG HH:MM:SS)</edited>
<title>photo title</title> <title>photo title</title>
<desc>photo description</desc> <desc>photo description</desc>
<album>album name</album> <album>album name</album>
<filename>original file name</filename> <filename>original file name</filename>
<type>mime type</type> <type>mime type</type>
<height>number</height> <height>number</height>
<width>number</width> <width>number</width>
<profile>1 if is profile photo</profile> <profile>1 if is profile photo</profile>
<links type="array"> <links type="array">
<link type="mime type" scale="scale number" href="image url"/> <link type="mime type" scale="scale number" href="image url"/>
... ...
</links> </links>
</photo> </photo>
``` ```
--- ---
@ -657,29 +657,29 @@ Returns a list of all photo resources of the logged in user.
json json
``` ```
[ [
{ {
id: "resource_id", id: "resource_id",
album: "album name", album: "album name",
filename: "original file name", filename: "original file name",
type: "image mime type", type: "image mime type",
thumb: "url to thumb sized image" thumb: "url to thumb sized image"
}, },
... ...
] ]
``` ```
xml xml
``` ```
<photos type="array"> <photos type="array">
<photo id="resource_id" <photo id="resource_id"
album="album name" album="album name"
filename="original file name" filename="original file name"
type="image mime type"> type="image mime type">
"url to thumb sized image" "url to thumb sized image"
</photo> </photo>
... ...
</photos> </photos>
``` ```