Stream: committers
Topic: implementation guide authoring
Grahame Grieve (Apr 19 2017 at 04:11):
Several comments about IG authoring:
- is this the right place to discuss changes to the IG authoring process? (I think yes)
Grahame Grieve (Apr 19 2017 at 04:11):
- @Shovan has been working on a swagger generation capability. That's raised some questions that will apear in various channels
Grahame Grieve (Apr 19 2017 at 04:12):
- as part of that, we're working on this to document who swagger generation will be controlled: http://wiki.hl7.org/index.php?title=IG_Publisher_Documentation#Swagger
Eric Haas (Apr 19 2017 at 16:09):
Cool - So swagger could eventually replace the IG documentation API search stuff and examples right?
Eric Haas (Apr 19 2017 at 16:09):
I wanted to have live search examples
Lloyd McKenzie (Apr 19 2017 at 16:11):
Can the Swagger stuff generate code that builds on the reference implementations?
Grahame Grieve (Apr 19 2017 at 19:55):
I don't think it will replace. Complement.
Grahame Grieve (Apr 19 2017 at 19:55):
and I don't know of any integration between the references implementations and swagger
Lloyd McKenzie (Apr 19 2017 at 19:59):
We really don't want to publish anything that provides suggested code when that code isn't based on the reference implementations
Grahame Grieve (Apr 19 2017 at 20:05):
reference implementations are not that special. Swagger is no different to schema
Lloyd McKenzie (Apr 19 2017 at 20:07):
They handle all of the syntaxes rather than just one, they properly handle extensions, etc. They're certainly the preferred base for doing development.
Grahame Grieve (Apr 19 2017 at 20:37):
sure. but we still produce schema...
Lloyd McKenzie (Apr 19 2017 at 20:41):
I'm talking about the generated Java/C#/etc. code that Swagger produces. Not sure how that equates to schema.
Grahame Grieve (Apr 19 2017 at 20:45):
cause you can generate codes from schema too. swagger just extends the code generation capabiliites.
Lloyd McKenzie (Apr 19 2017 at 20:51):
The difference is that with schema, you have to do the work of generating the code yourself. With Swagger, we're providing code. If we're going to provide code, we should ideally point to code we actually want people to use. If that's not possible, we should at least include a disclaimer and point people to the preferred code.
Grahame Grieve (Apr 19 2017 at 20:59):
I think you have a wrong concept of what swagger is - it's just a language for making statements about how your API works. It's not actually code any more than schema is code
Lakshmi (Sep 13 2017 at 19:29):
Hi, I am new to swagger, but wondering if this group could point me to some tools that can help generate a swagger file from Conformance/ CapabilityStatements. Please let me know.
Last updated: Apr 12 2022 at 19:14 UTC
