pyramid_openapi3 icon indicating copy to clipboard operation
pyramid_openapi3 copied to clipboard

Provide an enhanced JSON renderer

Open zupo opened this issue 6 years ago • 16 comments

I like the pyramid_swagger renderer from pyramid_swagger library.

With it, I can remove custom renderers from the realworld example app. And less code is always nice.

We can probably reuse the idea, or possibly even some code.

zupo avatar May 22 '19 19:05 zupo

Hey @zupo I am new open source contributing, can I give this one a try?

Vardhan-Kaashikar avatar Feb 17 '21 16:02 Vardhan-Kaashikar

@Vk24-hash: sure thing! Let me know if you need help.

zupo avatar Feb 17 '21 16:02 zupo

Thanks, actually I was searching that where am I supposed to make changes in the code, because the issue is of pyramid_openapi3 repo and the custom renderer link provided by you is from real-world-example-app repository. But it shows that the code is integrated with pyramid_openapi3.

Also if changes are to be made in the given link should I just completely replace the JSON renderer with pyramid_swagger renderer

On Wed, Feb 17, 2021 at 10:13 PM Nejc Zupan [email protected] wrote:

@Vk24-hash https://github.com/Vk24-hash: sure thing! Let me know if you need help.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Pylons/pyramid_openapi3/issues/23#issuecomment-780689214, or unsubscribe https://github.com/notifications/unsubscribe-auth/ASKRO4MVPQMGB3PFNXTA5WLS7PW35ANCNFSM4HOXLW4A .

Vardhan-Kaashikar avatar Feb 18 '21 12:02 Vardhan-Kaashikar

The idea is to ship pyramid_openapi3 with a custom JSON renderer, so that applications using pyramid_openapi3 (for example, the real-world-example-app) do not need to come up with their own custom JSON renderer -- they just use what pyramid_openapi3 provides.

zupo avatar Feb 18 '21 14:02 zupo

okay and just completely replace the JSON renderer with pyramid_swagger renderer ?

On Thu, Feb 18, 2021 at 8:27 PM Nejc Zupan [email protected] wrote:

The idea is to ship pyramid_openapi3 with a custom JSON renderer, so that applications using pyramid_openapi3 (for example, the real-world-example-app) do not need to come up with their own custom JSON renderer -- they just use what pyramid_openapi3 provides.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Pylons/pyramid_openapi3/issues/23#issuecomment-781400953, or unsubscribe https://github.com/notifications/unsubscribe-auth/ASKRO4I3OVZD6P42PDT7HDTS7UTEBANCNFSM4HOXLW4A .

Vardhan-Kaashikar avatar Feb 18 '21 16:02 Vardhan-Kaashikar

I suppose, yes. I cannot know until I see it in action.

zupo avatar Feb 18 '21 19:02 zupo

hey I tried doing some changes with the renderer don't know if it is right at all, please help me out.

On Fri, Feb 19, 2021 at 1:20 AM Nejc Zupan [email protected] wrote:

I suppose, yes. I cannot know until I see it in action.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Pylons/pyramid_openapi3/issues/23#issuecomment-781594796, or unsubscribe https://github.com/notifications/unsubscribe-auth/ASKRO4O3TBSCS4NZBCOYLCTS7VVR7ANCNFSM4HOXLW4A .

Vardhan-Kaashikar avatar Feb 21 '21 17:02 Vardhan-Kaashikar

Where are the changes?

zupo avatar Feb 22 '21 17:02 zupo

I did some changes in the pyramid-real-world-example but it failed to pass the tests

On Mon, Feb 22, 2021 at 10:35 PM Nejc Zupan [email protected] wrote:

Where are the changes?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Pylons/pyramid_openapi3/issues/23#issuecomment-783523417, or unsubscribe https://github.com/notifications/unsubscribe-auth/ASKRO4MQSVKXHG6DIC3YFI3TAKFEJANCNFSM4HOXLW4A .

Vardhan-Kaashikar avatar Feb 22 '21 18:02 Vardhan-Kaashikar

Ah yes, now I remember. The changes should be done here in this repo.

And yes, tests need to pass before the PR can be merged :)

zupo avatar Feb 22 '21 19:02 zupo

So where should I make the changes ?

On Tue, 23 Feb 2021, 00:52 Nejc Zupan, [email protected] wrote:

Ah yes, now I remember. The changes should be done here in this repo.

And yes, tests need to pass before the PR can be merged :)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Pylons/pyramid_openapi3/issues/23#issuecomment-783612498, or unsubscribe https://github.com/notifications/unsubscribe-auth/ASKRO4O6WLKP5HPMXWQPF6TTAKVGFANCNFSM4HOXLW4A .

Vardhan-Kaashikar avatar Feb 22 '21 19:02 Vardhan-Kaashikar

I haven't thought this through so this is coming from the top of my head: it seems it makes sense to have a renderers.py file in https://github.com/Pylons/pyramid_openapi3/blob/master/pyramid_openapi3/.

zupo avatar Feb 22 '21 19:02 zupo

So am I supposed to make a file, because I have no idea where to start and what's the output of the project, if I am supposed to make one pls guide me, or should I just wait.

On Tue, 23 Feb 2021, 01:05 Nejc Zupan, [email protected] wrote:

I haven't thought this through so this is coming from the top of my head: it seems it makes sense to have a renderers.py file in https://github.com/Pylons/pyramid_openapi3/blob/master/pyramid_openapi3/.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Pylons/pyramid_openapi3/issues/23#issuecomment-783620641, or unsubscribe https://github.com/notifications/unsubscribe-auth/ASKRO4N4BBMGKPXFJGRLE7LTAKWYHANCNFSM4HOXLW4A .

Vardhan-Kaashikar avatar Feb 25 '21 15:02 Vardhan-Kaashikar

Maybe a good approach is to familiarize yourself with Pyramid, this tutorial is good: https://docs.pylonsproject.org/projects/pyramid/en/latest/quick_tutorial/

zupo avatar Feb 25 '21 16:02 zupo

The Quick Tutorial is good for learning concepts in Pyramid. For a realistic application, I would point you to the wiki tutorial, which implements the concepts learned in the Quick Tutorial using best practices.

stevepiercy avatar Feb 25 '21 23:02 stevepiercy

Okay, I'll check it out.

On Fri, 26 Feb 2021, 05:27 Steve Piercy, [email protected] wrote:

The Quick Tutorial is good for learning concepts in Pyramid. For a realistic application, I would point you to the wiki tutorial https://docs.pylonsproject.org/projects/pyramid/en/latest/tutorials/wiki2/index.html, which implements the concepts learned in the Quick Tutorial using best practices.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Pylons/pyramid_openapi3/issues/23#issuecomment-786311885, or unsubscribe https://github.com/notifications/unsubscribe-auth/ASKRO4K2HZ6DM66FXRDKKOTTA3PXFANCNFSM4HOXLW4A .

Vardhan-Kaashikar avatar Feb 26 '21 04:02 Vardhan-Kaashikar