Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to schemas pr-262 #209

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 99 additions & 1 deletion .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ docs/PatientCreateRequest.md
docs/PatientCreateResponse.md
docs/PatientId.md
docs/PatientResourceName.md
docs/ProgrammingLanguage.md
docs/ResourceSource.md
docs/ResponsePageMetadata.md
docs/ResponsePageMetadataLinks.md
Expand Down Expand Up @@ -167,6 +168,7 @@ nlpsandbox/model/patient_create_request.py
nlpsandbox/model/patient_create_response.py
nlpsandbox/model/patient_id.py
nlpsandbox/model/patient_resource_name.py
nlpsandbox/model/programming_language.py
nlpsandbox/model/resource_source.py
nlpsandbox/model/response_page_metadata.py
nlpsandbox/model/response_page_metadata_links.py
Expand Down Expand Up @@ -199,5 +201,101 @@ nlpsandbox/model/tool_dependencies.py
nlpsandbox/model/tool_type.py
nlpsandbox/model_utils.py
nlpsandbox/models/__init__.py
nlpsandbox/rest.py
test/__init__.py
test/test_annotation.py
test/test_annotation_api.py
test/test_annotation_create_request.py
test/test_annotation_create_response.py
test/test_annotation_id.py
test/test_annotation_name.py
test/test_annotation_set.py
test/test_annotation_source.py
test/test_annotation_store.py
test/test_annotation_store_api.py
test/test_annotation_store_create_response.py
test/test_annotation_store_id.py
test/test_annotation_store_name.py
test/test_dataset.py
test/test_dataset_api.py
test/test_dataset_create_response.py
test/test_dataset_id.py
test/test_dataset_name.py
test/test_date_offset_config.py
test/test_deidentification_step.py
test/test_deidentified_note_api.py
test/test_deidentify_request.py
test/test_deidentify_response.py
test/test_error.py
test/test_fhir_store.py
test/test_fhir_store_api.py
test/test_fhir_store_create_response.py
test/test_fhir_store_id.py
test/test_fhir_store_name.py
test/test_health_check.py
test/test_health_check_api.py
test/test_license.py
test/test_masking_char_config.py
test/test_note.py
test/test_note_api.py
test/test_note_create_request.py
test/test_note_create_response.py
test/test_note_id.py
test/test_note_resource_name.py
test/test_page_limit.py
test/test_page_of_annotation_stores.py
test/test_page_of_annotation_stores_all_of.py
test/test_page_of_annotations.py
test/test_page_of_annotations_all_of.py
test/test_page_of_datasets.py
test/test_page_of_datasets_all_of.py
test/test_page_of_fhir_stores.py
test/test_page_of_fhir_stores_all_of.py
test/test_page_of_notes.py
test/test_page_of_notes_all_of.py
test/test_page_of_patients.py
test/test_page_of_patients_all_of.py
test/test_page_offset.py
test/test_patient.py
test/test_patient_api.py
test/test_patient_create_request.py
test/test_patient_create_response.py
test/test_patient_id.py
test/test_patient_resource_name.py
test/test_programming_language.py
test/test_resource_source.py
test/test_response_page_metadata.py
test/test_response_page_metadata_links.py
test/test_text_annotation.py
test/test_text_contact_annotation.py
test/test_text_contact_annotation_all_of.py
test/test_text_contact_annotation_api.py
test/test_text_contact_annotation_request.py
test/test_text_contact_annotation_response.py
test/test_text_covid_symptom_annotation.py
test/test_text_covid_symptom_annotation_all_of.py
test/test_text_covid_symptom_annotation_api.py
test/test_text_covid_symptom_annotation_request.py
test/test_text_covid_symptom_annotation_response.py
test/test_text_date_annotation.py
test/test_text_date_annotation_all_of.py
test/test_text_date_annotation_api.py
test/test_text_date_annotation_request.py
test/test_text_date_annotation_response.py
test/test_text_id_annotation.py
test/test_text_id_annotation_all_of.py
test/test_text_id_annotation_api.py
test/test_text_id_annotation_request.py
test/test_text_id_annotation_response.py
test/test_text_location_annotation.py
test/test_text_location_annotation_all_of.py
test/test_text_location_annotation_api.py
test/test_text_location_annotation_request.py
test/test_text_location_annotation_response.py
test/test_text_person_name_annotation.py
test/test_text_person_name_annotation_api.py
test/test_text_person_name_annotation_request.py
test/test_text_person_name_annotation_response.py
test/test_tool.py
test/test_tool_api.py
test/test_tool_dependencies.py
test/test_tool_type.py
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
5.1.1
5.3.0
1 change: 1 addition & 0 deletions docs/Annotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**text_id_annotations** | [**[TextIdAnnotation]**](TextIdAnnotation.md) | ID annotations in a text | [optional]
**text_contact_annotations** | [**[TextContactAnnotation]**](TextContactAnnotation.md) | Contact annotations in a text | [optional]
**text_covid_symptom_annotations** | [**[TextCovidSymptomAnnotation]**](TextCovidSymptomAnnotation.md) | COVID symptom annotations in a text | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
68 changes: 60 additions & 8 deletions docs/AnnotationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Create an annotation

