From 7e95d3d9a94ab57c2cf218fd898d36a715ef6d1e Mon Sep 17 00:00:00 2001 From: Thomas Yu Date: Sat, 5 Jun 2021 21:51:55 +0800 Subject: [PATCH] Update nlpsandboxsdk to nlpsandbox (#174) * Update nlpsandboxsdk to nlpsandbox * Update --- .openapi-generator/FILES | 1 - .openapi-generator/VERSION | 2 +- CONTRIBUTING.md | 16 ---------- docs/Annotation.md | 1 + docs/AnnotationApi.md | 8 +++++ docs/AnnotationCreateRequest.md | 1 + docs/AnnotationCreateResponse.md | 1 + docs/AnnotationId.md | 1 + docs/AnnotationName.md | 1 + docs/AnnotationSet.md | 1 + docs/AnnotationSource.md | 1 + docs/AnnotationStore.md | 1 + docs/AnnotationStoreApi.md | 8 +++++ docs/AnnotationStoreCreateResponse.md | 1 + docs/AnnotationStoreId.md | 1 + docs/AnnotationStoreName.md | 1 + docs/Dataset.md | 1 + docs/DatasetApi.md | 8 +++++ docs/DatasetCreateResponse.md | 1 + docs/DatasetId.md | 1 + docs/DatasetName.md | 1 + docs/DateOffsetConfig.md | 1 + docs/DeidentificationStep.md | 1 + docs/DeidentifiedNoteApi.md | 2 ++ docs/DeidentifyRequest.md | 1 + docs/DeidentifyResponse.md | 1 + docs/Error.md | 1 + docs/FhirStore.md | 1 + docs/FhirStoreApi.md | 8 +++++ docs/FhirStoreCreateResponse.md | 1 + docs/FhirStoreId.md | 1 + docs/FhirStoreName.md | 1 + docs/HealthCheck.md | 1 + docs/HealthCheckApi.md | 2 ++ docs/License.md | 1 + docs/MaskingCharConfig.md | 1 + docs/Note.md | 1 + docs/NoteApi.md | 8 +++++ docs/NoteCreateRequest.md | 1 + docs/NoteCreateResponse.md | 1 + docs/NoteId.md | 1 + docs/NoteResourceName.md | 1 + docs/PageLimit.md | 1 + docs/PageOfAnnotationStores.md | 1 + docs/PageOfAnnotationStoresAllOf.md | 1 + docs/PageOfAnnotations.md | 1 + docs/PageOfAnnotationsAllOf.md | 1 + docs/PageOfDatasets.md | 1 + docs/PageOfDatasetsAllOf.md | 1 + docs/PageOfFhirStores.md | 1 + docs/PageOfFhirStoresAllOf.md | 1 + docs/PageOfNotes.md | 1 + docs/PageOfNotesAllOf.md | 1 + docs/PageOfPatients.md | 1 + docs/PageOfPatientsAllOf.md | 1 + docs/PageOffset.md | 1 + docs/Patient.md | 1 + docs/PatientApi.md | 8 +++++ docs/PatientCreateRequest.md | 1 + docs/PatientCreateResponse.md | 1 + docs/PatientId.md | 1 + docs/PatientResourceName.md | 1 + docs/ResourceSource.md | 1 + docs/ResponsePageMetadata.md | 1 + docs/ResponsePageMetadataLinks.md | 1 + docs/TextAnnotation.md | 1 + docs/TextContactAnnotation.md | 1 + docs/TextContactAnnotationAllOf.md | 1 + docs/TextContactAnnotationApi.md | 2 ++ docs/TextContactAnnotationRequest.md | 1 + docs/TextContactAnnotationResponse.md | 1 + docs/TextCovidSymptomAnnotation.md | 1 + docs/TextCovidSymptomAnnotationAllOf.md | 1 + docs/TextCovidSymptomAnnotationApi.md | 2 ++ docs/TextCovidSymptomAnnotationRequest.md | 1 + docs/TextCovidSymptomAnnotationResponse.md | 1 + docs/TextDateAnnotation.md | 1 + docs/TextDateAnnotationAllOf.md | 1 + docs/TextDateAnnotationApi.md | 2 ++ docs/TextDateAnnotationRequest.md | 1 + docs/TextDateAnnotationResponse.md | 1 + docs/TextIdAnnotation.md | 1 + docs/TextIdAnnotationAllOf.md | 1 + docs/TextIdAnnotationApi.md | 2 ++ docs/TextIdAnnotationRequest.md | 1 + docs/TextIdAnnotationResponse.md | 1 + docs/TextPersonNameAnnotation.md | 1 + docs/TextPersonNameAnnotationApi.md | 2 ++ docs/TextPersonNameAnnotationRequest.md | 1 + docs/TextPersonNameAnnotationResponse.md | 1 + docs/TextPhysicalAddressAnnotation.md | 1 + docs/TextPhysicalAddressAnnotationAllOf.md | 1 + docs/TextPhysicalAddressAnnotationApi.md | 2 ++ docs/TextPhysicalAddressAnnotationRequest.md | 1 + docs/TextPhysicalAddressAnnotationResponse.md | 1 + docs/Tool.md | 1 + docs/ToolApi.md | 4 +++ docs/ToolDependencies.md | 1 + docs/ToolType.md | 1 + examples/push_dataset.py | 24 +++++++------- nlpsandbox/model/annotation_id.py | 3 +- nlpsandbox/model/annotation_name.py | 3 +- nlpsandbox/model/annotation_store_id.py | 3 +- nlpsandbox/model/annotation_store_name.py | 3 +- nlpsandbox/model/dataset_id.py | 3 +- nlpsandbox/model/dataset_name.py | 3 +- nlpsandbox/model/fhir_store_id.py | 3 +- nlpsandbox/model/fhir_store_name.py | 3 +- nlpsandbox/model/license.py | 3 +- nlpsandbox/model/note_id.py | 3 +- nlpsandbox/model/note_resource_name.py | 3 +- nlpsandbox/model/page_limit.py | 3 +- nlpsandbox/model/page_offset.py | 3 +- nlpsandbox/model/patient_id.py | 3 +- nlpsandbox/model/patient_resource_name.py | 3 +- nlpsandbox/model/tool_type.py | 3 +- nlpsandbox/model_utils.py | 31 +++++++++++++------ 117 files changed, 215 insertions(+), 56 deletions(-) diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 95fb444c..34185f00 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -199,6 +199,5 @@ nlpsandbox/model/tool_dependencies.py nlpsandbox/model/tool_type.py nlpsandbox/model_utils.py nlpsandbox/models/__init__.py -nlpsandbox/models/__init__.py nlpsandbox/rest.py test/__init__.py diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION index 32f3eaad..3bff0591 100644 --- a/.openapi-generator/VERSION +++ b/.openapi-generator/VERSION @@ -1 +1 @@ -5.0.1 \ No newline at end of file +5.1.1 \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 23f86edb..8be37221 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -113,22 +113,6 @@ The Python SDK client `nlpsandbox` is now automatically updated when there is a openapi-generator generate -g python -o . --package-name nlpsandbox -i https://nlpsandbox.github.io/nlpsandbox-schemas/_internal/nlpsandbox/edge/openapi.json ``` - - ### Testing Please add tests for new code. These might include unit tests (to test specific functionality of code that was added to support fixing the bug or feature), integration tests (to test that the feature is usable - e.g., it should have complete the expected behavior as reported in the feature request or bug report), or both. diff --git a/docs/Annotation.md b/docs/Annotation.md index 200903e8..e2b6064e 100644 --- a/docs/Annotation.md +++ b/docs/Annotation.md @@ -1,6 +1,7 @@ # Annotation An annotation record + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AnnotationApi.md b/docs/AnnotationApi.md index d6a5c3f7..e780014b 100644 --- a/docs/AnnotationApi.md +++ b/docs/AnnotationApi.md @@ -88,6 +88,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling AnnotationApi->create_annotation: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -110,6 +111,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -162,6 +164,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling AnnotationApi->delete_annotation: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -183,6 +186,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -235,6 +239,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling AnnotationApi->get_annotation: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -256,6 +261,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -319,6 +325,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling AnnotationApi->list_annotations: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -341,6 +348,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/AnnotationCreateRequest.md b/docs/AnnotationCreateRequest.md index 0bdb582d..30e3534b 100644 --- a/docs/AnnotationCreateRequest.md +++ b/docs/AnnotationCreateRequest.md @@ -1,6 +1,7 @@ # AnnotationCreateRequest An annotation record + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AnnotationCreateResponse.md b/docs/AnnotationCreateResponse.md index ee70021e..74cba52d 100644 --- a/docs/AnnotationCreateResponse.md +++ b/docs/AnnotationCreateResponse.md @@ -1,6 +1,7 @@ # AnnotationCreateResponse The reference to the annotation created + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AnnotationId.md b/docs/AnnotationId.md index 10a78dfc..65fd2e73 100644 --- a/docs/AnnotationId.md +++ b/docs/AnnotationId.md @@ -1,6 +1,7 @@ # AnnotationId The ID of the annotation + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AnnotationName.md b/docs/AnnotationName.md index 7d0dfcc7..c623c522 100644 --- a/docs/AnnotationName.md +++ b/docs/AnnotationName.md @@ -1,6 +1,7 @@ # AnnotationName The resource name of the annotation record, of the form datasets/{datasetId}/annotationStores/{annotationStoreId}/annotations/{annotationId} + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AnnotationSet.md b/docs/AnnotationSet.md index 0fb4323d..ff42d018 100644 --- a/docs/AnnotationSet.md +++ b/docs/AnnotationSet.md @@ -1,6 +1,7 @@ # AnnotationSet Set of annotations of all types for a text + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AnnotationSource.md b/docs/AnnotationSource.md index e679224e..c5ce91cd 100644 --- a/docs/AnnotationSource.md +++ b/docs/AnnotationSource.md @@ -1,6 +1,7 @@ # AnnotationSource The source of an annotation record + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AnnotationStore.md b/docs/AnnotationStore.md index b7ccde7c..1813b6cb 100644 --- a/docs/AnnotationStore.md +++ b/docs/AnnotationStore.md @@ -1,6 +1,7 @@ # AnnotationStore An annotation store + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AnnotationStoreApi.md b/docs/AnnotationStoreApi.md index 7e3967d9..a6b9aab4 100644 --- a/docs/AnnotationStoreApi.md +++ b/docs/AnnotationStoreApi.md @@ -61,6 +61,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling AnnotationStoreApi->create_annotation_store: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -82,6 +83,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -132,6 +134,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling AnnotationStoreApi->delete_annotation_store: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -152,6 +155,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -202,6 +206,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling AnnotationStoreApi->get_annotation_store: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -222,6 +227,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -283,6 +289,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling AnnotationStoreApi->list_annotation_stores: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -304,6 +311,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/AnnotationStoreCreateResponse.md b/docs/AnnotationStoreCreateResponse.md index 45134b77..3939f658 100644 --- a/docs/AnnotationStoreCreateResponse.md +++ b/docs/AnnotationStoreCreateResponse.md @@ -1,6 +1,7 @@ # AnnotationStoreCreateResponse The reference to the annotation store created + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AnnotationStoreId.md b/docs/AnnotationStoreId.md index 450ef41d..28509ef2 100644 --- a/docs/AnnotationStoreId.md +++ b/docs/AnnotationStoreId.md @@ -1,6 +1,7 @@ # AnnotationStoreId The ID of the annotation store + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AnnotationStoreName.md b/docs/AnnotationStoreName.md index 917b56bb..acc8cdc9 100644 --- a/docs/AnnotationStoreName.md +++ b/docs/AnnotationStoreName.md @@ -1,6 +1,7 @@ # AnnotationStoreName The resource name of the annotation store, of the form datasets/{datasetId}/annotationStores/{annotationStoreId} + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Dataset.md b/docs/Dataset.md index 7fcf31bc..0992285e 100644 --- a/docs/Dataset.md +++ b/docs/Dataset.md @@ -1,6 +1,7 @@ # Dataset A dataset + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DatasetApi.md b/docs/DatasetApi.md index b92e348c..f605ffcd 100644 --- a/docs/DatasetApi.md +++ b/docs/DatasetApi.md @@ -59,6 +59,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling DatasetApi->create_dataset: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -79,6 +80,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -127,6 +129,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling DatasetApi->delete_dataset: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -146,6 +149,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -194,6 +198,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling DatasetApi->get_dataset: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -213,6 +218,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -264,6 +270,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling DatasetApi->list_datasets: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -284,6 +291,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/DatasetCreateResponse.md b/docs/DatasetCreateResponse.md index d498bbec..90123296 100644 --- a/docs/DatasetCreateResponse.md +++ b/docs/DatasetCreateResponse.md @@ -1,6 +1,7 @@ # DatasetCreateResponse The reference of the dataset created + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DatasetId.md b/docs/DatasetId.md index ad24d5d8..3340ccac 100644 --- a/docs/DatasetId.md +++ b/docs/DatasetId.md @@ -1,6 +1,7 @@ # DatasetId The ID of the dataset + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DatasetName.md b/docs/DatasetName.md index 15744463..505b0261 100644 --- a/docs/DatasetName.md +++ b/docs/DatasetName.md @@ -1,6 +1,7 @@ # DatasetName The name of the dataset + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DateOffsetConfig.md b/docs/DateOffsetConfig.md index 1576c2bc..bcfed1b2 100644 --- a/docs/DateOffsetConfig.md +++ b/docs/DateOffsetConfig.md @@ -1,6 +1,7 @@ # DateOffsetConfig Configuration for the \"date offset\" strategy. E.g. \"John Smith visited on 1 January 2020\" -> \"John Smith visited on 29 October 2025\". Note, can only be set with the \"text_date\" annotation type. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DeidentificationStep.md b/docs/DeidentificationStep.md index 66d5f254..44668f3d 100644 --- a/docs/DeidentificationStep.md +++ b/docs/DeidentificationStep.md @@ -1,6 +1,7 @@ # DeidentificationStep The configuration of a deidentification step + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DeidentifiedNoteApi.md b/docs/DeidentifiedNoteApi.md index ef0152ab..6b9e4bf3 100644 --- a/docs/DeidentifiedNoteApi.md +++ b/docs/DeidentifiedNoteApi.md @@ -70,6 +70,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling DeidentifiedNoteApi->create_deidentified_notes: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -89,6 +90,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/DeidentifyRequest.md b/docs/DeidentifyRequest.md index 1cf5a22d..037a5015 100644 --- a/docs/DeidentifyRequest.md +++ b/docs/DeidentifyRequest.md @@ -1,6 +1,7 @@ # DeidentifyRequest A request to de-identify a clinical note + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DeidentifyResponse.md b/docs/DeidentifyResponse.md index 478980d3..09636a2b 100644 --- a/docs/DeidentifyResponse.md +++ b/docs/DeidentifyResponse.md @@ -1,6 +1,7 @@ # DeidentifyResponse The response to a deidentification request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Error.md b/docs/Error.md index 89ff3eeb..7696a968 100644 --- a/docs/Error.md +++ b/docs/Error.md @@ -1,6 +1,7 @@ # Error Problem details (tools.ietf.org/html/rfc7807) + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FhirStore.md b/docs/FhirStore.md index 49dae317..574f1aa6 100644 --- a/docs/FhirStore.md +++ b/docs/FhirStore.md @@ -1,6 +1,7 @@ # FhirStore A FHIR store + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FhirStoreApi.md b/docs/FhirStoreApi.md index e27f31bf..b2636e03 100644 --- a/docs/FhirStoreApi.md +++ b/docs/FhirStoreApi.md @@ -61,6 +61,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling FhirStoreApi->create_fhir_store: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -82,6 +83,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -132,6 +134,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling FhirStoreApi->delete_fhir_store: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -152,6 +155,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -202,6 +206,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling FhirStoreApi->get_fhir_store: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -222,6 +227,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -283,6 +289,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling FhirStoreApi->list_fhir_stores: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -304,6 +311,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/FhirStoreCreateResponse.md b/docs/FhirStoreCreateResponse.md index 487aa949..6364a00f 100644 --- a/docs/FhirStoreCreateResponse.md +++ b/docs/FhirStoreCreateResponse.md @@ -1,6 +1,7 @@ # FhirStoreCreateResponse The reference to the FHIR store created + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FhirStoreId.md b/docs/FhirStoreId.md index 50c757d2..783e4312 100644 --- a/docs/FhirStoreId.md +++ b/docs/FhirStoreId.md @@ -1,6 +1,7 @@ # FhirStoreId The ID of the FHIR store + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FhirStoreName.md b/docs/FhirStoreName.md index 2a1498de..af06d399 100644 --- a/docs/FhirStoreName.md +++ b/docs/FhirStoreName.md @@ -1,6 +1,7 @@ # FhirStoreName The resource name of the FHIR store, of the form datasets/{datasetId}/fhirStores/{fhirStoreId} + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/HealthCheck.md b/docs/HealthCheck.md index 465f2009..5fdbd34c 100644 --- a/docs/HealthCheck.md +++ b/docs/HealthCheck.md @@ -1,6 +1,7 @@ # HealthCheck Represents the health of a service + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/HealthCheckApi.md b/docs/HealthCheckApi.md index c7bb2869..299100e6 100644 --- a/docs/HealthCheckApi.md +++ b/docs/HealthCheckApi.md @@ -44,6 +44,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling HealthCheckApi->get_health_check: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -60,6 +61,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/License.md b/docs/License.md index 08a74038..1cb766a6 100644 --- a/docs/License.md +++ b/docs/License.md @@ -1,6 +1,7 @@ # License The license (license keyword used by GitHub) + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/MaskingCharConfig.md b/docs/MaskingCharConfig.md index 186b626d..fdf410eb 100644 --- a/docs/MaskingCharConfig.md +++ b/docs/MaskingCharConfig.md @@ -1,6 +1,7 @@ # MaskingCharConfig Configuration for the masking char strategy. E.g. \"John Smith lives at 123 Main St\" -> \"********* lives at ***********\". + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Note.md b/docs/Note.md index b7d54bd7..292f5d2e 100644 --- a/docs/Note.md +++ b/docs/Note.md @@ -1,6 +1,7 @@ # Note A clinical note + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NoteApi.md b/docs/NoteApi.md index 89d7805f..bbe88b75 100644 --- a/docs/NoteApi.md +++ b/docs/NoteApi.md @@ -68,6 +68,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling NoteApi->create_note: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -90,6 +91,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -142,6 +144,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling NoteApi->delete_note: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -163,6 +166,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -215,6 +219,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling NoteApi->get_note: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -236,6 +241,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -299,6 +305,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling NoteApi->list_notes: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -321,6 +328,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/NoteCreateRequest.md b/docs/NoteCreateRequest.md index 45320355..3d309056 100644 --- a/docs/NoteCreateRequest.md +++ b/docs/NoteCreateRequest.md @@ -1,6 +1,7 @@ # NoteCreateRequest A clinical note + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NoteCreateResponse.md b/docs/NoteCreateResponse.md index aa1e32d6..0f701309 100644 --- a/docs/NoteCreateResponse.md +++ b/docs/NoteCreateResponse.md @@ -1,6 +1,7 @@ # NoteCreateResponse The reference to the note created + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NoteId.md b/docs/NoteId.md index e398f4e5..5e75e8e3 100644 --- a/docs/NoteId.md +++ b/docs/NoteId.md @@ -1,6 +1,7 @@ # NoteId The ID of the clinical note + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/NoteResourceName.md b/docs/NoteResourceName.md index 7e1e25de..f217d3b5 100644 --- a/docs/NoteResourceName.md +++ b/docs/NoteResourceName.md @@ -1,6 +1,7 @@ # NoteResourceName The resource name of the clinical note, of the form datasets/{datasetId}/fhirStores/{fhirStoreId}/Note/{NoteId} + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageLimit.md b/docs/PageLimit.md index dedbd5a5..c41a0c02 100644 --- a/docs/PageLimit.md +++ b/docs/PageLimit.md @@ -1,6 +1,7 @@ # PageLimit The maximum number of results returned + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOfAnnotationStores.md b/docs/PageOfAnnotationStores.md index 40694b6e..69a4c9eb 100644 --- a/docs/PageOfAnnotationStores.md +++ b/docs/PageOfAnnotationStores.md @@ -1,6 +1,7 @@ # PageOfAnnotationStores A page of annotation stores + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOfAnnotationStoresAllOf.md b/docs/PageOfAnnotationStoresAllOf.md index 67251315..3352252e 100644 --- a/docs/PageOfAnnotationStoresAllOf.md +++ b/docs/PageOfAnnotationStoresAllOf.md @@ -1,5 +1,6 @@ # PageOfAnnotationStoresAllOf + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOfAnnotations.md b/docs/PageOfAnnotations.md index 6fcf70a8..c101ecd8 100644 --- a/docs/PageOfAnnotations.md +++ b/docs/PageOfAnnotations.md @@ -1,6 +1,7 @@ # PageOfAnnotations A page of annotations + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOfAnnotationsAllOf.md b/docs/PageOfAnnotationsAllOf.md index f4a5714f..c2872966 100644 --- a/docs/PageOfAnnotationsAllOf.md +++ b/docs/PageOfAnnotationsAllOf.md @@ -1,5 +1,6 @@ # PageOfAnnotationsAllOf + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOfDatasets.md b/docs/PageOfDatasets.md index 4e955889..665d8382 100644 --- a/docs/PageOfDatasets.md +++ b/docs/PageOfDatasets.md @@ -1,6 +1,7 @@ # PageOfDatasets A page of datasets + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOfDatasetsAllOf.md b/docs/PageOfDatasetsAllOf.md index a10be4cf..c200e50a 100644 --- a/docs/PageOfDatasetsAllOf.md +++ b/docs/PageOfDatasetsAllOf.md @@ -1,5 +1,6 @@ # PageOfDatasetsAllOf + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOfFhirStores.md b/docs/PageOfFhirStores.md index 2ea7cf0c..2fc930e3 100644 --- a/docs/PageOfFhirStores.md +++ b/docs/PageOfFhirStores.md @@ -1,6 +1,7 @@ # PageOfFhirStores A page of FHIR stores + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOfFhirStoresAllOf.md b/docs/PageOfFhirStoresAllOf.md index f01df848..429b522e 100644 --- a/docs/PageOfFhirStoresAllOf.md +++ b/docs/PageOfFhirStoresAllOf.md @@ -1,5 +1,6 @@ # PageOfFhirStoresAllOf + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOfNotes.md b/docs/PageOfNotes.md index 98ebc40c..0cbbd21a 100644 --- a/docs/PageOfNotes.md +++ b/docs/PageOfNotes.md @@ -1,6 +1,7 @@ # PageOfNotes A page of notes + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOfNotesAllOf.md b/docs/PageOfNotesAllOf.md index 3edee359..9daf21ca 100644 --- a/docs/PageOfNotesAllOf.md +++ b/docs/PageOfNotesAllOf.md @@ -1,5 +1,6 @@ # PageOfNotesAllOf + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOfPatients.md b/docs/PageOfPatients.md index e5692636..56a51a04 100644 --- a/docs/PageOfPatients.md +++ b/docs/PageOfPatients.md @@ -1,6 +1,7 @@ # PageOfPatients A page of FHIR patients + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOfPatientsAllOf.md b/docs/PageOfPatientsAllOf.md index b0c8f40f..36f5bdbf 100644 --- a/docs/PageOfPatientsAllOf.md +++ b/docs/PageOfPatientsAllOf.md @@ -1,5 +1,6 @@ # PageOfPatientsAllOf + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PageOffset.md b/docs/PageOffset.md index a2463256..04fe1494 100644 --- a/docs/PageOffset.md +++ b/docs/PageOffset.md @@ -1,6 +1,7 @@ # PageOffset The index of the first result that must be returned + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Patient.md b/docs/Patient.md index e9b7fe53..1d862efe 100644 --- a/docs/Patient.md +++ b/docs/Patient.md @@ -1,6 +1,7 @@ # Patient A FHIR patient + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PatientApi.md b/docs/PatientApi.md index 2aaa4904..c05911d1 100644 --- a/docs/PatientApi.md +++ b/docs/PatientApi.md @@ -66,6 +66,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling PatientApi->create_patient: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -88,6 +89,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -140,6 +142,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling PatientApi->delete_patient: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -161,6 +164,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -213,6 +217,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling PatientApi->get_patient: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -234,6 +239,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -297,6 +303,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling PatientApi->list_patients: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -319,6 +326,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/PatientCreateRequest.md b/docs/PatientCreateRequest.md index ec53c76f..6278f8db 100644 --- a/docs/PatientCreateRequest.md +++ b/docs/PatientCreateRequest.md @@ -1,6 +1,7 @@ # PatientCreateRequest A FHIR patient + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PatientCreateResponse.md b/docs/PatientCreateResponse.md index e4f88d36..f11bb3cf 100644 --- a/docs/PatientCreateResponse.md +++ b/docs/PatientCreateResponse.md @@ -1,6 +1,7 @@ # PatientCreateResponse The reference to the patient created + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PatientId.md b/docs/PatientId.md index 8bcfbad8..1d96c90b 100644 --- a/docs/PatientId.md +++ b/docs/PatientId.md @@ -1,6 +1,7 @@ # PatientId The ID of the FHIR patient + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/PatientResourceName.md b/docs/PatientResourceName.md index 4b7bc281..c9a8f03d 100644 --- a/docs/PatientResourceName.md +++ b/docs/PatientResourceName.md @@ -1,6 +1,7 @@ # PatientResourceName The resource name of the FHIR patient, of the form datasets/{datasetId}/fhirStores/{fhirStoreId}/Patient/{PatientId} + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ResourceSource.md b/docs/ResourceSource.md index b214335e..d633c07d 100644 --- a/docs/ResourceSource.md +++ b/docs/ResourceSource.md @@ -1,6 +1,7 @@ # ResourceSource An API resource source + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ResponsePageMetadata.md b/docs/ResponsePageMetadata.md index 9b9ea8d6..cf02cb40 100644 --- a/docs/ResponsePageMetadata.md +++ b/docs/ResponsePageMetadata.md @@ -1,6 +1,7 @@ # ResponsePageMetadata A page of results + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ResponsePageMetadataLinks.md b/docs/ResponsePageMetadataLinks.md index f2c9d93f..72aa9d18 100644 --- a/docs/ResponsePageMetadataLinks.md +++ b/docs/ResponsePageMetadataLinks.md @@ -1,6 +1,7 @@ # ResponsePageMetadataLinks Links to navigate to different pages of results + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextAnnotation.md b/docs/TextAnnotation.md index 355a3478..c88bde2d 100644 --- a/docs/TextAnnotation.md +++ b/docs/TextAnnotation.md @@ -1,6 +1,7 @@ # TextAnnotation An annotation in a text + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextContactAnnotation.md b/docs/TextContactAnnotation.md index aa46a56e..05694c73 100644 --- a/docs/TextContactAnnotation.md +++ b/docs/TextContactAnnotation.md @@ -1,6 +1,7 @@ # TextContactAnnotation A contact annotation in a text + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextContactAnnotationAllOf.md b/docs/TextContactAnnotationAllOf.md index 6070d0b0..00324f7c 100644 --- a/docs/TextContactAnnotationAllOf.md +++ b/docs/TextContactAnnotationAllOf.md @@ -1,5 +1,6 @@ # TextContactAnnotationAllOf + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextContactAnnotationApi.md b/docs/TextContactAnnotationApi.md index 947c79a0..cc294eca 100644 --- a/docs/TextContactAnnotationApi.md +++ b/docs/TextContactAnnotationApi.md @@ -54,6 +54,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling TextContactAnnotationApi->create_text_contact_annotations: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -73,6 +74,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/TextContactAnnotationRequest.md b/docs/TextContactAnnotationRequest.md index c6a5c0aa..7741011e 100644 --- a/docs/TextContactAnnotationRequest.md +++ b/docs/TextContactAnnotationRequest.md @@ -1,6 +1,7 @@ # TextContactAnnotationRequest A request to annotate contacts in a clinical note + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextContactAnnotationResponse.md b/docs/TextContactAnnotationResponse.md index 9c8b5673..1fae20bd 100644 --- a/docs/TextContactAnnotationResponse.md +++ b/docs/TextContactAnnotationResponse.md @@ -1,6 +1,7 @@ # TextContactAnnotationResponse The response to a contact annotation request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextCovidSymptomAnnotation.md b/docs/TextCovidSymptomAnnotation.md index 1e6ba805..915208e8 100644 --- a/docs/TextCovidSymptomAnnotation.md +++ b/docs/TextCovidSymptomAnnotation.md @@ -1,6 +1,7 @@ # TextCovidSymptomAnnotation A COVID symptom annotation in a text + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextCovidSymptomAnnotationAllOf.md b/docs/TextCovidSymptomAnnotationAllOf.md index c143f14e..6db11090 100644 --- a/docs/TextCovidSymptomAnnotationAllOf.md +++ b/docs/TextCovidSymptomAnnotationAllOf.md @@ -1,5 +1,6 @@ # TextCovidSymptomAnnotationAllOf + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextCovidSymptomAnnotationApi.md b/docs/TextCovidSymptomAnnotationApi.md index 60930530..093480d2 100644 --- a/docs/TextCovidSymptomAnnotationApi.md +++ b/docs/TextCovidSymptomAnnotationApi.md @@ -54,6 +54,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling TextCovidSymptomAnnotationApi->create_text_covid_symptom_annotations: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -73,6 +74,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/TextCovidSymptomAnnotationRequest.md b/docs/TextCovidSymptomAnnotationRequest.md index 05005383..cdf9f402 100644 --- a/docs/TextCovidSymptomAnnotationRequest.md +++ b/docs/TextCovidSymptomAnnotationRequest.md @@ -1,6 +1,7 @@ # TextCovidSymptomAnnotationRequest A request to annotate COVID symptoms in a clinical note + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextCovidSymptomAnnotationResponse.md b/docs/TextCovidSymptomAnnotationResponse.md index 9996a54e..42295a3e 100644 --- a/docs/TextCovidSymptomAnnotationResponse.md +++ b/docs/TextCovidSymptomAnnotationResponse.md @@ -1,6 +1,7 @@ # TextCovidSymptomAnnotationResponse The response to a COVID symptoms annotation request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextDateAnnotation.md b/docs/TextDateAnnotation.md index 213fdd7e..ade678c3 100644 --- a/docs/TextDateAnnotation.md +++ b/docs/TextDateAnnotation.md @@ -1,6 +1,7 @@ # TextDateAnnotation A date annotation in a text + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextDateAnnotationAllOf.md b/docs/TextDateAnnotationAllOf.md index 5c8e043b..c2706e21 100644 --- a/docs/TextDateAnnotationAllOf.md +++ b/docs/TextDateAnnotationAllOf.md @@ -1,5 +1,6 @@ # TextDateAnnotationAllOf + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextDateAnnotationApi.md b/docs/TextDateAnnotationApi.md index 0bb53980..422330a4 100644 --- a/docs/TextDateAnnotationApi.md +++ b/docs/TextDateAnnotationApi.md @@ -54,6 +54,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling TextDateAnnotationApi->create_text_date_annotations: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -73,6 +74,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/TextDateAnnotationRequest.md b/docs/TextDateAnnotationRequest.md index 23673e66..60cec3b3 100644 --- a/docs/TextDateAnnotationRequest.md +++ b/docs/TextDateAnnotationRequest.md @@ -1,6 +1,7 @@ # TextDateAnnotationRequest A request to annotate dates in a clinical note + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextDateAnnotationResponse.md b/docs/TextDateAnnotationResponse.md index e9ea5a3d..ee2f727b 100644 --- a/docs/TextDateAnnotationResponse.md +++ b/docs/TextDateAnnotationResponse.md @@ -1,6 +1,7 @@ # TextDateAnnotationResponse The response to a dates annotation request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextIdAnnotation.md b/docs/TextIdAnnotation.md index 4dcbbf3f..6a08eb21 100644 --- a/docs/TextIdAnnotation.md +++ b/docs/TextIdAnnotation.md @@ -1,6 +1,7 @@ # TextIdAnnotation An ID annotation in a text + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextIdAnnotationAllOf.md b/docs/TextIdAnnotationAllOf.md index 3f47719e..29b85633 100644 --- a/docs/TextIdAnnotationAllOf.md +++ b/docs/TextIdAnnotationAllOf.md @@ -1,5 +1,6 @@ # TextIdAnnotationAllOf + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextIdAnnotationApi.md b/docs/TextIdAnnotationApi.md index 429cd4ff..1c886bb5 100644 --- a/docs/TextIdAnnotationApi.md +++ b/docs/TextIdAnnotationApi.md @@ -54,6 +54,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling TextIdAnnotationApi->create_text_id_annotations: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -73,6 +74,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/TextIdAnnotationRequest.md b/docs/TextIdAnnotationRequest.md index de43325a..90bd3668 100644 --- a/docs/TextIdAnnotationRequest.md +++ b/docs/TextIdAnnotationRequest.md @@ -1,6 +1,7 @@ # TextIdAnnotationRequest A request to annotate IDs in a clinical note + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextIdAnnotationResponse.md b/docs/TextIdAnnotationResponse.md index 699e6dba..b602eafe 100644 --- a/docs/TextIdAnnotationResponse.md +++ b/docs/TextIdAnnotationResponse.md @@ -1,6 +1,7 @@ # TextIdAnnotationResponse The response to an ID annotation request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextPersonNameAnnotation.md b/docs/TextPersonNameAnnotation.md index 7b1ead9a..cf7a1837 100644 --- a/docs/TextPersonNameAnnotation.md +++ b/docs/TextPersonNameAnnotation.md @@ -1,6 +1,7 @@ # TextPersonNameAnnotation A person name annotation in a text + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextPersonNameAnnotationApi.md b/docs/TextPersonNameAnnotationApi.md index a8149cce..e4948de5 100644 --- a/docs/TextPersonNameAnnotationApi.md +++ b/docs/TextPersonNameAnnotationApi.md @@ -54,6 +54,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling TextPersonNameAnnotationApi->create_text_person_name_annotations: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -73,6 +74,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/TextPersonNameAnnotationRequest.md b/docs/TextPersonNameAnnotationRequest.md index 8d13d7b0..599354ba 100644 --- a/docs/TextPersonNameAnnotationRequest.md +++ b/docs/TextPersonNameAnnotationRequest.md @@ -1,6 +1,7 @@ # TextPersonNameAnnotationRequest A request to annotate person names in a clinical note + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextPersonNameAnnotationResponse.md b/docs/TextPersonNameAnnotationResponse.md index 1528f58a..2805737d 100644 --- a/docs/TextPersonNameAnnotationResponse.md +++ b/docs/TextPersonNameAnnotationResponse.md @@ -1,6 +1,7 @@ # TextPersonNameAnnotationResponse The response to a person names annotation request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextPhysicalAddressAnnotation.md b/docs/TextPhysicalAddressAnnotation.md index ac293e80..23150650 100644 --- a/docs/TextPhysicalAddressAnnotation.md +++ b/docs/TextPhysicalAddressAnnotation.md @@ -1,6 +1,7 @@ # TextPhysicalAddressAnnotation A physical address annotation in a text + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextPhysicalAddressAnnotationAllOf.md b/docs/TextPhysicalAddressAnnotationAllOf.md index 659ee669..0e07ae59 100644 --- a/docs/TextPhysicalAddressAnnotationAllOf.md +++ b/docs/TextPhysicalAddressAnnotationAllOf.md @@ -1,5 +1,6 @@ # TextPhysicalAddressAnnotationAllOf + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextPhysicalAddressAnnotationApi.md b/docs/TextPhysicalAddressAnnotationApi.md index 7772cf73..2cab01ae 100644 --- a/docs/TextPhysicalAddressAnnotationApi.md +++ b/docs/TextPhysicalAddressAnnotationApi.md @@ -54,6 +54,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling TextPhysicalAddressAnnotationApi->create_text_physical_address_annotations: %s\n" % e) ``` + ### Parameters Name | Type | Description | Notes @@ -73,6 +74,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/TextPhysicalAddressAnnotationRequest.md b/docs/TextPhysicalAddressAnnotationRequest.md index 0a416726..65f18655 100644 --- a/docs/TextPhysicalAddressAnnotationRequest.md +++ b/docs/TextPhysicalAddressAnnotationRequest.md @@ -1,6 +1,7 @@ # TextPhysicalAddressAnnotationRequest A request to annotate physical addresses in a clinical note + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TextPhysicalAddressAnnotationResponse.md b/docs/TextPhysicalAddressAnnotationResponse.md index 51268b0c..7a041137 100644 --- a/docs/TextPhysicalAddressAnnotationResponse.md +++ b/docs/TextPhysicalAddressAnnotationResponse.md @@ -1,6 +1,7 @@ # TextPhysicalAddressAnnotationResponse The response to a physical addresses annotation request + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Tool.md b/docs/Tool.md index 5621e0c9..ec66da53 100644 --- a/docs/Tool.md +++ b/docs/Tool.md @@ -1,6 +1,7 @@ # Tool Information about an NLP tool + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ToolApi.md b/docs/ToolApi.md index c34dd35f..1fb5d7e7 100644 --- a/docs/ToolApi.md +++ b/docs/ToolApi.md @@ -45,6 +45,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling ToolApi->get_tool: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -61,6 +62,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -107,6 +109,7 @@ with nlpsandbox.ApiClient() as api_client: print("Exception when calling ToolApi->get_tool_dependencies: %s\n" % e) ``` + ### Parameters This endpoint does not need any parameter. @@ -123,6 +126,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json + ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| diff --git a/docs/ToolDependencies.md b/docs/ToolDependencies.md index 23d896b4..c8492b67 100644 --- a/docs/ToolDependencies.md +++ b/docs/ToolDependencies.md @@ -1,6 +1,7 @@ # ToolDependencies A list of tool dependencies + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ToolType.md b/docs/ToolType.md index b33c269e..3105c04d 100644 --- a/docs/ToolType.md +++ b/docs/ToolType.md @@ -1,6 +1,7 @@ # ToolType The type of this tool + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/examples/push_dataset.py b/examples/push_dataset.py index ccfb0311..7dbf7ace 100755 --- a/examples/push_dataset.py +++ b/examples/push_dataset.py @@ -13,17 +13,17 @@ """ import json -import nlpsandboxsdk -import nlpsandboxsdk.apis -import nlpsandboxsdk.models -from nlpsandboxsdk.rest import ApiException +import nlpsandbox +import nlpsandbox.apis +import nlpsandbox.models +from nlpsandbox.rest import ApiException import nlpsandboxclient.utils # Defining the host is optional and defaults to http://example.com/api/v1 # See configuration.py for a list of all supported configuration parameters. host = "http://localhost:8080/api/v1" -configuration = nlpsandboxsdk.Configuration(host=host) +configuration = nlpsandbox.Configuration(host=host) dataset_id = 'test-dataset' fhir_store_id = 'evaluation' @@ -31,13 +31,13 @@ json_filename = "example-patient-bundles.json" -with nlpsandboxsdk.ApiClient(configuration) as api_client: - dataset_api = nlpsandboxsdk.apis.DatasetApi(api_client) - fhir_store_api = nlpsandboxsdk.apis.FhirStoreApi(api_client) - annotation_store_api = nlpsandboxsdk.apis.AnnotationStoreApi(api_client) - patient_api = nlpsandboxsdk.apis.PatientApi(api_client) - note_api = nlpsandboxsdk.apis.NoteApi(api_client) - annotation_api = nlpsandboxsdk.apis.AnnotationApi(api_client) +with nlpsandbox.ApiClient(configuration) as api_client: + dataset_api = nlpsandbox.apis.DatasetApi(api_client) + fhir_store_api = nlpsandbox.apis.FhirStoreApi(api_client) + annotation_store_api = nlpsandbox.apis.AnnotationStoreApi(api_client) + patient_api = nlpsandbox.apis.PatientApi(api_client) + note_api = nlpsandbox.apis.NoteApi(api_client) + annotation_api = nlpsandbox.apis.AnnotationApi(api_client) # The example is always deleted try: diff --git a/nlpsandbox/model/annotation_id.py b/nlpsandbox/model/annotation_id.py index 79151070..3c1203c4 100644 --- a/nlpsandbox/model/annotation_id.py +++ b/nlpsandbox/model/annotation_id.py @@ -139,6 +139,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -154,7 +156,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/annotation_name.py b/nlpsandbox/model/annotation_name.py index 07c8c9b1..59ec4ca9 100644 --- a/nlpsandbox/model/annotation_name.py +++ b/nlpsandbox/model/annotation_name.py @@ -137,6 +137,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -152,7 +154,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/annotation_store_id.py b/nlpsandbox/model/annotation_store_id.py index e3f612d5..2d20e9e0 100644 --- a/nlpsandbox/model/annotation_store_id.py +++ b/nlpsandbox/model/annotation_store_id.py @@ -139,6 +139,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -154,7 +156,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/annotation_store_name.py b/nlpsandbox/model/annotation_store_name.py index ee60019b..e086c780 100644 --- a/nlpsandbox/model/annotation_store_name.py +++ b/nlpsandbox/model/annotation_store_name.py @@ -137,6 +137,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -152,7 +154,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/dataset_id.py b/nlpsandbox/model/dataset_id.py index 04a174c9..d6ca854c 100644 --- a/nlpsandbox/model/dataset_id.py +++ b/nlpsandbox/model/dataset_id.py @@ -139,6 +139,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -154,7 +156,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/dataset_name.py b/nlpsandbox/model/dataset_name.py index 5add404c..43621153 100644 --- a/nlpsandbox/model/dataset_name.py +++ b/nlpsandbox/model/dataset_name.py @@ -137,6 +137,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -152,7 +154,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/fhir_store_id.py b/nlpsandbox/model/fhir_store_id.py index bd23fe84..da25edfd 100644 --- a/nlpsandbox/model/fhir_store_id.py +++ b/nlpsandbox/model/fhir_store_id.py @@ -139,6 +139,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -154,7 +156,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/fhir_store_name.py b/nlpsandbox/model/fhir_store_name.py index ac421113..751387c8 100644 --- a/nlpsandbox/model/fhir_store_name.py +++ b/nlpsandbox/model/fhir_store_name.py @@ -137,6 +137,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -152,7 +154,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/license.py b/nlpsandbox/model/license.py index fa208484..16dd9456 100644 --- a/nlpsandbox/model/license.py +++ b/nlpsandbox/model/license.py @@ -169,6 +169,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -184,7 +186,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/note_id.py b/nlpsandbox/model/note_id.py index 061abcc7..e511be2e 100644 --- a/nlpsandbox/model/note_id.py +++ b/nlpsandbox/model/note_id.py @@ -139,6 +139,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -154,7 +156,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/note_resource_name.py b/nlpsandbox/model/note_resource_name.py index 2c00a07e..257fecf2 100644 --- a/nlpsandbox/model/note_resource_name.py +++ b/nlpsandbox/model/note_resource_name.py @@ -137,6 +137,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -152,7 +154,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/page_limit.py b/nlpsandbox/model/page_limit.py index aa1db850..dec89843 100644 --- a/nlpsandbox/model/page_limit.py +++ b/nlpsandbox/model/page_limit.py @@ -136,6 +136,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -147,7 +149,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/page_offset.py b/nlpsandbox/model/page_offset.py index 2861c9a5..14ef33f2 100644 --- a/nlpsandbox/model/page_offset.py +++ b/nlpsandbox/model/page_offset.py @@ -135,6 +135,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -146,7 +148,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/patient_id.py b/nlpsandbox/model/patient_id.py index 5029dbdb..5de6321b 100644 --- a/nlpsandbox/model/patient_id.py +++ b/nlpsandbox/model/patient_id.py @@ -139,6 +139,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -154,7 +156,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/patient_resource_name.py b/nlpsandbox/model/patient_resource_name.py index 28e8a166..2ea1f331 100644 --- a/nlpsandbox/model/patient_resource_name.py +++ b/nlpsandbox/model/patient_resource_name.py @@ -137,6 +137,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -152,7 +154,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model/tool_type.py b/nlpsandbox/model/tool_type.py index 29fb3869..e9912493 100644 --- a/nlpsandbox/model/tool_type.py +++ b/nlpsandbox/model/tool_type.py @@ -139,6 +139,8 @@ def __init__(self, *args, **kwargs): through its discriminator because we passed in _visited_composed_classes = (Animal,) """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) if 'value' in kwargs: value = kwargs.pop('value') @@ -154,7 +156,6 @@ def __init__(self, *args, **kwargs): _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) _configuration = kwargs.pop('_configuration', None) _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) diff --git a/nlpsandbox/model_utils.py b/nlpsandbox/model_utils.py index b24ed4d1..4fc90ce1 100644 --- a/nlpsandbox/model_utils.py +++ b/nlpsandbox/model_utils.py @@ -1494,13 +1494,19 @@ def model_to_dict(model_instance, serialize=True): # exist in attribute_map attr = model_instance.attribute_map.get(attr, attr) if isinstance(value, list): - if not value or isinstance(value[0], PRIMITIVE_TYPES): - # empty list or primitive types - result[attr] = value - elif isinstance(value[0], ModelSimple): - result[attr] = [x.value for x in value] - else: - result[attr] = [model_to_dict(x, serialize=serialize) for x in value] + if not value: + # empty list or None + result[attr] = value + else: + res = [] + for v in value: + if isinstance(v, PRIMITIVE_TYPES) or v is None: + res.append(v) + elif isinstance(v, ModelSimple): + res.append(v.value) + else: + res.append(model_to_dict(v, serialize=serialize)) + result[attr] = res elif isinstance(value, dict): result[attr] = dict(map( lambda item: (item[0], @@ -1560,11 +1566,16 @@ def get_valid_classes_phrase(input_classes): def convert_js_args_to_python_args(fn): from functools import wraps @wraps(fn) - def wrapped_init(self, *args, **kwargs): + def wrapped_init(_self, *args, **kwargs): + """ + An attribute named `self` received from the api will conflicts with the reserved `self` + parameter of a class method. During generation, `self` attributes are mapped + to `_self` in models. Here, we name `_self` instead of `self` to avoid conflicts. + """ spec_property_naming = kwargs.get('_spec_property_naming', False) if spec_property_naming: - kwargs = change_keys_js_to_python(kwargs, self.__class__) - return fn(self, *args, **kwargs) + kwargs = change_keys_js_to_python(kwargs, _self.__class__) + return fn(_self, *args, **kwargs) return wrapped_init