Skip to content

Commit 9c92355

Browse files
author
Kevin Harper
committed
first draft of REST docs
1 parent f303ee0 commit 9c92355

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+371
-107
lines changed

‎schemas/latest.json

+1
Large diffs are not rendered by default.

‎swagger/css/print.css

100644100755
+4-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
.swagger-section pre .vhdl .attribute,
8383
.swagger-section pre .clojure .attribute,
8484
.swagger-section pre .coffeescript .property {
85-
color: #8888ff;
85+
color: #88F;
8686
}
8787
.swagger-section pre .keyword,
8888
.swagger-section pre .id,
@@ -807,6 +807,9 @@
807807
outline: 2px solid black;
808808
outline-color: #cc0000;
809809
}
810+
.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content form select[name='parameterContentType'] {
811+
max-width: 300px;
812+
}
810813
.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.response div.block pre {
811814
font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace;
812815
padding: 10px;

‎swagger/css/reset.css

100644100755
File mode changed.

‎swagger/css/screen.css

100644100755
+8-5
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
.swagger-section pre .vhdl .attribute,
8383
.swagger-section pre .clojure .attribute,
8484
.swagger-section pre .coffeescript .property {
85-
color: #8888ff;
85+
color: #88F;
8686
}
8787
.swagger-section pre .keyword,
8888
.swagger-section pre .id,
@@ -674,7 +674,7 @@
674674
font-weight: bold;
675675
}
676676
.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 a {
677-
color: #999999;
677+
color: #ef672f;
678678
}
679679
.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 a:hover {
680680
color: black;
@@ -807,6 +807,9 @@
807807
outline: 2px solid black;
808808
outline-color: #cc0000;
809809
}
810+
.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content form select[name='parameterContentType'] {
811+
max-width: 300px;
812+
}
810813
.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.response div.block pre {
811814
font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace;
812815
padding: 10px;
@@ -1216,14 +1219,14 @@
12161219
cursor: pointer;
12171220
}
12181221
.swagger-section #header {
1219-
background-color: #89bf04;
1222+
background-color: #ef672f;
12201223
padding: 14px;
12211224
}
12221225
.swagger-section #header a#logo {
12231226
font-size: 1.5em;
12241227
font-weight: bold;
12251228
text-decoration: none;
1226-
background: transparent url(../images/logo_small.png) no-repeat left center;
1229+
background: transparent url(../images/magento_32.png) no-repeat left center;
12271230
padding: 20px 0 20px 40px;
12281231
color: white;
12291232
}
@@ -1251,7 +1254,7 @@
12511254
padding: 6px 8px;
12521255
font-size: 0.9em;
12531256
color: white;
1254-
background-color: #547f00;
1257+
background-color: #bf5225;
12551258
-moz-border-radius: 4px;
12561259
-webkit-border-radius: 4px;
12571260
-o-border-radius: 4px;

‎swagger/css/style.css

100644100755
File mode changed.

‎swagger/css/typography.css

100644100755
File mode changed.

‎swagger/fonts/droid-sans-v6-latin-700.eot

100644100755
File mode changed.

‎swagger/fonts/droid-sans-v6-latin-700.svg

100644100755
File mode changed.

‎swagger/fonts/droid-sans-v6-latin-700.ttf

100644100755
File mode changed.

‎swagger/fonts/droid-sans-v6-latin-700.woff

100644100755
File mode changed.

‎swagger/fonts/droid-sans-v6-latin-700.woff2

100644100755
File mode changed.

‎swagger/fonts/droid-sans-v6-latin-regular.eot

100644100755
File mode changed.

‎swagger/fonts/droid-sans-v6-latin-regular.svg

100644100755
File mode changed.

‎swagger/fonts/droid-sans-v6-latin-regular.ttf

100644100755
File mode changed.

‎swagger/fonts/droid-sans-v6-latin-regular.woff

100644100755
File mode changed.

‎swagger/fonts/droid-sans-v6-latin-regular.woff2

100644100755
File mode changed.

‎swagger/images/explorer_icons.png

100644100755
File mode changed.

