issue #536 - introduce examples to the Swagger/OpenAPI #538
Conversation
By default, we'll now use the first `complete-mock` example for each applicable resourceType. In addition, I flipped this to "minimal" and used that to generate a new version of the "all-in-one" in our `fhir-openapi` project. Signed-off-by: Lee Surprenant <lmsurpre@us.ibm.com>
| <groupId>${project.groupId}</groupId> | ||
| <artifactId>fhir-examples</artifactId> | ||
| <version>${project.version}</version> | ||
| <scope>compile</scope> |
There was a problem hiding this comment.
these are not picked up in any other project? if so, we may want to add an exclusion.
Double checking with this comment.
There was a problem hiding this comment.
Nothing else should depend on this one...its basically an independent project for making some swagger / openapi definitions (similar to fhir-tools, except that it depends on fhir-model).
| @@ -3,7 +3,7 @@ | |||
| "openapi": "3.0.0", | |||
| "info": { | |||
| "title": "Simplified FHIR API", | |||
| "description": "A simplified version of the FHIR API", | |||
| "description": "A simplified version of the HL7 FHIR API", | |||
| "version": "4.0.0" | |||
There was a problem hiding this comment.
Should the title match our IBM FHIR Server? or update to 4.0.1 to match the spec?
There was a problem hiding this comment.
IMHO this is mostly independent of our implementation...we don't have our own "flavor" of FHIR. However, due to complexities with representing FHIR in Swagger/OpenAPI, this is not a representation of the full FHIR API. This is why I settled on "A simplified version of the HL7 FHIR API".
However, I do agree that we should update it to say version 4.0.1.
Also, I've been meaning to add a README for this module so that others can have some clue about what it does...I'll try adding that tonight and so please hold off on merging this one for now.
1. added support for `@throws` javadoc annotation in CodeBuilder 2. used this to add `@throws` documentation for Resource.as and Element.as Signed-off-by: Lee Surprenant <lmsurpre@us.ibm.com>
Signed-off-by: Lee Surprenant <lmsurpre@us.ibm.com>
By default, we'll now use the first
complete-mockexample for eachapplicable resourceType.
In addition, I flipped this to "minimal" and used that to generate a new
version of the "all-in-one" in our
fhir-openapiproject.Signed-off-by: Lee Surprenant lmsurpre@us.ibm.com