Skip to content
This repository was archived by the owner on Jan 21, 2024. It is now read-only.

Commit 81e8fee

Browse files
postatumpostatum
committed
Fix docs and examples to use correct types
1 parent 531ebe7 commit 81e8fee

11 files changed

+33
-33
lines changed

‎docs/constructing.html

+9-9
Original file line numberDiff line numberDiff line change
@@ -219,9 +219,8 @@ <h1 id="constructing-a-webapi-model">Constructing a &quot;WebApi&quot; Model</h1
219219
<h2 id="quick-start">Quick start</h2>
220220
<p>To get started we need to import all necessary modules and initialize <code>WebApiParser</code> like so:</p>
221221
<pre><code class="lang-js"><span class="hljs-comment">// js</span>
222-
<span class="hljs-keyword">const</span> webapi = <span class="hljs-built_in">require</span>(<span class="hljs-string">&apos;webapi-parser&apos;</span>)
223-
<span class="hljs-keyword">const</span> wap = webapi.WebApiParser
224-
<span class="hljs-keyword">const</span> domain = webapi.model.domain
222+
<span class="hljs-keyword">const</span> lib = <span class="hljs-built_in">require</span>(<span class="hljs-string">&apos;webapi-parser&apos;</span>)
223+
<span class="hljs-keyword">const</span> wap = lib.WebApiParser
225224