‎swagger/images/logo_small.png

100644100755
File mode changed.

‎swagger/images/magento_32.png

4.14 KB

‎swagger/images/pet_store_api.png

100644100755
File mode changed.

‎swagger/images/throbber.gif

100644100755
File mode changed.

‎swagger/images/wordnik_api.png

100644100755
File mode changed.

‎swagger/index.html

+11-6
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22
<html>
33
<head>
44
<meta charset="UTF-8">
5-
<title>Swagger UI</title>
5+
<title>Magento REST API documentation</title>
6+
7+
<link rel="icon" type="image/png" href="images/magento.png" />
8+
9+
<!--
610
<link rel="icon" type="image/png" href="images/favicon-32x32.png" sizes="32x32" />
7-
<link rel="icon" type="image/png" href="images/favicon-16x16.png" sizes="16x16" />
11+
<link rel="icon" type="image/png" href="images/favicon-16x16.png" sizes="16x16" /> -->
12+
813
<link href='css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
914
<link href='css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
1015
<link href='css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
@@ -33,7 +38,7 @@
3338
if (url && url.length > 1) {
3439
url = decodeURIComponent(url[1]);
3540
} else {
36-
url = "http://petstore.swagger.io/v2/swagger.json";
41+
url = "http://localhost:4000/swagger/schemas/latest.json";
3742
}
3843

3944
// Pre load translate...
@@ -104,10 +109,10 @@
104109
<body class="swagger-section">
105110
<div id='header'>
106111
<div class="swagger-ui-wrap">
107-
<a id="logo" href="http://swagger.io">swagger</a>
112+
<a id="logo" href="http://devdocs.magento.com/guides/v2.0/rest/bk-rest.html">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;REST APIs</a>
108113
<form id='api_selector'>
109-
<div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"/></div>
110-
<div class='input'><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"/></div>
114+
<div class='input'><input placeholder="http://devdocs.magento.com/swagger/schemas/latest.json" id="input_baseUrl" name="baseUrl" type="text"/></div>
115+
<!-- <div class='input'><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"/></div> -->
111116
<div class='input'><a id="explore" href="#" data-sw-translate>Explore</a></div>
112117
</form>
113118
</div>

‎swagger/lang/en.js

100644100755
File mode changed.

‎swagger/lang/es.js

100644100755
File mode changed.

‎swagger/lang/ja.js

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
'use strict';
2+
3+
/* jshint quotmark: double */
4+
window.SwaggerTranslator.learn({
5+
"Warning: Deprecated":"警告: 廃止予定",
6+
"Implementation Notes":"実装メモ",
7+
"Response Class":"レスポンスクラス",
8+
"Status":"ステータス",
9+
"Parameters":"パラメータ群",
10+
"Parameter":"パラメータ",
11+
"Value":"値",
12+
"Description":"説明",
13+
"Parameter Type":"パラメータタイプ",
14+
"Data Type":"データタイプ",
15+
"Response Messages":"レスポンスメッセージ",
16+
"HTTP Status Code":"HTTPステータスコード",
17+
"Reason":"理由",
18+
"Response Model":"レスポンスモデル",
19+
"Request URL":"リクエストURL",
20+
"Response Body":"レスポンスボディ",
21+
"Response Code":"レスポンスコード",
22+
"Response Headers":"レスポンスヘッダ",
23+
"Hide Response":"レスポンスを隠す",
24+
"Headers":"ヘッダ",
25+
"Try it out!":"実際に実行!",
26+
"Show/Hide":"表示/非表示",
27+
"List Operations":"操作一覧",
28+
"Expand Operations":"操作の展開",
29+
"Raw":"Raw",
30+
"can't parse JSON. Raw result":"JSONへ解釈できません. 未加工の結果",
31+
"Model Schema":"モデルスキーマ",
32+
"Model":"モデル",
33+
"apply":"実行",
34+
"Username":"ユーザ名",
35+
"Password":"パスワード",
36+
"Terms of service":"サービス利用規約",
37+
"Created by":"Created by",
38+
"See more at":"See more at",
39+
"Contact the developer":"開発者に連絡",
40+
"api version":"APIバージョン",
41+
"Response Content Type":"レスポンス コンテンツタイプ",
42+
"fetching resource":"リソースの取得",
43+
"fetching resource list":"リソース一覧の取得",
44+
"Explore":"Explore",
45+
"Show Swagger Petstore Example Apis":"SwaggerペットストアAPIの表示",
46+
"Can't read from server. It may not have the appropriate access-control-origin settings.":"サーバから読み込めません. 適切なaccess-control-origin設定を持っていない可能性があります.",
47+
"Please specify the protocol for":"プロトコルを指定してください",
48+
"Can't read swagger JSON from":"次からswagger JSONを読み込めません",
49+
"Finished Loading Resource Information. Rendering Swagger UI":"リソース情報の読み込みが完了しました. Swagger UIを描画しています",
50+
"Unable to read api":"APIを読み込めません",
51+
"from path":"次のパスから",
52+
"server returned":"サーバからの返答"
53+
});

