[lxc-devel] [linuxcontainers.org/master] Update the LXD API page

[tenforward on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 370 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20160420/702e9372/attachment.bin>
-------------- next part --------------
From ccaeedad87f615094ab97e040aa0de91f6ddb159 Mon Sep 17 00:00:00 2001
From: KATOH Yasufumi <karma at jazz.email.ne.jp>
Date: Wed, 20 Apr 2016 19:04:36 +0900
Subject: [PATCH] Update the LXD API page

Signed-off-by: KATOH Yasufumi <karma at jazz.email.ne.jp>
---
 content/lxd/rest-api.ja.md | 37 ++++++++++++++++++++++++++++++++-----
 1 file changed, 32 insertions(+), 5 deletions(-)

diff --git a/content/lxd/rest-api.ja.md b/content/lxd/rest-api.ja.md
index a1ed8d0..78be23c 100644
--- a/content/lxd/rest-api.ja.md
+++ b/content/lxd/rest-api.ja.md
@@ -1,12 +1,39 @@
-# 開発初期 <!-- The early days -->
+![Logo](/static/img/containers.png)
+
+# LXD の API <!-- The LXD API -->
 
 <!--
-LXD is still under very active development, so its REST API isn't stable yet.
+LXD currently only implements a single version of the API, called "1.0".
 -->
-LXD はまだ非常に活発に開発されている途中で、REST API は stable ではありません。
+LXD では、現時点で "1.0" と呼ばれる単一のバージョンの API のみが実装されています。
 
 <!--
-The current API design can be found here:
+Details on that API can be found at:  
+[https://github.com/lxc/lxd/blob/master/doc/rest-api.md](https://github.com/lxc/lxd/blob/master/doc/rest-api.md)
 -->
-最新の API の設計は以下でご覧いただけます:  
+API の詳細は以下でご覧いただけます:
 [https://github.com/lxc/lxd/blob/master/doc/rest-api.md](https://github.com/lxc/lxd/blob/master/doc/rest-api.md)
+
+## API の後方互換性 <!-- API backward compatibility -->
+
+<!--
+Once an API is marked as "stable", as is the case with the 1.0 API. We commit not to do any backward incompatible changes to it.  
+We will however make API additions which will be accompanied by an identifier which newer clients can look for.
+-->
+1.0 API のように、一度 API が "stable" とマークされた時点で、それに対する後方互換性を壊す変更をしないことを約束します。
+しかし、API の追加は行うかもしれません。その場合、新しいクライアントが追加がわかるような識別子の追加を行うでしょう。
+
+<!--
+This means that newer clients can detect whether a given target server supports the new feature and only use it if it does.
+-->
+これは、新しいクライアントは、ターゲットとなるサーバが新しい機能をサポートしているかどうかを検出でき、新しい機能が使える場合だけその機能を使うことを意味します。
+
+## API クライアント <!-- API clients -->
+
+<!--
+The following API clients have been submitted by third-party contributors.  They
+are neither supported nor endorsed by the LXD project.
+-->
+以下の API クライアントはサードパーティのコントリビュータが提供しているものです。これらは LXD プロジェクトがサポートしているわけでも、承認しているわけでもありません。
+
+* Ruby: [Hyperkit](http://jeffshantz.github.io/hyperkit)