226225
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">main</span> (<span class="hljs-params"></span>) </span>{
227226
<span class="hljs-keyword">await</span> wap.init()
@@ -251,9 +250,9 @@ <h2 id="quick-start">Quick start</h2>
251250
<pre><code class="lang-js"><span class="hljs-comment">// js</span>
252251
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">main</span> (<span class="hljs-params"></span>) </span>{
253252
...
254-
const api = <span class="hljs-keyword">new</span> domain.WebApi()
253+
const api = <span class="hljs-keyword">new</span> lib.model.domain.WebApi()
255254
...
256-
const model = <span class="hljs-keyword">new</span> webapi.model.document.Document(api)
255+
const model = <span class="hljs-keyword">new</span> lib.webapi.WebApiDocument().withEncodes(api)
257256
}
258257
</code></pre>
259258
<pre><code class="lang-java"><span class="hljs-comment">// java</span>
@@ -262,7 +261,8 @@ <h2 id="quick-start">Quick start</h2>
262261
...
263262
<span class="hljs-keyword">final</span> WebApi api = <span class="hljs-keyword">new</span> WebApi();
264263
...
265-
WebApiDocument model = <span class="hljs-keyword">new</span> WebApiDocument(api);
264+
WebApiDocument model = <span class="hljs-keyword">new</span> WebApiDocument();
265+
model.withEncodes(api);
266266
}
267267
}
268268
</code></pre>
@@ -271,7 +271,7 @@ <h2 id="quick-start">Quick start</h2>
271271
<pre><code class="lang-js"><span class="hljs-comment">// js</span>
272272
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">main</span> (<span class="hljs-params"></span>) </span>{
273273
...
274-
const api = <span class="hljs-keyword">new</span> domain.WebApi()
274+
const api = <span class="hljs-keyword">new</span> lib.model.domain.WebApi()
275275
.withName(<span class="hljs-string">&apos;Foo org API&apos;</span>)
276276
.withSchemes([<span class="hljs-string">&apos;http&apos;</span>, <span class="hljs-string">&apos;https&apos;</span>])
277277
...
@@ -292,7 +292,7 @@ <h2 id="quick-start">Quick start</h2>
292292
<pre><code class="lang-js"><span class="hljs-comment">// js</span>
293293
<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">main</span> (<span class="hljs-params"></span>) </span>{
294294
...
295-
const api = <span class="hljs-keyword">new</span> domain.WebApi()
295+
const api = <span class="hljs-keyword">new</span> lib.model.domain.WebApi()
296296
.withName(<span class="hljs-string">&apos;Foo org API&apos;</span>)
297297
.withSchemes([<span class="hljs-string">&apos;http&apos;</span>, <span class="hljs-string">&apos;https&apos;</span>])
298298
<span class="hljs-keyword">const</span> users = api.withEndPoint(<span class="hljs-string">&apos;/users&apos;</span>)
@@ -384,7 +384,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
384384
<script>
385385
var gitbook = gitbook || [];
386386
gitbook.push(function() {
387-
gitbook.page.hasChanged({"page":{"title":"Constructing a \"WebApi\" Model","level":"1.4","depth":1,"next":{"title":"Translating RAML DataTypes to JSON Schemas","level":"1.5","depth":1,"path":"translating-raml-json.md","ref":"translating-raml-json.md","articles":[]},"previous":{"title":"Navigating a \"WebApi\" Model","level":"1.3","depth":1,"path":"navigating.md","ref":"navigating.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"SUMMARY.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"constructing.md","mtime":"2019-06-13T07:48:45.738Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-09-17T07:59:52.045Z"},"basePath":".","book":{"language":""}});
387+
gitbook.page.hasChanged({"page":{"title":"Constructing a \"WebApi\" Model","level":"1.4","depth":1,"next":{"title":"Translating RAML DataTypes to JSON Schemas","level":"1.5","depth":1,"path":"translating-raml-json.md","ref":"translating-raml-json.md","articles":[]},"previous":{"title":"Navigating a \"WebApi\" Model","level":"1.3","depth":1,"path":"navigating.md","ref":"navigating.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"SUMMARY.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"constructing.md","mtime":"2020-01-15T07:05:41.951Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2020-01-15T07:12:06.033Z"},"basePath":".","book":{"language":""}});
388388
});
389389
</script>
390390
</div>

‎docs/constructing.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,8 @@ To get started we need to import all necessary modules and initialize `WebApiPar
1313

1414
```js
1515
// js
16-
const webapi = require('webapi-parser')
17-
const wap = webapi.WebApiParser
18-
const domain = webapi.model.domain
16+
const lib = require('webapi-parser')
17+
const wap = lib.WebApiParser
1918

2019
async function main () {
2120
await wap.init()
@@ -50,9 +49,9 @@ Then to start constructing an API we have to create an instance of `WebApi` whic
5049
// js
5150
async function main () {
5251
...
53-
const api = new domain.WebApi()
52+
const api = new lib.model.domain.WebApi()
5453
...
55-
const model = new webapi.model.document.Document(api)
54+
const model = new lib.webapi.WebApiDocument().withEncodes(api)
5655
}
5756
```
5857

@@ -63,7 +62,8 @@ public class Raml10Building {
6362
...
6463
final WebApi api = new WebApi();
6564
...
66-
WebApiDocument model = new WebApiDocument(api);
65+
WebApiDocument model = new WebApiDocument();
66+
model.withEncodes(api);
6767
}
6868
}
6969
```
@@ -75,7 +75,7 @@ First lets specify API title and protocols:
7575
// js
7676
async function main () {
7777
...
78-
const api = new domain.WebApi()
78+
const api = new lib.model.domain.WebApi()
7979
.withName('Foo org API')
8080
.withSchemes(['http', 'https'])
8181
...
@@ -100,7 +100,7 @@ Next let's add an few endpoints with methods:
100100
// js
101101
async function main () {
102102
...
103-
const api = new domain.WebApi()
103+
const api = new lib.model.domain.WebApi()
104104
.withName('Foo org API')
105105
.withSchemes(['http', 'https'])
106106
const users = api.withEndPoint('/users')

‎docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
258258
<script>
259259
var gitbook = gitbook || [];
260260
gitbook.push(function() {
261-
gitbook.page.hasChanged({"page":{"title":"Summary","level":"1.1","depth":1,"next":{"title":"Resolving a \"WebApi\" Model","level":"1.2","depth":1,"path":"resolving.md","ref":"resolving.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"SUMMARY.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"SUMMARY.md","mtime":"2019-06-13T07:48:45.738Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-09-17T07:59:52.045Z"},"basePath":".","book":{"language":""}});
261+
gitbook.page.hasChanged({"page":{"title":"Summary","level":"1.1","depth":1,"next":{"title":"Resolving a \"WebApi\" Model","level":"1.2","depth":1,"path":"resolving.md","ref":"resolving.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"SUMMARY.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"SUMMARY.md","mtime":"2019-10-28T07:27:09.760Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2020-01-15T07:12:06.033Z"},"basePath":".","book":{"language":""}});
262262
});
263263
</script>
264264
</div>

‎docs/navigating.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
392392
<script>
393393
var gitbook = gitbook || [];
394394
gitbook.push(function() {
395-
gitbook.page.hasChanged({"page":{"title":"Navigating a \"WebApi\" Model","level":"1.3","depth":1,"next":{"title":"Constructing a \"WebApi\" Model","level":"1.4","depth":1,"path":"constructing.md","ref":"constructing.md","articles":[]},"previous":{"title":"Resolving a \"WebApi\" Model","level":"1.2","depth":1,"path":"resolving.md","ref":"resolving.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"SUMMARY.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"navigating.md","mtime":"2019-09-17T07:50:55.240Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-09-17T07:59:52.045Z"},"basePath":".","book":{"language":""}});
395+
gitbook.page.hasChanged({"page":{"title":"Navigating a \"WebApi\" Model","level":"1.3","depth":1,"next":{"title":"Constructing a \"WebApi\" Model","level":"1.4","depth":1,"path":"constructing.md","ref":"constructing.md","articles":[]},"previous":{"title":"Resolving a \"WebApi\" Model","level":"1.2","depth":1,"path":"resolving.md","ref":"resolving.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"SUMMARY.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"navigating.md","mtime":"2019-10-28T07:27:25.204Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2020-01-15T07:12:06.033Z"},"basePath":".","book":{"language":""}});
396396
});
397397
</script>
398398
</div>

‎docs/resolving.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
421421
<script>
422422
var gitbook = gitbook || [];
423423
gitbook.push(function() {
424-
gitbook.page.hasChanged({"page":{"title":"Resolving a \"WebApi\" Model","level":"1.2","depth":1,"next":{"title":"Navigating a \"WebApi\" Model","level":"1.3","depth":1,"path":"navigating.md","ref":"navigating.md","articles":[]},"previous":{"title":"Summary","level":"1.1","depth":1,"path":"SUMMARY.md","ref":"SUMMARY.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"SUMMARY.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"resolving.md","mtime":"2019-06-13T07:48:49.546Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-09-17T07:59:52.045Z"},"basePath":".","book":{"language":""}});
424+
gitbook.page.hasChanged({"page":{"title":"Resolving a \"WebApi\" Model","level":"1.2","depth":1,"next":{"title":"Navigating a \"WebApi\" Model","level":"1.3","depth":1,"path":"navigating.md","ref":"navigating.md","articles":[]},"previous":{"title":"Summary","level":"1.1","depth":1,"path":"SUMMARY.md","ref":"SUMMARY.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":[],"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"SUMMARY.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"resolving.md","mtime":"2019-10-28T07:27:25.204Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2020-01-15T07:12:06.033Z"},"basePath":".","book":{"language":""}});
425425
});
426426
</script>
427427
</div>

‎docs/search_index.json

+1-1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)