Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add info about MMLib.SwaggerForOcelot to notsupported.rst #1429

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update notsupported.rst
Burgyn authored and raman-m committed Nov 5, 2024
commit 6d34980d5cbebc3a3aaf55f2ac62c6712b54df9f
5 changes: 3 additions & 2 deletions docs/introduction/notsupported.rst
Original file line number Diff line number Diff line change
@@ -52,5 +52,6 @@ Ocelot does not know what models might be used in POST, PUT etc, so it all gets
Ocelot's configuration can change during runtime so the Swagger and Ocelot information would not match.
Unless we rolled our own Swagger implementation. 😋

If the developer wants something to easily test against the Ocelot API then we suggest using `Postman <https://www.postman.com/>`_ as a simple way to do this.
It might even be possible to write something that maps **ocelot.json** to the Postman JSON spec. However we don't intend to do this.
If the user wants something to easily test against the Ocelot API then I suggest using Postman as a simple way to do this. It might even be possible to write something that maps ocelot.json to the postman json spec. However I don't intend to do this.

An alternative could be to use the community package `MMLib.SwaggerForOcelot <link URL>`_. This package covers some common scenarios that you might expect from swagger documentation over API Gateway.