search

guillotinaweb / guillotina_swagger

1 stars 1 forks source link

Upgrade guillotina_swagger to swagger3 #2

Open AkshJain99 opened 5 years ago

AkshJain99 commented 5 years ago

Upgrade guillotina_swagger to swagger3

AkshJain99 commented 5 years ago

OpenAPI 3 support: Along with updating JSON schema validation support, we need to update our swagger documentation to work with OpenAPI 3/swagger 3.

AkshJain99 commented 5 years ago

Change the generator settings: settings.SchemaType = JsonSchemaType.OpenApi3;

AkshJain99 commented 5 years ago

@vangheem where is the documentation written for guillotina swagger?

AkshJain99 commented 5 years ago

actually I am trying to update documentation to support guillotina with openapi3 /swagger3 but what I actually want to know is , thats why asking for documentation

vangheem commented 5 years ago

Can you be more specific? I'm not sure I understand what you are asking for.

guillotina_swagger pulls in config from service definitions like here: https://github.com/plone/guillotina/blob/master/guillotina/api/content.py#L246

AkshJain99 commented 5 years ago

sorry actually my bad :( i didnt see the comment i did earlier , what i was trying to ask is as i want to swagge documentation related to support of open API3 , so where can i find the documentation related to guillotina swagger?

vangheem commented 5 years ago

guillotina_swagger docs are https://github.com/guillotinaweb/guillotina_swagger/blob/master/README.rst

There isn't much to the package--all it's doing is reading configuration, outputting swagger definition and serving swagger html/js.

Swagger docs are here: https://swagger.io/docs/

There are lots of docs on openapi 3.

I hope that helps!

AkshJain99 commented 5 years ago

yes will soon make a commit for this :+1: