Add documentation and getSchema function #1
Conversation
sh1l0n
commented
Oct 30, 2024
•
sh1l0n
commented
- Setup FVM
- Added documentation to README
- Added getSchema** function
…is because we configured it wrong in upper layers
sh1l0n
changed the title
.fvmrc
Outdated
| @@ -0,0 +1,3 @@ | |||
| { | |||
There was a problem hiding this comment.
since this is a package, we can remove this file - the package will never be run from an IDE or independently
.vscode/launch.json
Outdated
| @@ -0,0 +1,13 @@ | |||
| { | |||
There was a problem hiding this comment.
since this is a package, we can remove this file - the package will never be run from an IDE or independently
.vscode/settings.json
Outdated
| @@ -0,0 +1,3 @@ | |||
| { | |||
There was a problem hiding this comment.
since this is a package, we can remove this file - the package will never be run from an IDE or independently
README.md
Outdated
|
|
||
| This package helps developers to retrieve and manipulate FHIR data with REST client. | ||
|
|
||
| This package does not manage authentication into a fhir server, for this feature exists [Azure Identity](https://pub.dev/packages/azure_identity) |
There was a problem hiding this comment.
would remove this sentence - Azure Identity is a valid system to use, but could also use no authentication, OAuth, etc
README.md
Outdated
| ## Example | ||
|
|
||
| ``` | ||
| final fhirRestclient = FhirRestClient( |
There was a problem hiding this comment.
to uplevel the package with more pubspec point, would be great to have this as example/example.dart (please look up the exact location, I don't remember). But putting an example file into the expected place helps improve the pubspec score
lib/src/fhir_rest_client.dart
Outdated
| @@ -9,6 +9,32 @@ class FhirRestClient { | |||
|
|
|||
| FhirRestClient({required this.dio, required this.baseUrl}); | |||
|
|
|||
| Future<List<String>> getSchema() async { | |||
There was a problem hiding this comment.
I would renamed this function to Future<Map<String,dynamic>> getCapabilityStatement() and have the schema extraction in the caller, then it is something that can be re-used across applications.
lib/src/fhir_rest_client.dart
Outdated
| final data = response.data as Map<String, dynamic>; | ||
| final resources = data['rest'][0]['resource'] as List<dynamic>; | ||
|
|
||
| final schema = resources |
There was a problem hiding this comment.
line 26-33 should be upstream in the caller
