ここの情報は古いです。ご理解頂いた上でお取り扱いください。

Changeset 12971


Ignore:
Timestamp:
Oct 5, 2009, 7:52:24 PM (13 years ago)
Author:
ebihara
Message:

translated community_topic_api

Location:
OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs/community_topic_api.rst

    r12885 r12971  
    1 =================================================
    2 コミュニティトピックに関する API (communityTopic)
    3 =================================================
     1=======================
     2API for Community Topic
     3=======================
    44
    5 利用可能な機能
    6 ==============
     5Available Features
     6==================
    77
    88.. toctree::
     
    1515   community_topic_api/delete_resource
    1616
    17 エントリポイント
    18 ================
     17Entry Point
     18===========
    1919
    20 コレクション URI
    21     http://example.com/api.php/feeds/communityTopic/community/{コミュニティのID}
     20Collection URI
     21    http://example.com/api.php/feeds/communityTopic/community/{ID of the community}
    2222
    23 メンバ URI
    24     http://example.com/api.php/feeds/communityTopic/{コミュニティトピックのID}
     23Member URI
     24    http://example.com/api.php/feeds/communityTopic/{ID of the community topic}
    2525
    26 エントリ文書の書式
    27 ==================
     26Format of Entry Document
     27========================
    2828
    29 コミュニティトピックのエントリは以下のような Atom エントリ文書で表現されます。
     29An entry for a community topic is described like the following Atom Entry Document:
    3030
    3131::
     
    3636    <published>2009-01-25T19:40:22+09:00</published>
    3737    <updated>2009-01-25T19:40:22+09:00</updated>
    38     <title type="text">コミュニティトピックタイトル</title>
    39     <content type="text">コミュニティトピック本文</content>
     38    <title type="text">Title</title>
     39    <content type="text">Body</content>
    4040    <author>
    41       <name>投稿したメンバーのニックネーム</name>
     41      <name>Nickname of Author</name>
    4242      <uri>http://example.com/member/{member_id}</uri>
    4343    </author>
     
    4848  </entry>
    4949
    50 このエントリに含まれる要素の解説を以下に示します。
     50The following is explaining for items in this entry.
    5151
    52  * /entry/id : エントリを識別するための ID となる URN (省略可)
    53  * /entry/published : エントリの作成日時 (省略可)
    54  * /entry/updated : エントリの更新日時 (省略可)
    55  * /entry/title : エントリのタイトル
    56  * /entry/content : エントリの本文
    57  * /entry/author : エントリの作成者の情報
    58     * /entry/author/name : エントリの作成者のニックネーム
    59     * /entry/auhtor/uri : エントリの作成者を識別するための URN
    60  * /entry/link[@rel="edit"] : OpenPNE Web API でこのエントリを編集するための URI (省略可)
    61  * /entry/link[@rel="self"] : OpenPNE Web API でこのエントリを参照するための URI (省略可)
    62  * /entry/link[@rel="alternate" and @type="text/html"] : PC 版でこのエントリを閲覧するための URL (省略可)
    63  * /entry/link[@rel="alternate" and not(@type)] : 携帯版でこのエントリを閲覧するための URL (省略可)
     52 * /entry/id : URN as ID for identifying the entry (optional)
     53 * /entry/published : Created date of the entry (optonal)
     54 * /entry/updated : Updated date of the entry (optional)
     55 * /entry/title : Title of the entry
     56 * /entry/content : Body of the entry
     57 * /entry/author : Informations about author of this community
     58    * /entry/author/name : Nickname
     59    * /entry/auhtor/uri : URN
     60 * /entry/link[@rel="edit"]/@href : URI for editing via OpenPNE Web API (optional)
     61 * /entry/link[@rel="self"]/@href : URI for accessing via OpenPNE Web API (optional)
     62 * /entry/link[@rel="alternate" and @type="text/html"]/@href : URI for accessing via PC (optional)
     63 * /entry/link[@rel="alternate" and not(@type)]/@href : URI for accessing via mobile (optional)
     64 * /entry/link[@rel="enclosure"]/@href : An image of the entry (optional)
    6465
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs/community_topic_api/delete_resource.rst

    r12888 r12971  
    11.. _community_topic_api_delete_resource:
    22
    3 ====================================
    4 コミュニティトピック::エントリの削除
    5 ====================================
     3===================
     4Diary::Delete Entry
     5===================
    66
    7 リクエスト
    8 ==========
     7Request
     8=======
    99
    10 リクエストの方法
    11 ----------------
     10The Way to Request
     11------------------
    1212
    13 メンバ URI に対して DELETE リクエストをおこなう。
     13Do DELETE to Member URI.
    1414
    1515::
     
    1818  Host: example.com
    1919
    20 リクエストパラメータ
    21 --------------------
     20Request Parameter
     21-----------------
    2222
    23 なし
     23None
    2424
    25 レスポンス
    26 ==========
     25Response
     26========
    2727
    28 レスポンスヘッダ
    29 ----------------
     28Response Header
     29---------------
    3030
    31 HTTPステータスコード 200 を返す。
     31Returns HTTP Status Code 200.
    3232
    3333::
     
    3535  HTTP/1.1 200 Ok
    3636
    37 レスポンス本文
    38 --------------
     37Response Body
     38-------------
    3939
    40 なし
     40None
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs/community_topic_api/get_feed.rst

    r12888 r12971  
    11.. _community_topic_api_get_feed:
    22
    3 ==========================================
    4 コミュニティトピック::エントリの一覧の取得
    5 ==========================================
     3============================
     4Community Topic::Get Entries
     5============================
    66
    7 リクエスト
    8 ==========
     7Request
     8=======
    99
    10 リクエストの方法
    11 ----------------
     10The Way to Request
     11------------------
    1212
    13 コレクション URI に対して GET リクエストをおこなう。
     13Do GET to Collection URI.
    1414
    1515::
     
    1818  Host: example.com
    1919
    20 リクエストパラメータ
    21 --------------------
     20Request Parameter
     21-----------------
    2222
    2323* :ref:`q <search-query>` (optional)
     
    3131* :ref:`sortorder <sortorder-query>` (optional)
    3232
    33 レスポンス
    34 ==========
     33Response
     34========
    3535
    36 レスポンスヘッダ
    37 ----------------
     36Response Header
     37---------------
    3838
    39 HTTPステータスコード 200 を返す。
     39Returns HTTP Status Code 200.
    4040
    4141::
     
    4444  Content-Type: application/atom+xml; charset=utf-8
    4545
    46 レスポンス本文
    47 --------------
     46Response Body
     47-------------
    4848
    49 XML 文書を返す。取得した件数分 entry 要素を格納する。
     49Returns XML Document. It has entries.
    5050
    5151::
     
    5454  <feed xmlns="http://www.w3.org/2005/Atom"
    5555          xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/">
    56     <title>コミュニティタイトル</title>
     56    <title>Title</title>
    5757    <id>http://example.com/community/{community_id}</id>
    5858    <updated>2009-01-28T11:23:55+09:00</updated>
     
    6161    <link rel="alternate" type="text/html" href="http://example.com/community/{community_id}"/>
    6262    <link rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml" href="http://example.com/api.php/feeds/communityTopic/community/{community_id}"/>
    63     <openSearch:totalResults>総件数</openSearch:totalResults>
    64     <openSearch:startIndex>取得を開始したエントリの番号</openSearch:startIndex>
    65     <openSearch:itemsPerPage>1ページあたりの件数</openSearch:itemsPerPage>
     63    <openSearch:totalResults>Maximum Number of Results</openSearch:totalResults>
     64    <openSearch:startIndex>Starting Index of Entry</openSearch:startIndex>
     65    <openSearch:itemsPerPage>Number of per a Page</openSearch:itemsPerPage>
    6666    <entry>
    6767      <id>http://example.com/communityTopic/{community_topic_id}</id>
    6868      <published>2009-01-28T11:23:55+09:00</published>
    6969      <updated>2009-01-28T11:23:55+09:00</updated>
    70       <title type="text">コミュニティトピックタイトル</title>
    71       <content type="text">コミュニティトピック本文</content>
     70      <title type="text">Title</title>
     71      <content type="text">Body</content>
    7272      <author>
    73         <name>投稿したメンバーのニックネーム</name>
     73        <name>Nickname of Author</name>
    7474        <uri>http://example.com/member/{member_id}</uri>
    7575      </author>
     
    8383      <published>2009-01-28T11:23:55+09:00</published>
    8484      <updated>2009-01-28T11:23:55+09:00</updated>
    85       <title type="text">コミュニティトピックタイトル</title>
    86       <content type="text">コミュニティトピック本文</content>
     85      <title type="text">Title</title>
     86      <content type="text">Body</content>
    8787      <author>
    88         <name>投稿したメンバーのニックネーム</name>
     88        <name>Nickname of Author</name>
    8989        <uri>http://example.com/member/{member_id}</uri>
    9090      </author>
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs/community_topic_api/get_resource.rst

    r12888 r12971  
    11.. _community_topic_api_get_resource:
    22
    3 ====================================
    4 コミュニティトピック::エントリの取得
    5 ====================================
     3==========================
     4Community Topic::Get Entry
     5==========================
    66
    7 リクエスト
    8 ==========
     7Request
     8=======
    99
    10 リクエストの方法
    11 ----------------
     10The Way to Request
     11------------------
    1212
    13 メンバ URI に対して GET リクエストをおこなう。
     13Do GET to Member URI.
    1414
    1515::
     
    1818  Host: example.com
    1919
    20 リクエストパラメータ
    21 --------------------
     20Request Parameter
     21-----------------
    2222
    23 なし
     23None
    2424
    25 レスポンス
    26 ==========
     25Response
     26========
    2727
    28 レスポンスヘッダ
    29 ----------------
     28Response Header
     29---------------
    3030
    31 HTTPステータスコード 200 を返す。
     31Returns HTTP Status Code 200.
    3232
    3333::
     
    3636  Content-Type: application/atom+xml; charset=utf-8
    3737
    38 レスポンス本文
    39 --------------
     38Response Body
     39-------------
    4040
    41 XML 文書を返す。
     41Returns XML Document.
    4242
    4343::
     
    4848    <published>2009-01-25T19:40:22+09:00</published>
    4949    <updated>2009-01-25T19:40:22+09:00</updated>
    50     <title type="text">コミュニティトピックタイトル</title>
    51     <content type="text">コミュニティトピック本文</content>
     50    <title type="text">Title</title>
     51    <content type="text">Body</content>
    5252    <author>
    53       <name>投稿したメンバーのニックネーム</name>
     53      <name>Nickname of Author</name>
    5454      <uri>http://example.com/member/{member_id}</uri>
    5555    </author>
     
    5959    <link rel="alternate" href="http://example.com/mobile_frontend.php/communityTopic/{community_topic_id}"/>
    6060  </entry>
    61 
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs/community_topic_api/post_resource.rst

    r12888 r12971  
    11.. _community_topic_api_post_resource:
    22
    3 ====================================
    4 コミュニティトピック::エントリの追加
    5 ====================================
     3===========================
     4Community Topic::Post Entry
     5===========================
    66
    7 リクエスト
    8 ==========
     7Request
     8=======
    99
    10 リクエストの方法
    11 ----------------
     10The Way to Request
     11------------------
    1212
    13 コレクション URI に対して POST リクエストをおこなう。
     13Do POST to Collection URI.
    1414
    1515::
     
    1919  Content-Type: application/atom+xml; charset=utf-8
    2020
    21 リクエストパラメータ
    22 --------------------
     21Request Parameter
     22-----------------
    2323
    24 なし
     24None
    2525
    26 リクエスト本文
    27 --------------
     26Request Body
     27------------
    2828
    29 以下のサンプルに登場する要素をすべて含めた XML 文書である必要がある。
     29It must be a XML Document that contains all of element in the following example.
    3030
    3131::
     
    3333  <?xml version="1.0" encoding="UTF-8" ?>
    3434  <entry xmlns="http://www.w3.org/2005/Atom">
    35     <title type="text">コミュニティトピックタイトル</title>
    36     <content type="text">コミュニティトピック本文</content>
     35    <title type="text">Title</title>
     36    <content type="text">Body</content>
    3737    <author>
    38       <name>投稿するメンバーのニックネーム</name>
     38      <name>Nickname of Author</name>
    3939      <uri>http://example.com/member/{member_id}</uri>
    4040    </author>
    4141  </entry>
    4242
     43Response
     44========
    4345
    44 レスポンス
    45 ==========
     46Response Header
     47---------------
    4648
    47 レスポンスヘッダ
    48 ----------------
     49Returns HTTP Status Code 201.
    4950
    50 HTTPステータスコード 201 を返す。
    51 
    52 Location ヘッダには、新しく作成されたリソースのメンバ URI が含まれる。
     51The Location Header contains Member URI for new resource.
    5352
    5453::
    5554
    5655  HTTP/1.1 201 Created
    57   Location: http://example.com/api.php/feeds/communityTopic/{community_topic_id}
     56  Location: http://example.com/api.php/feeds/diary/{diary_id}
    5857  Content-Type: application/atom+xml; charset=utf-8
    5958
    60 レスポンス本文
    61 --------------
     59Response Body
     60-------------
    6261
    63 XML 文書を返す。
     62Returns XML Document.
    6463
    6564::
     
    7069    <published>2009-01-25T19:40:22+09:00</published>
    7170    <updated>2009-01-25T19:40:22+09:00</updated>
    72     <title type="text">コミュニティトピックタイトル</title>
    73     <content type="text">コミュニティトピック本文</content>
     71    <title type="text">Title</title>
     72    <content type="text">Body</content>
    7473    <author>
    75       <name>投稿したメンバーのニックネーム</name>
     74      <name>Nickname of Author</name>
    7675      <uri>http://example.com/member/{member_id}</uri>
    7776    </author>
     
    8180    <link rel="alternate" href="http://example.com/mobile_frontend.php/communityTopic/{community_topic_id}"/>
    8281  </entry>
    83 
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/en/docs/community_topic_api/put_resource.rst

    r12888 r12971  
    11.. _community_topic_api_put_resource:
    22
    3 ====================================
    4 コミュニティトピック::エントリの更新
    5 ====================================
     3==========================
     4Community Topic::Put Entry
     5==========================
    66
    7 リクエスト
    8 ==========
     7Request
     8=======
    99
    10 リクエストの方法
    11 ----------------
     10The Way to Request
     11------------------
    1212
    13 メンバ URI に対して PUT リクエストをおこなう。
     13Do PUT to Member URI.
    1414
    1515::
     
    1919  Content-Type: application/atom+xml; charset=utf-8
    2020
    21 リクエストパラメータ
    22 --------------------
     21Request Parameter
     22-----------------
    2323
    24 なし
     24None
    2525
    26 リクエスト本文
    27 --------------
     26Request Body
     27------------
    2828
    29 以下のサンプルに登場する要素をすべて含めた XML 文書である必要がある。
     29It must be a XML Document that contains all of element in the following example.
    3030
    3131::
     
    3434  <entry xmlns="http://www.w3.org/2005/Atom">
    3535    <id>http://example.com/communityTopic/{community_topic_id}</id>
    36     <title type="text">コミュニティトピックタイトル</title>
    37     <content type="text">コミュニティトピック本文</content>
     36    <title type="text">Title</title>
     37    <content type="text">Body</content>
    3838    <author>
    39       <name>メンバーのニックネーム</name>
     39      <name>Nickname of Author</name>
    4040      <uri>http://example.com/member/{member_id}</uri>
    4141    </author>
    4242  </entry>
    4343
    44 レスポンス
    45 ==========
     44Response
     45========
    4646
    47 レスポンスヘッダ
    48 ----------------
     47Response Header
     48---------------
    4949
    50 HTTPステータスコード 200 を返す。
     50Returns HTTP Status Code 200.
    5151
    5252::
     
    5555  Content-Type: application/atom+xml; charset=utf-8
    5656
    57 レスポンス本文
    58 --------------
     57Response Body
     58-------------
    5959
    60 XML 文書を返す。
     60Returns XML Document.
    6161
    6262::
     
    6767    <published>2009-01-25T19:40:22+09:00</published>
    6868    <updated>2009-01-25T19:40:22+09:00</updated>
    69     <title type="text">コミュニティトピックタイトル</title>
    70     <content type="text">コミュニティトピック本文</content>
     69    <title type="text">Title</title>
     70    <content type="text">Body</content>
    7171    <author>
    72       <name>投稿したメンバーのニックネーム</name>
     72      <name>Nickname of Author</name>
    7373      <uri>http://example.com/member/{member_id}</uri>
    7474    </author>
Note: See TracChangeset for help on using the changeset viewer.