Skip to content

Commit dd1628f

Browse files
pdesmaretspdesmarets
authored
Edit image paths
1 parent 3232227 commit dd1628f

File tree

1 file changed

+25
-23
lines changed

1 file changed

+25
-23
lines changed

‎README.md‎

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ Plugin to enable OpenAPI 3 as a target in Hackolade data modeling.
2525

2626
<span class="rvts6">The diagram below results from the reverse-engineering of the</span> [Pet Store](https://mermade.org.uk/examples/openapi.json) <span class="rvts6">sample API.</span>
2727

28-
![](lib/OpenAPI Workspace.png)
28+
<img src="lib/OpenAPI Workspace.png" width="100%" height="100%">
2929

3030
<span class="rvts78">
3131
</span>
3232

3333
<span class="rvts77">Note the toolbar button to toogle the level of details displayed in the ER Diagram view.  </span>
3434

35-
![](lib/OpenAPI - Toggle field details.png)
35+
<img src="lib/OpenAPI - Toggle field details.png" width="10%" height="10%">
3636

3737
<span class="rvts77">
3838
</span>
@@ -49,7 +49,8 @@ Plugin to enable OpenAPI 3 as a target in Hackolade data modeling.
4949
<span class="rvts6">
5050
</span>
5151

52-
![](lib/Swagger data types.png) <span class="rvts6"></span>![](lib/Swagger data types - string.png) <span class="rvts6"></span>![](lib/Swagger data types - number.png) <span class="rvts6"></span>![](lib/Swagger data types - integer.png) <span class="rvts6"></span>
52+
<img src="lib/Swagger data types.png" width="25%" height="25%"><img src="lib/Swagger data types - string.png" width="25%" height="25%"><img src="lib/Swagger data types - number.png" width="25%" height="25%"><img src="lib/Swagger data types - integer.png" width="25%" height="25%">
53+
5354

5455
<span class="rvts6">
5556
</span>
@@ -61,7 +62,8 @@ Plugin to enable OpenAPI 3 as a target in Hackolade data modeling.
6162
<span class="rvts6">
6263
</span>
6364

64-
![](lib/OpenAPI - Info object 1.png) <span class="rvts78"></span>![](lib/OpenAPI - Info object 2.png) <span class="rvts78"></span>![](lib/OpenAPI - Info object 3.png)
65+
<img src="lib/OpenAPI - Info object 1.png" width="33%" height="33%"><img src="lib/OpenAPI - Info object 2.png" width="33%" height="33%">
66+
<img src="lib/OpenAPI - Info object 3.png" width="33%" height="33%">
6567

6668
<span class="rvts78">
6769
</span>
@@ -83,7 +85,7 @@ Plugin to enable OpenAPI 3 as a target in Hackolade data modeling.
8385
<span class="rvts34">
8486
</span>
8587

86-
![](lib/OpenAPI - Components.png)
88+
<img src="lib/OpenAPI - Components.png" width="66%" height="66%">
8789

8890
<span class="rvts34">
8991
</span>
@@ -99,28 +101,28 @@ Plugin to enable OpenAPI 3 as a target in Hackolade data modeling.
99101

100102
<span class="rvts6">Each resource contains one or more "</span>[path item objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathItemObject)<span class="rvts6">" made of a request and one or more responses:</span>
101103

102-
![](lib/OpenAPI - Resource container.png)
104+
<img src="lib/OpenAPI - Resource container.png" width="66%" height="66%">
103105

104106
<span class="rvts6">
105107
</span>
106108

107109
<span class="rvts6">You may create a new resource via right-click anywhere in the ERD view and choosing the contextual menu option:</span>
108110

109-
![](lib/Swagger - Add resource contextual menu.png)
111+
<img src="lib/Swagger - Add resource contextual menu.png" width="10%" height="10%">
110112

111113
<span class="rvts6">
112114
</span>
113115

114116
<span class="rvts6">or via the menu:</span>
115117

116-
![](lib/Swagger - Add resource action menu.png)
118+
<img src="lib/Swagger - Add resource action menu.png" width="10%" height="10%">
117119

118120
<span class="rvts6">
119121
</span>
120122

121123
<span class="rvts6">or the toolbar:</span>
122124

123-
![](lib/Swagger - Add resource toolbar button.png)
125+
<img src="lib/Swagger - Add resource toolbar button.png" width="10%" height="10%">
124126

125127
<span class="rvts6">
126128
</span>
@@ -134,9 +136,8 @@ Plugin to enable OpenAPI 3 as a target in Hackolade data modeling.
134136

135137
<span class="rvts6">The</span> [Parameter Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject) <span class="rvts6">d</span><span class="rvts74">escribes a single operation parameter defined by a combination of a </span><span class="rvts21">name</span><span class="rvts74"> and </span><span class="rvts21">location</span><span class="rvts74">.  Hackolade provides a handy template of parameter types allowing the description of the payload either by adding adding individual fields or by referencing an existing component:</span>
136138

137-
![](lib/OpenAPI - Request Parameter 1.png)
138-
139-
![](lib/OpenAPI - Request Parameter 2.png)
139+
<img src="lib/OpenAPI - Request Parameter 1.png" width="75%" height="75%">
140+
<img src="lib/OpenAPI - Request Parameter 2.png" width="75%" height="75%">
140141

141142
<span class="rvts78">
142143
</span>
@@ -145,22 +146,22 @@ Plugin to enable OpenAPI 3 as a target in Hackolade data modeling.
145146

146147
<span class="rvts6">- right-click inside the container area of the ERD pane, and choose the contextual menu option:</span>
147148

148-
![](lib/Swagger - Add request contextual menu.png)
149+
<img src="lib/Swagger - Add request contextual menu.png" width="10%" height="10%">
149150

150151
<span class="rvts6">- choose the Action menu:</span>
151152

152-
![](lib/Swagger - Add request action menu.png)
153+
<img src="lib/Swagger - Add request action menu.png" width="10%" height="10%">
153154

154155
<span class="rvts6">- choose the toolbar button:</span>
155156

156-
![](lib/Swagger - Add request toolbar button.png)
157+
<img src="lib/Swagger - Add request toolbar button.png" width="10%" height="10%">
157158

158159
<span class="rvts6">
159160
</span>
160161

161162
<span class="rvts6">It is easy to maintain the metadata for a request in the properties pane:</span>
162163

163-
![](lib/OpenAPI - Request Properties.png)
164+
<img src="lib/OpenAPI - Request Properties.png" width="25%" height="25%">
164165

165166
<span class="rvts78">
166167
</span>
@@ -169,14 +170,15 @@ Plugin to enable OpenAPI 3 as a target in Hackolade data modeling.
169170

170171
[Response objects](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responses-object) <span class="rvts34">describe responses from API operations.  For each request, you may create one or more responses.</span>
171172

173+
<img src="lib/OpenAPI - Request Properties.png" width="25%" height="25%">
172174
![](lib/OpenAPI - Responses.png)
173175

174176
<span class="rvts78">
175177
</span>
176178

177179
<span class="rvts34">A response may have a schema that is defined as individual fields or references a component:</span>
178180

179-
![](lib/OpenAPI - Response schema.png)
181+
<img src="lib/OpenAPI - Response schema.png" width="75%" height="75%">
180182

181183
<span class="rvts34">
182184
</span>
@@ -185,22 +187,22 @@ Plugin to enable OpenAPI 3 as a target in Hackolade data modeling.
185187

186188
<span class="rvts6">- right-click on the request in the ERD and choose the contextual menu option:</span>
187189

188-
![](lib/Swagger - Add response contextual menu.png)
190+
<img src="lib/Swagger - Add response contextual menu.png" width="10%" height="10%">
189191

190192
<span class="rvts6">- or choose the Action menu:</span>
191193

192-
![](lib/Swagger - Add response action menu.png)
194+
<img src="lib/Swagger - Add response action menu.png" width="10%" height="10%">
193195

194196
<span class="rvts6">- or choose the toolbar button:</span>
195197

196-
![](lib/Swagger - Add response toolbar button.png)
198+
<img src="lib/Swagger - Add response toolbar button.png" width="10%" height="10%">
197199

198200
<span class="rvts6">
199201
</span>
200202

201203
<span class="rvts6">It is easy to maintain the metadata for a response in the properties pane:</span>
202204

203-
![](lib/OpenAPI - Response properties.png)
205+
<img src="lib/OpenAPI - Response properties.png" width="15%" height="15%">
204206

205207
<span class="rvts78">
206208
</span>
@@ -212,7 +214,7 @@ Plugin to enable OpenAPI 3 as a target in Hackolade data modeling.
212214
<span class="rvts34">
213215
</span>
214216

215-
![](lib/OpenAPI - Forward-Engineering.png)
217+
<img src="lib/OpenAPI - Forward-Engineering.png" width="100%" height="100%">
216218

217219
<span class="rvts78">
218220
</span>
@@ -224,4 +226,4 @@ Plugin to enable OpenAPI 3 as a target in Hackolade data modeling.
224226

225227
## <span class="rvts0"><span class="rvts15">Reverse-Engineering</span></span>
226228

227-
<span class="rvts6">This function lets you take a OpenAPI file in JSON or YAML format and generate a Hackolade model.  Then, you may enrich the model with comments, generate standard Hackolade documentation, and make the API evolve to generate a new OpenAPI file through forward-engineering.</span>
229+
<span class="rvts6">This function lets you take a OpenAPI file in JSON or YAML format and generate a Hackolade model.  Then, you may enrich the model with comments, generate standard Hackolade documentation, and make the API evolve to generate a new OpenAPI file through forward-engineering.</span>

0 commit comments

Comments
 (0)