Skip to content

Commit 1332180

Browse files
docs: add note about Swagger UI simulator and CORS restrictions
1 parent 23a1799 commit 1332180

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ typos, schema fixes, or adding examples.
1313
## [2.4.0]
1414
### Added
1515
* Add formality options prefer_less and prefer_more.
16+
* Add note to readme about Swagger UI simulator and CORS restrictions.
1617

1718

1819
## [2.3.1]

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ You can use this specification to explore the API in tools like
99
using tools such as [Swagger Editor][swagger-editor] or
1010
[OpenAPI Generator][openapi-generator].
1111

12+
Note that Swagger's "Try it out" in-browser simulator creates valid Curl
13+
requests, the requests will fail due to [CORS][cors-docs] restrictions.
14+
1215
[Changelog](CHANGELOG.md)
1316

1417
If you encounter issues while using this OpenAPI specification or have feature
@@ -24,4 +27,6 @@ requests, please [create an issue][issues].
2427

2528
[postman]: https://www.postman.com/
2629

27-
[swagger-editor]: https://editor.swagger.io/?url=https://raw.githubusercontent.com/DeepLcom/openapi/main/openapi.yaml
30+
[swagger-editor]: https://editor.swagger.io/?url=https://raw.githubusercontent.com/DeepLcom/openapi/main/openapi.yaml
31+
32+
[cors-docs]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS

0 commit comments

Comments
 (0)