‎swagger/lang/pt.js

100644100755
File mode changed.

‎swagger/lang/ru.js

100644100755
File mode changed.

‎swagger/lang/tr.js

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
'use strict';
2+
3+
/* jshint quotmark: double */
4+
window.SwaggerTranslator.learn({
5+
"Warning: Deprecated":"Uyarı: Deprecated",
6+
"Implementation Notes":"Gerçekleştirim Notları",
7+
"Response Class":"Dönen Sınıf",
8+
"Status":"Statü",
9+
"Parameters":"Parametreler",
10+
"Parameter":"Parametre",
11+
"Value":"Değer",
12+
"Description":"Açıklama",
13+
"Parameter Type":"Parametre Tipi",
14+
"Data Type":"Veri Tipi",
15+
"Response Messages":"Dönüş Mesajı",
16+
"HTTP Status Code":"HTTP Statü Kodu",
17+
"Reason":"Gerekçe",
18+
"Response Model":"Dönüş Modeli",
19+
"Request URL":"İstek URL",
20+
"Response Body":"Dönüş İçeriği",
21+
"Response Code":"Dönüş Kodu",
22+
"Response Headers":"Dönüş Üst Bilgileri",
23+
"Hide Response":"Dönüşü Gizle",
24+
"Headers":"Üst Bilgiler",
25+
"Try it out!":"Dene!",
26+
"Show/Hide":"Göster/Gizle",
27+
"List Operations":"Operasyonları Listele",
28+
"Expand Operations":"Operasyonları Aç",
29+
"Raw":"Ham",
30+
"can't parse JSON. Raw result":"JSON çözümlenemiyor. Ham sonuç",
31+
"Model Schema":"Model Şema",
32+
"Model":"Model",
33+
"apply":"uygula",
34+
"Username":"Kullanıcı Adı",
35+
"Password":"Parola",
36+
"Terms of service":"Servis şartları",
37+
"Created by":"Oluşturan",
38+
"See more at":"Daha fazlası için",
39+
"Contact the developer":"Geliştirici ile İletişime Geçin",
40+
"api version":"api versiyon",
41+
"Response Content Type":"Dönüş İçerik Tipi",
42+
"fetching resource":"kaynak getiriliyor",
43+
"fetching resource list":"kaynak listesi getiriliyor",
44+
"Explore":"Keşfet",
45+
"Show Swagger Petstore Example Apis":"Swagger Petstore Örnek Api'yi Gör",
46+
"Can't read from server. It may not have the appropriate access-control-origin settings.":"Sunucudan okuma yapılamıyor. Sunucu access-control-origin ayarlarınızı kontrol edin.",
47+
"Please specify the protocol for":"Lütfen istenen adres için protokol belirtiniz",
48+
"Can't read swagger JSON from":"Swagger JSON bu kaynaktan okunamıyor",
49+
"Finished Loading Resource Information. Rendering Swagger UI":"Kaynak baglantısı tamamlandı. Swagger UI gösterime hazırlanıyor",
50+
"Unable to read api":"api okunamadı",
51+
"from path":"yoldan",
52+
"server returned":"sunucuya dönüldü"
53+
});