### Example

* Api Key Authentication (ApiKeyAuth):

```python
import time
import nlpsandbox
Expand All @@ -36,9 +38,19 @@ configuration = nlpsandbox.Configuration(
host = "http://example.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with nlpsandbox.ApiClient() as api_client:
with nlpsandbox.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = annotation_api.AnnotationApi(api_client)
dataset_id = DatasetId("awesome-dataset") # DatasetId | The ID of the dataset
Expand Down Expand Up @@ -104,7 +116,7 @@ Name | Type | Description | Notes

### Authorization

No authorization required
[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

Expand All @@ -113,6 +125,7 @@ No authorization required


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Success | - |
Expand All @@ -131,6 +144,8 @@ Deletes the annotation specified

### Example

* Api Key Authentication (ApiKeyAuth):

```python
import time
import nlpsandbox
Expand All @@ -146,9 +161,19 @@ configuration = nlpsandbox.Configuration(
host = "http://example.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with nlpsandbox.ApiClient() as api_client:
with nlpsandbox.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = annotation_api.AnnotationApi(api_client)
dataset_id = DatasetId("awesome-dataset") # DatasetId | The ID of the dataset
Expand Down Expand Up @@ -179,7 +204,7 @@ Name | Type | Description | Notes

### Authorization

No authorization required
[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

Expand All @@ -188,6 +213,7 @@ No authorization required


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
Expand All @@ -205,6 +231,8 @@ Returns the annotation specified

### Example

* Api Key Authentication (ApiKeyAuth):

```python
import time
import nlpsandbox
Expand All @@ -221,9 +249,19 @@ configuration = nlpsandbox.Configuration(
host = "http://example.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with nlpsandbox.ApiClient() as api_client:
with nlpsandbox.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = annotation_api.AnnotationApi(api_client)
dataset_id = DatasetId("awesome-dataset") # DatasetId | The ID of the dataset
Expand Down Expand Up @@ -254,7 +292,7 @@ Name | Type | Description | Notes

### Authorization

No authorization required
[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

Expand All @@ -263,6 +301,7 @@ No authorization required


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
Expand All @@ -280,6 +319,8 @@ Returns the annotations in an annotation store

### Example

* Api Key Authentication (ApiKeyAuth):

```python
import time
import nlpsandbox
Expand All @@ -297,9 +338,19 @@ configuration = nlpsandbox.Configuration(
host = "http://example.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with nlpsandbox.ApiClient() as api_client:
with nlpsandbox.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = annotation_api.AnnotationApi(api_client)
dataset_id = DatasetId("awesome-dataset") # DatasetId | The ID of the dataset
Expand Down Expand Up @@ -341,7 +392,7 @@ Name | Type | Description | Notes

### Authorization

No authorization required
[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

Expand All @@ -350,6 +401,7 @@ No authorization required


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
Expand Down
1 change: 1 addition & 0 deletions docs/AnnotationCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**text_id_annotations** | [**[TextIdAnnotation]**](TextIdAnnotation.md) | ID annotations in a text | [optional]
**text_contact_annotations** | [**[TextContactAnnotation]**](TextContactAnnotation.md) | Contact annotations in a text | [optional]
**text_covid_symptom_annotations** | [**[TextCovidSymptomAnnotation]**](TextCovidSymptomAnnotation.md) | COVID symptom annotations in a text | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 1 addition & 0 deletions docs/AnnotationCreateResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The reference to the annotation created
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | [**AnnotationName**](AnnotationName.md) | |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 1 addition & 0 deletions docs/AnnotationSet.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**text_location_annotations** | [**[TextLocationAnnotation]**](TextLocationAnnotation.md) | Location annotations in a text |
**text_id_annotations** | [**[TextIdAnnotation]**](TextIdAnnotation.md) | ID annotations in a text |
**text_contact_annotations** | [**[TextContactAnnotation]**](TextContactAnnotation.md) | Contact annotations in a text |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 1 addition & 0 deletions docs/AnnotationSource.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The source of an annotation record
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**resource_source** | [**ResourceSource**](ResourceSource.md) | |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 1 addition & 0 deletions docs/AnnotationStore.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ An annotation store
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | [**AnnotationStoreName**](AnnotationStoreName.md) | |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
Loading