annotate OpenAPI/NOTES.txt @ 1077:df28170c2af3

documenting java
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 14 Jun 2024 17:39:11 +0200
parents 0ebb626a2b08
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 266
diff changeset
1 To test localy
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 266
diff changeset
2 ==============
579
7de3cd81c927 fix older openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 285
diff changeset
3
285
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 266
diff changeset
4 # cd OpenAPI
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 266
diff changeset
5 # python3 -m http.server 8000
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 266
diff changeset
6 # open http://localhost:8000
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 266
diff changeset
7
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 266
diff changeset
8
45ed5ab7f92a documented /store routes (peers and modalities)
Alain Mazy <alain@mazy.be>
parents: 266
diff changeset
9
266
a9e34dc2635b replacing ReDoc 2.0.0-alpha.17 by 2.0.0-rc.14
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 To install latest version of ReDoc
a9e34dc2635b replacing ReDoc 2.0.0-alpha.17 by 2.0.0-rc.14
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 ==================================
a9e34dc2635b replacing ReDoc 2.0.0-alpha.17 by 2.0.0-rc.14
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12
579
7de3cd81c927 fix older openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 285
diff changeset
13 !! The old documentation "2019-08-orthanc-openapi.yaml" requires
7de3cd81c927 fix older openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 285
diff changeset
14 2.0.0-rc.14.
7de3cd81c927 fix older openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 285
diff changeset
15
7de3cd81c927 fix older openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 285
diff changeset
16 Using wget
7de3cd81c927 fix older openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 285
diff changeset
17 ----------
7de3cd81c927 fix older openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 285
diff changeset
18
582
0ebb626a2b08 upgrade redoc from 2.0.0-alpha.17 to 2.0.0-rc.48
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 579
diff changeset
19 # wget 'https://cdn.jsdelivr.net/npm/redoc@2.0.0-rc.48/bundles/redoc.standalone.js'
579
7de3cd81c927 fix older openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 285
diff changeset
20
7de3cd81c927 fix older openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 285
diff changeset
21
7de3cd81c927 fix older openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 285
diff changeset
22 Using npm
7de3cd81c927 fix older openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 285
diff changeset
23 ---------
7de3cd81c927 fix older openapi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 285
diff changeset
24
266
a9e34dc2635b replacing ReDoc 2.0.0-alpha.17 by 2.0.0-rc.14
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 # mkdir /tmp/i
a9e34dc2635b replacing ReDoc 2.0.0-alpha.17 by 2.0.0-rc.14
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 # cd /tmp/i
a9e34dc2635b replacing ReDoc 2.0.0-alpha.17 by 2.0.0-rc.14
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 # npm install redoc
a9e34dc2635b replacing ReDoc 2.0.0-alpha.17 by 2.0.0-rc.14
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 # cd -
a9e34dc2635b replacing ReDoc 2.0.0-alpha.17 by 2.0.0-rc.14
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 # cp /tmp/i/node_modules/redoc/bundles/redoc.standalone.js .