‎swagger/lang/translator.js

100644100755
File mode changed.

‎swagger/lang/zh-cn.js

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
'use strict';
2+
3+
/* jshint quotmark: double */
4+
window.SwaggerTranslator.learn({
5+
"Warning: Deprecated":"警告：已过时",
6+
"Implementation Notes":"实现备注",
7+
"Response Class":"响应类",
8+
"Status":"状态",
9+
"Parameters":"参数",
10+
"Parameter":"参数",
11+
"Value":"值",
12+
"Description":"描述",
13+
"Parameter Type":"参数类型",
14+
"Data Type":"数据类型",
15+
"Response Messages":"响应消息",
16+
"HTTP Status Code":"HTTP状态码",
17+
"Reason":"原因",
18+
"Response Model":"响应模型",
19+
"Request URL":"请求URL",
20+
"Response Body":"响应体",
21+
"Response Code":"响应码",
22+
"Response Headers":"响应头",
23+
"Hide Response":"隐藏响应",
24+
"Headers":"头",
25+
"Try it out!":"试一下！",
26+
"Show/Hide":"显示/隐藏",
27+
"List Operations":"显示操作",
28+
"Expand Operations":"展开操作",
29+
"Raw":"原始",
30+
"can't parse JSON. Raw result":"无法解析JSON. 原始结果",
31+
"Model Schema":"模型架构",
32+
"Model":"模型",
33+
"apply":"应用",
34+
"Username":"用户名",
35+
"Password":"密码",
36+
"Terms of service":"服务条款",
37+
"Created by":"创建者",
38+
"See more at":"查看更多：",
39+
"Contact the developer":"联系开发者",
40+
"api version":"api版本",
41+
"Response Content Type":"响应Content Type",
42+
"fetching resource":"正在获取资源",
43+
"fetching resource list":"正在获取资源列表",
44+
"Explore":"浏览",
45+
"Show Swagger Petstore Example Apis":"显示 Swagger Petstore 示例 Apis",
46+
"Can't read from server. It may not have the appropriate access-control-origin settings.":"无法从服务器读取。可能没有正确设置access-control-origin。",
47+
"Please specify the protocol for":"请指定协议：",
48+
"Can't read swagger JSON from":"无法读取swagger JSON于",
49+
"Finished Loading Resource Information. Rendering Swagger UI":"已加载资源信息。正在渲染Swagger UI",
50+
"Unable to read api":"无法读取api",
51+
"from path":"从路径",
52+
"server returned":"服务器返回"
53+
});

‎swagger/lib/backbone-min.js

100644100755
File mode changed.

‎swagger/lib/handlebars-2.0.0.js

100644100755
File mode changed.

‎swagger/lib/highlight.7.3.pack.js

100644100755
File mode changed.

‎swagger/lib/jquery-1.8.0.min.js

100644100755
File mode changed.

‎swagger/lib/jquery.ba-bbq.min.js

100644100755
File mode changed.

‎swagger/lib/jquery.slideto.min.js

100644100755
File mode changed.

‎swagger/lib/jquery.wiggle.min.js

100644100755
File mode changed.

‎swagger/lib/marked.js

100644100755
File mode changed.

‎swagger/lib/swagger-oauth.js

100644100755
+2-2
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,8 @@ function handleLogin() {
167167

168168

169169
function handleLogout() {
170-
for(key in window.authorizations.authz){
171-
window.authorizations.remove(key)
170+
for(key in window.swaggerUi.api.clientAuthorizations.authz){
171+
window.swaggerUi.api.clientAuthorizations.remove(key)
172172
}
173173
window.enabledScopes = null;
174174
$('.api-ic.ic-on').addClass('ic-off');

‎swagger/lib/underscore-min.js

100644100755
File mode changed.

‎swagger/lib/underscore-min.map

100644100755
File mode changed.

‎swagger/o2c.html

100644100755
File mode changed.

‎swagger/schemas/latest.json

+1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)