Skip to content

Commit 8221304

Browse files
committed
Document routes
1 parent fca5441 commit 8221304

File tree

1 file changed

+44
-0
lines changed
  • lib/node_modules/@stdlib/_tools/docs/www/server

1 file changed

+44
-0
lines changed

lib/node_modules/@stdlib/_tools/docs/www/server/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,52 @@ var createServer = httpServer( opts );
9393

9494
### Routes
9595

96+
<a name="docs-api-get"></a>
97+
98+
#### GET /docs/api
99+
100+
Returns the main documentation web application and is equivalent to returning the landing page for the latest documentation version.
101+
102+
##### Response: 200 (text/html)
103+
104+
The response body will be an HTML string containing a documentation landing page.
105+
106+
##### Examples
107+
108+
From the command-line,
109+
110+
<!-- run-disable -->
111+
112+
```bash
113+
$ curl 'http://127.0.0.1:<port>/docs/api'
114+
```
115+
116+
* * *
117+
96118
<a name="docs-api-version-get"></a>
97119

120+
#### GET /docs/api/:version
121+
122+
Returns a documentation landing page for a specified `version`.
123+
124+
##### Response: 200 (text/html)
125+
126+
The response body will be an HTML string containing a documentation landing page.
127+
128+
##### Examples
129+
130+
From the command-line,
131+
132+
<!-- run-disable -->
133+
134+
```bash
135+
$ curl 'http://127.0.0.1:<port>/docs/api/v0.0.90'
136+
```
137+
138+
* * *
139+
140+
<a name="docs-api-version-pkg-get"></a>
141+
98142
#### GET /docs/api/:version/\*?fragment=<true|false>
99143

100144
Returns package documentation for a specified `version`.

0 commit comments

Comments
 (0)