swagger and openApi extented notations "x-"
It s possible to extend the fixed fields in a schema. The specification indicate that we just need to prefix the extra fields with "x-". It s a good point if we want to specified spécific informations - per example the data source of a field. But, in the produced documentations, at the end, we never see this extra fields. My suggestion is, optionnaly, we can add/display this extra fields in the final documentation. Currently, this is what we have : We can expect that we can see the extra field x-dataSource in the documentation.3.1KViews0likes3CommentsBetter Model Documentation / Generation
It would be very useful Models could be given tags so that the documentation could group them the same way that the endpoints are grouped. Then in model generation, instead of all of the models in the model folder, they could be split up into sub folders in the model folder. Not sure if this is swaggerhub Idea, or more for the swagger-generation/swagger-editor repositories, but this is something I would like swaggerhub to do.867Views0likes0CommentsIssue with creating a documentation when using re-usable enums
My yaml file looks like this openapi: 3.0.2 components: schemas: Countries: type: string enum: - Unknown - Afghanistan - Albania - Algeria - AmericanSamoa - "\u00c5landIslands" - NotOtherwiseSpecified , when I compile it it creates the java classes correctly, however is not creating the documentation, just gives me: GeopoliticalAffiliation - and nothing more is displayed for that praticular scheme. For the other schemes enum options are displayed, etc. Can you help me with this problem? Is this an issue of swagger or I am mistaken somehwere.The example in the swagger website and my code are following the same rules:https://swagger.io/docs/specification/data-models/enums/. P.S. I tought the problem is comming because of the special caracter, but is not. I tried without that specific enum entry and also I have another similar way reusable enum that behaves the same way.824Views0likes1CommentNewbie question about Mapping Swagger Documentation
I'm new to Swagger APIs and JSON APIs in general. Mostly doing practical business Python. Now I have a Swagger API from which I need to get some data. The project has Swagger Documentation. I can add the API key for my client and get the Resources, but the Representations are not quite what I expected, knowing the material. I feel like there's another layer that I'm not seeing--possibly in the Platform's setup of the client's Application. I found this post,Visualising complex APIs using API MapFollowing in this direction, was able to use the Pikturr script to generate a UML from the Platform's Swagger API. However, this obviously doesn't include the my client's content. Any suggestions how I can map the Swagger API Documentation using my client's API Key? Or, Am I misunderstanding something about Swagger APIs asking this question? I've found several other packages on Github which do similar things, swagger_to_uml, Swagger2Puml, and a tutorial From Swagger to Confluence UML diagrams; however, none describe this particular problem.1.6KViews0likes2Comments