Skip to content

Commit 2c1a58c

Browse files
update(docs): replace .png images with .jpg equivalents in OpenAP… (#2532)
* update(docs): replace `.png` images with `.jpg` equivalents in OpenAPI example guides * add(docs): include new `.jpg` images for OpenAPI proxy example usage --------- Co-authored-by: Christian Gördes <118011644+christiangoerdes@users.noreply.github.com>
1 parent 952fcc1 commit 2c1a58c

10 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -297,11 +297,11 @@ api:
297297
#### Viewing Deployed APIs
298298
Once configured, a list of deployed APIs is available at: [http://localhost:2000/api-docs](http://localhost:2000/api-docs)
299299

300-
![List of OpenAPI Deployments](distribution/examples/openapi/openapi-proxy/api-overview.png)
300+
![List of OpenAPI Deployments](distribution/examples/openapi/openapi-proxy/api-overview.jpg)
301301

302302
Click on an API title in the list to open the Swagger UI for interactive exploration and testing:
303303

304-
![Swagger UI](distribution/examples/openapi/openapi-proxy/swagger-ui.png)
304+
![Swagger UI](distribution/examples/openapi/openapi-proxy/swagger-ui.jpg)
305305

306306
### Learn More
307307
For additional details and a working example, check out the [OpenAPI Example](distribution/examples/openapi).

distribution/examples/openapi/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ x-membrane-validation:
8787

8888
The __api__ has a UI that can be reached on its port e.g. [http://localhost:2000/api-docs](http://localhost:2000/api-docs). Follow the links on the left to access the Swagger UI or the link on the right to download the OpenAPI document.
8989

90-
![Overview UI](openapi-proxy/api-overview.png)
90+
![Overview UI](openapi-proxy/api-overview.jpg)
9191

9292
To get a JSON description of the deployed OpenAPI documents call the same `<a href="curl http://localhost:2000/api-docs">URL</a>` outside the browser e.g. in curl or Postman:
9393

distribution/examples/openapi/openapi-proxy/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,18 @@ curl localhost:2000/api-docs
4141

4242
Open the same URL [http://localhost:2000/api-doc](http://localhost:2000/api-doc) in the browser, and you get a UI.
4343

44-
![API Overview](api-overview.png)
44+
![API Overview](api-overview.jpg)
4545

4646

4747

4848

4949
3. Click on [Fruit Shop API](http://localhost:2000/api-doc/ui/fruit-shop-api-v1-0) on the left to open the Swagger UI of the API.
5050

51-
![Swagger UI](swagger-ui.png)
51+
![Swagger UI](swagger-ui.jpg)
5252

5353
4. Click on __POST /products__ to expand it.
5454

55-
![POST /products](post-products.png)
55+
![POST /products](post-products.jpg)
5656

5757
5. Next click on _Try it out_ and then on _Execute_. The call should succeed and create a new product.
5858

25.3 KB
Loading
-174 KB
Binary file not shown.
11.8 KB
Loading
-40.3 KB
Binary file not shown.
59.2 KB
Loading
-312 KB
Binary file not shown.
-13.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)