From c7c8b06a1c2ebe46a1a99cc6ffcf5fbd1c5cd370 Mon Sep 17 00:00:00 2001 From: Robrecht Cannoodt Date: Tue, 12 Nov 2024 08:05:13 +0100 Subject: [PATCH] Fixes to documentation to satisfy r cmd check (#3) * fix notes from r cmd check * remove documentation which could be generated by pkgdown * rerender readme * update script --- DESCRIPTION | 8 +- README.md | 55 +- README.qmd | 47 -- docs/DefaultApi.md | 1081 ------------------------------- docs/Dimension.md | 10 - docs/GetRecordRequestBody.md | 9 - docs/GetRecordsRequestBody.md | 12 - docs/GetValuesRequestBody.md | 11 - docs/GroupByRequestBody.md | 11 - docs/HTTPValidationError.md | 9 - docs/Measure.md | 11 - docs/OrderByColumn.md | 10 - docs/S3PermissionsRequest.md | 11 - docs/ValidationError.md | 11 - docs/ValidationErrorLocInner.md | 8 - update_package.sh | 5 +- 16 files changed, 10 insertions(+), 1299 deletions(-) delete mode 100644 docs/DefaultApi.md delete mode 100644 docs/Dimension.md delete mode 100644 docs/GetRecordRequestBody.md delete mode 100644 docs/GetRecordsRequestBody.md delete mode 100644 docs/GetValuesRequestBody.md delete mode 100644 docs/GroupByRequestBody.md delete mode 100644 docs/HTTPValidationError.md delete mode 100644 docs/Measure.md delete mode 100644 docs/OrderByColumn.md delete mode 100644 docs/S3PermissionsRequest.md delete mode 100644 docs/ValidationError.md delete mode 100644 docs/ValidationErrorLocInner.md diff --git a/DESCRIPTION b/DESCRIPTION index 6e8e3af..cc33e33 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,14 +2,12 @@ Package: laminr.api Title: Interface to the 'LaminDB' API Version: 0.1.0 Authors@R:c( - person("Robrecht", "Cannoodt", email = "robrecht@data-intuitive.com", role = c("aut", "cre"), - comment = c(ORCID = "0000-0003-3641-729X", github = "rcannood")), - person("Luke", "Zappia", email = "luke@data-intuitive.com", role = "aut", - comment = c(ORCID = "0000-0001-7744-8565", github = "lazappi")), + person("Robrecht", "Cannoodt", email = "robrecht@data-intuitive.com", role = c("aut", "cre")), + person("Luke", "Zappia", email = "luke@data-intuitive.com", role = "aut"), person("Data Intuitive", email = "info@data-intuitive.com", role = "aut"), person("Lamin Labs", email = "open-source@lamin.ai", role = c("aut", "cph")) ) -Description: Client package for accessing the Lamin API. +Description: A low-level interface to the 'LaminDB' API. License: Apache License (>= 2) URL: https://github.com/data-intuitive/laminr.api BugReports: https://github.com/data-intuitive/laminr.api/issues diff --git a/README.md b/README.md index 9d95136..0812242 100644 --- a/README.md +++ b/README.md @@ -105,13 +105,9 @@ names(schema) names(schema$core) ``` - [1] "run" "user" "param" - [4] "ulabel" "feature" "storage" - [7] "artifact" "transform" "collection" - [10] "featureset" "paramvalue" "featurevalue" - [13] "runparamvalue" "artifactulabel" "collectionulabel" - [16] "featuresetfeature" "artifactfeatureset" "artifactparamvalue" - [19] "collectionartifact" "artifactfeaturevalue" + [1] "run" "user" "param" "ulabel" "feature" "storage" "artifact" + [8] "transform" "collection" "featureset" "paramvalue" "featurevalue" "runparamvalue" "artifactulabel" + [15] "collectionulabel" "featuresetfeature" "artifactfeatureset" "artifactparamvalue" "collectionartifact" "artifactfeaturevalue" Get record: @@ -191,48 +187,3 @@ api$GetRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost( $suffix [1] ".h5ad" - -## Documentation for API Endpoints - -All URIs are relative to *http://localhost* - -| Class | Method | HTTP request | Description | -|----|----|----|----| -| *DefaultApi* | [**AddCollaboratorInstancesInstanceIdCollaboratorsAccountIdPut**](docs/DefaultApi.md#AddCollaboratorInstancesInstanceIdCollaboratorsAccountIdPut) | **PUT** /instances/{instance_id}/collaborators/{account_id} | Add Collaborator | -| *DefaultApi* | [**CreateInstanceInstancesPut**](docs/DefaultApi.md#CreateInstanceInstancesPut) | **PUT** /instances | Create Instance | -| *DefaultApi* | [**CreateRecordInstancesInstanceIdModulesModuleNameModelNamePut**](docs/DefaultApi.md#CreateRecordInstancesInstanceIdModulesModuleNameModelNamePut) | **PUT** /instances/{instance_id}/modules/{module_name}/{model_name} | Create Record | -| *DefaultApi* | [**DeleteCollaboratorInstancesInstanceIdCollaboratorsAccountIdDelete**](docs/DefaultApi.md#DeleteCollaboratorInstancesInstanceIdCollaboratorsAccountIdDelete) | **DELETE** /instances/{instance_id}/collaborators/{account_id} | Delete Collaborator | -| *DefaultApi* | [**DeleteInstanceInstancesInstanceIdDelete**](docs/DefaultApi.md#DeleteInstanceInstancesInstanceIdDelete) | **DELETE** /instances/{instance_id} | Delete Instance | -| *DefaultApi* | [**DeleteRecordInstancesInstanceIdModulesModuleNameModelNameUidDelete**](docs/DefaultApi.md#DeleteRecordInstancesInstanceIdModulesModuleNameModelNameUidDelete) | **DELETE** /instances/{instance_id}/modules/{module_name}/{model_name}/{uid} | Delete Record | -| *DefaultApi* | [**GeneratePasswordInstancesInstanceIdDbPasswordGet**](docs/DefaultApi.md#GeneratePasswordInstancesInstanceIdDbPasswordGet) | **GET** /instances/{instance_id}/db/password | Generate Password | -| *DefaultApi* | [**GenerateUrlInstancesInstanceIdDbUrlGet**](docs/DefaultApi.md#GenerateUrlInstancesInstanceIdDbUrlGet) | **GET** /instances/{instance_id}/db/url | Generate Url | -| *DefaultApi* | [**GetInstanceStatisticsInstancesInstanceIdStatisticsGet**](docs/DefaultApi.md#GetInstanceStatisticsInstancesInstanceIdStatisticsGet) | **GET** /instances/{instance_id}/statistics | Get Instance Statistics | -| *DefaultApi* | [**GetNonEmptyTablesInstancesInstanceIdNonEmptyTablesGet**](docs/DefaultApi.md#GetNonEmptyTablesInstancesInstanceIdNonEmptyTablesGet) | **GET** /instances/{instance_id}/non_empty_tables | Get Non Empty Tables | -| *DefaultApi* | [**GetRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost**](docs/DefaultApi.md#GetRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost) | **POST** /instances/{instance_id}/modules/{module_name}/{model_name}/{id_or_uid} | Get Record | -| *DefaultApi* | [**GetRecordsInstancesInstanceIdModulesModuleNameModelNamePost**](docs/DefaultApi.md#GetRecordsInstancesInstanceIdModulesModuleNameModelNamePost) | **POST** /instances/{instance_id}/modules/{module_name}/{model_name} | Get Records | -| *DefaultApi* | [**GetRelationsInstancesInstanceIdSchemaModuleNameModelNameGet**](docs/DefaultApi.md#GetRelationsInstancesInstanceIdSchemaModuleNameModelNameGet) | **GET** /instances/{instance_id}/schema/{module_name}/{model_name} | Get Relations | -| *DefaultApi* | [**GetSchemaInstancesInstanceIdSchemaGet**](docs/DefaultApi.md#GetSchemaInstancesInstanceIdSchemaGet) | **GET** /instances/{instance_id}/schema | Get Schema | -| *DefaultApi* | [**GetValuesInstancesInstanceIdModulesModuleNameModelNameFieldsFieldPathPost**](docs/DefaultApi.md#GetValuesInstancesInstanceIdModulesModuleNameModelNameFieldsFieldPathPost) | **POST** /instances/{instance_id}/modules/{module_name}/{model_name}/fields/{field_path} | Get Values | -| *DefaultApi* | [**GrantS3PermissionsStoragesS3BucketNamePermissionsPut**](docs/DefaultApi.md#GrantS3PermissionsStoragesS3BucketNamePermissionsPut) | **PUT** /storages/s3/{bucket_name}/permissions | Grant S3 Permissions | -| *DefaultApi* | [**GroupByInstancesInstanceIdModulesModuleNameModelNameGroupByPost**](docs/DefaultApi.md#GroupByInstancesInstanceIdModulesModuleNameModelNameGroupByPost) | **POST** /instances/{instance_id}/modules/{module_name}/{model_name}/group-by | Group By | -| *DefaultApi* | [**TransferOwnershipInstancesInstanceIdOwnerHandlePatch**](docs/DefaultApi.md#TransferOwnershipInstancesInstanceIdOwnerHandlePatch) | **PATCH** /instances/{instance_id}/owner/{handle} | Transfer Ownership | -| *DefaultApi* | [**UpdateCollaboratorInstancesInstanceIdCollaboratorsAccountIdPatch**](docs/DefaultApi.md#UpdateCollaboratorInstancesInstanceIdCollaboratorsAccountIdPatch) | **PATCH** /instances/{instance_id}/collaborators/{account_id} | Update Collaborator | -| *DefaultApi* | [**UpdateRecordInstancesInstanceIdModulesModuleNameModelNameUidPatch**](docs/DefaultApi.md#UpdateRecordInstancesInstanceIdModulesModuleNameModelNameUidPatch) | **PATCH** /instances/{instance_id}/modules/{module_name}/{model_name}/{uid} | Update Record | - -## Documentation for Models - -- [Dimension](docs/Dimension.md) -- [GetRecordRequestBody](docs/GetRecordRequestBody.md) -- [GetRecordsRequestBody](docs/GetRecordsRequestBody.md) -- [GetValuesRequestBody](docs/GetValuesRequestBody.md) -- [GroupByRequestBody](docs/GroupByRequestBody.md) -- [HTTPValidationError](docs/HTTPValidationError.md) -- [Measure](docs/Measure.md) -- [OrderByColumn](docs/OrderByColumn.md) -- [S3PermissionsRequest](docs/S3PermissionsRequest.md) -- [ValidationError](docs/ValidationError.md) -- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md) - -## Documentation for Authorization - -Endpoints do not require authorization. diff --git a/README.qmd b/README.qmd index d2af5a9..15d887a 100644 --- a/README.qmd +++ b/README.qmd @@ -61,50 +61,3 @@ api$GetRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost( include_foreign_keys = TRUE ) ``` - -## Documentation for API Endpoints - -All URIs are relative to *http://localhost* - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*DefaultApi* | [**AddCollaboratorInstancesInstanceIdCollaboratorsAccountIdPut**](docs/DefaultApi.md#AddCollaboratorInstancesInstanceIdCollaboratorsAccountIdPut) | **PUT** /instances/{instance_id}/collaborators/{account_id} | Add Collaborator -*DefaultApi* | [**CreateInstanceInstancesPut**](docs/DefaultApi.md#CreateInstanceInstancesPut) | **PUT** /instances | Create Instance -*DefaultApi* | [**CreateRecordInstancesInstanceIdModulesModuleNameModelNamePut**](docs/DefaultApi.md#CreateRecordInstancesInstanceIdModulesModuleNameModelNamePut) | **PUT** /instances/{instance_id}/modules/{module_name}/{model_name} | Create Record -*DefaultApi* | [**DeleteCollaboratorInstancesInstanceIdCollaboratorsAccountIdDelete**](docs/DefaultApi.md#DeleteCollaboratorInstancesInstanceIdCollaboratorsAccountIdDelete) | **DELETE** /instances/{instance_id}/collaborators/{account_id} | Delete Collaborator -*DefaultApi* | [**DeleteInstanceInstancesInstanceIdDelete**](docs/DefaultApi.md#DeleteInstanceInstancesInstanceIdDelete) | **DELETE** /instances/{instance_id} | Delete Instance -*DefaultApi* | [**DeleteRecordInstancesInstanceIdModulesModuleNameModelNameUidDelete**](docs/DefaultApi.md#DeleteRecordInstancesInstanceIdModulesModuleNameModelNameUidDelete) | **DELETE** /instances/{instance_id}/modules/{module_name}/{model_name}/{uid} | Delete Record -*DefaultApi* | [**GeneratePasswordInstancesInstanceIdDbPasswordGet**](docs/DefaultApi.md#GeneratePasswordInstancesInstanceIdDbPasswordGet) | **GET** /instances/{instance_id}/db/password | Generate Password -*DefaultApi* | [**GenerateUrlInstancesInstanceIdDbUrlGet**](docs/DefaultApi.md#GenerateUrlInstancesInstanceIdDbUrlGet) | **GET** /instances/{instance_id}/db/url | Generate Url -*DefaultApi* | [**GetInstanceStatisticsInstancesInstanceIdStatisticsGet**](docs/DefaultApi.md#GetInstanceStatisticsInstancesInstanceIdStatisticsGet) | **GET** /instances/{instance_id}/statistics | Get Instance Statistics -*DefaultApi* | [**GetNonEmptyTablesInstancesInstanceIdNonEmptyTablesGet**](docs/DefaultApi.md#GetNonEmptyTablesInstancesInstanceIdNonEmptyTablesGet) | **GET** /instances/{instance_id}/non_empty_tables | Get Non Empty Tables -*DefaultApi* | [**GetRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost**](docs/DefaultApi.md#GetRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost) | **POST** /instances/{instance_id}/modules/{module_name}/{model_name}/{id_or_uid} | Get Record -*DefaultApi* | [**GetRecordsInstancesInstanceIdModulesModuleNameModelNamePost**](docs/DefaultApi.md#GetRecordsInstancesInstanceIdModulesModuleNameModelNamePost) | **POST** /instances/{instance_id}/modules/{module_name}/{model_name} | Get Records -*DefaultApi* | [**GetRelationsInstancesInstanceIdSchemaModuleNameModelNameGet**](docs/DefaultApi.md#GetRelationsInstancesInstanceIdSchemaModuleNameModelNameGet) | **GET** /instances/{instance_id}/schema/{module_name}/{model_name} | Get Relations -*DefaultApi* | [**GetSchemaInstancesInstanceIdSchemaGet**](docs/DefaultApi.md#GetSchemaInstancesInstanceIdSchemaGet) | **GET** /instances/{instance_id}/schema | Get Schema -*DefaultApi* | [**GetValuesInstancesInstanceIdModulesModuleNameModelNameFieldsFieldPathPost**](docs/DefaultApi.md#GetValuesInstancesInstanceIdModulesModuleNameModelNameFieldsFieldPathPost) | **POST** /instances/{instance_id}/modules/{module_name}/{model_name}/fields/{field_path} | Get Values -*DefaultApi* | [**GrantS3PermissionsStoragesS3BucketNamePermissionsPut**](docs/DefaultApi.md#GrantS3PermissionsStoragesS3BucketNamePermissionsPut) | **PUT** /storages/s3/{bucket_name}/permissions | Grant S3 Permissions -*DefaultApi* | [**GroupByInstancesInstanceIdModulesModuleNameModelNameGroupByPost**](docs/DefaultApi.md#GroupByInstancesInstanceIdModulesModuleNameModelNameGroupByPost) | **POST** /instances/{instance_id}/modules/{module_name}/{model_name}/group-by | Group By -*DefaultApi* | [**TransferOwnershipInstancesInstanceIdOwnerHandlePatch**](docs/DefaultApi.md#TransferOwnershipInstancesInstanceIdOwnerHandlePatch) | **PATCH** /instances/{instance_id}/owner/{handle} | Transfer Ownership -*DefaultApi* | [**UpdateCollaboratorInstancesInstanceIdCollaboratorsAccountIdPatch**](docs/DefaultApi.md#UpdateCollaboratorInstancesInstanceIdCollaboratorsAccountIdPatch) | **PATCH** /instances/{instance_id}/collaborators/{account_id} | Update Collaborator -*DefaultApi* | [**UpdateRecordInstancesInstanceIdModulesModuleNameModelNameUidPatch**](docs/DefaultApi.md#UpdateRecordInstancesInstanceIdModulesModuleNameModelNameUidPatch) | **PATCH** /instances/{instance_id}/modules/{module_name}/{model_name}/{uid} | Update Record - - -## Documentation for Models - - - [Dimension](docs/Dimension.md) - - [GetRecordRequestBody](docs/GetRecordRequestBody.md) - - [GetRecordsRequestBody](docs/GetRecordsRequestBody.md) - - [GetValuesRequestBody](docs/GetValuesRequestBody.md) - - [GroupByRequestBody](docs/GroupByRequestBody.md) - - [HTTPValidationError](docs/HTTPValidationError.md) - - [Measure](docs/Measure.md) - - [OrderByColumn](docs/OrderByColumn.md) - - [S3PermissionsRequest](docs/S3PermissionsRequest.md) - - [ValidationError](docs/ValidationError.md) - - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md) - - -## Documentation for Authorization - -Endpoints do not require authorization. diff --git a/docs/DefaultApi.md b/docs/DefaultApi.md deleted file mode 100644 index 1d2df4c..0000000 --- a/docs/DefaultApi.md +++ /dev/null @@ -1,1081 +0,0 @@ -# DefaultApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**AddCollaboratorInstancesInstanceIdCollaboratorsAccountIdPut**](DefaultApi.md#AddCollaboratorInstancesInstanceIdCollaboratorsAccountIdPut) | **PUT** /instances/{instance_id}/collaborators/{account_id} | Add Collaborator -[**CreateInstanceInstancesPut**](DefaultApi.md#CreateInstanceInstancesPut) | **PUT** /instances | Create Instance -[**CreateRecordInstancesInstanceIdModulesModuleNameModelNamePut**](DefaultApi.md#CreateRecordInstancesInstanceIdModulesModuleNameModelNamePut) | **PUT** /instances/{instance_id}/modules/{module_name}/{model_name} | Create Record -[**DeleteCollaboratorInstancesInstanceIdCollaboratorsAccountIdDelete**](DefaultApi.md#DeleteCollaboratorInstancesInstanceIdCollaboratorsAccountIdDelete) | **DELETE** /instances/{instance_id}/collaborators/{account_id} | Delete Collaborator -[**DeleteInstanceInstancesInstanceIdDelete**](DefaultApi.md#DeleteInstanceInstancesInstanceIdDelete) | **DELETE** /instances/{instance_id} | Delete Instance -[**DeleteRecordInstancesInstanceIdModulesModuleNameModelNameUidDelete**](DefaultApi.md#DeleteRecordInstancesInstanceIdModulesModuleNameModelNameUidDelete) | **DELETE** /instances/{instance_id}/modules/{module_name}/{model_name}/{uid} | Delete Record -[**GeneratePasswordInstancesInstanceIdDbPasswordGet**](DefaultApi.md#GeneratePasswordInstancesInstanceIdDbPasswordGet) | **GET** /instances/{instance_id}/db/password | Generate Password -[**GenerateUrlInstancesInstanceIdDbUrlGet**](DefaultApi.md#GenerateUrlInstancesInstanceIdDbUrlGet) | **GET** /instances/{instance_id}/db/url | Generate Url -[**GetInstanceStatisticsInstancesInstanceIdStatisticsGet**](DefaultApi.md#GetInstanceStatisticsInstancesInstanceIdStatisticsGet) | **GET** /instances/{instance_id}/statistics | Get Instance Statistics -[**GetNonEmptyTablesInstancesInstanceIdNonEmptyTablesGet**](DefaultApi.md#GetNonEmptyTablesInstancesInstanceIdNonEmptyTablesGet) | **GET** /instances/{instance_id}/non_empty_tables | Get Non Empty Tables -[**GetRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost**](DefaultApi.md#GetRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost) | **POST** /instances/{instance_id}/modules/{module_name}/{model_name}/{id_or_uid} | Get Record -[**GetRecordsInstancesInstanceIdModulesModuleNameModelNamePost**](DefaultApi.md#GetRecordsInstancesInstanceIdModulesModuleNameModelNamePost) | **POST** /instances/{instance_id}/modules/{module_name}/{model_name} | Get Records -[**GetRelationCountsInstancesInstanceIdModulesModuleNameModelNameIdCountsGet**](DefaultApi.md#GetRelationCountsInstancesInstanceIdModulesModuleNameModelNameIdCountsGet) | **GET** /instances/{instance_id}/modules/{module_name}/{model_name}/{id}/counts | Get Relation Counts -[**GetRelationsInstancesInstanceIdSchemaModuleNameModelNameGet**](DefaultApi.md#GetRelationsInstancesInstanceIdSchemaModuleNameModelNameGet) | **GET** /instances/{instance_id}/schema/{module_name}/{model_name} | Get Relations -[**GetSchemaInstancesInstanceIdSchemaGet**](DefaultApi.md#GetSchemaInstancesInstanceIdSchemaGet) | **GET** /instances/{instance_id}/schema | Get Schema -[**GetValuesInstancesInstanceIdModulesModuleNameModelNameFieldsFieldPathPost**](DefaultApi.md#GetValuesInstancesInstanceIdModulesModuleNameModelNameFieldsFieldPathPost) | **POST** /instances/{instance_id}/modules/{module_name}/{model_name}/fields/{field_path} | Get Values -[**GrantS3PermissionsStoragesS3BucketNamePermissionsPut**](DefaultApi.md#GrantS3PermissionsStoragesS3BucketNamePermissionsPut) | **PUT** /storages/s3/{bucket_name}/permissions | Grant S3 Permissions -[**GroupByInstancesInstanceIdModulesModuleNameModelNameGroupByPost**](DefaultApi.md#GroupByInstancesInstanceIdModulesModuleNameModelNameGroupByPost) | **POST** /instances/{instance_id}/modules/{module_name}/{model_name}/group-by | Group By -[**TransferOwnershipInstancesInstanceIdOwnerHandlePatch**](DefaultApi.md#TransferOwnershipInstancesInstanceIdOwnerHandlePatch) | **PATCH** /instances/{instance_id}/owner/{handle} | Transfer Ownership -[**UpdateCollaboratorInstancesInstanceIdCollaboratorsAccountIdPatch**](DefaultApi.md#UpdateCollaboratorInstancesInstanceIdCollaboratorsAccountIdPatch) | **PATCH** /instances/{instance_id}/collaborators/{account_id} | Update Collaborator -[**UpdateRecordInstancesInstanceIdModulesModuleNameModelNameUidPatch**](DefaultApi.md#UpdateRecordInstancesInstanceIdModulesModuleNameModelNameUidPatch) | **PATCH** /instances/{instance_id}/modules/{module_name}/{model_name}/{uid} | Update Record - - -# **AddCollaboratorInstancesInstanceIdCollaboratorsAccountIdPut** -> AnyType AddCollaboratorInstancesInstanceIdCollaboratorsAccountIdPut(instance_id, account_id, schema_id, role = "read", authorization = var.authorization) - -Add Collaborator - -### Example -```R -library(laminr.api) - -# Add Collaborator -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_account_id <- "account_id_example" # character | -var_schema_id <- "schema_id_example" # character | -var_role <- "read" # character | (Optional) -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **account_id** | **character**| | - **schema_id** | **character**| | - **role** | Enum [admin, write, read] | | [optional] [default to "read"] - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **CreateInstanceInstancesPut** -> AnyType CreateInstanceInstancesPut(name, storage = "create-s3", schema_str = var.schema_str, db_server_key = var.db_server_key, db_server_url = var.db_server_url, authorization = var.authorization) - -Create Instance - -### Example -```R -library(laminr.api) - -# Create Instance -# -# prepare function argument(s) -var_name <- "name_example" # character | -var_storage <- "create-s3" # character | (Optional) -var_schema_str <- "schema_str_example" # character | (Optional) -var_db_server_key <- "db_server_key_example" # character | (Optional) -var_db_server_url <- "db_server_url_example" # character | (Optional) -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **character**| | - **storage** | **character**| | [optional] [default to "create-s3"] - **schema_str** | **character**| | [optional] - **db_server_key** | **character**| | [optional] - **db_server_url** | **character**| | [optional] - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **CreateRecordInstancesInstanceIdModulesModuleNameModelNamePut** -> AnyType CreateRecordInstancesInstanceIdModulesModuleNameModelNamePut(instance_id, module_name, model_name, schema_id, body, authorization = var.authorization) - -Create Record - -### Example -```R -library(laminr.api) - -# Create Record -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_module_name <- "module_name_example" # character | -var_model_name <- "model_name_example" # character | -var_schema_id <- "schema_id_example" # character | -var_body <- TODO # AnyType | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **module_name** | **character**| | - **model_name** | **character**| | - **schema_id** | **character**| | - **body** | **AnyType**| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **DeleteCollaboratorInstancesInstanceIdCollaboratorsAccountIdDelete** -> AnyType DeleteCollaboratorInstancesInstanceIdCollaboratorsAccountIdDelete(instance_id, account_id, authorization = var.authorization) - -Delete Collaborator - -### Example -```R -library(laminr.api) - -# Delete Collaborator -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_account_id <- "account_id_example" # character | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **account_id** | **character**| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **DeleteInstanceInstancesInstanceIdDelete** -> AnyType DeleteInstanceInstancesInstanceIdDelete(instance_id, instance_name, authorization = var.authorization) - -Delete Instance - -### Example -```R -library(laminr.api) - -# Delete Instance -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_instance_name <- "instance_name_example" # character | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **instance_name** | **character**| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **DeleteRecordInstancesInstanceIdModulesModuleNameModelNameUidDelete** -> AnyType DeleteRecordInstancesInstanceIdModulesModuleNameModelNameUidDelete(instance_id, module_name, model_name, uid, schema_id, authorization = var.authorization) - -Delete Record - -### Example -```R -library(laminr.api) - -# Delete Record -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_module_name <- "module_name_example" # character | -var_model_name <- "model_name_example" # character | -var_uid <- "uid_example" # character | -var_schema_id <- "schema_id_example" # character | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **module_name** | **character**| | - **model_name** | **character**| | - **uid** | **character**| | - **schema_id** | **character**| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **GeneratePasswordInstancesInstanceIdDbPasswordGet** -> AnyType GeneratePasswordInstancesInstanceIdDbPasswordGet(instance_id, authorization = var.authorization) - -Generate Password - -### Example -```R -library(laminr.api) - -# Generate Password -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **GenerateUrlInstancesInstanceIdDbUrlGet** -> AnyType GenerateUrlInstancesInstanceIdDbUrlGet(instance_id, authorization = var.authorization) - -Generate Url - -### Example -```R -library(laminr.api) - -# Generate Url -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **GetInstanceStatisticsInstancesInstanceIdStatisticsGet** -> AnyType GetInstanceStatisticsInstancesInstanceIdStatisticsGet(instance_id, schema_id, q = var.q, authorization = var.authorization) - -Get Instance Statistics - -### Example -```R -library(laminr.api) - -# Get Instance Statistics -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_schema_id <- "schema_id_example" # character | -var_q <- c("inner_example") # array[character] | In ${module}.${model} format (case-sensitive) (Optional) -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **schema_id** | **character**| | - **q** | list( **character** )| In ${module}.${model} format (case-sensitive) | [optional] - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **GetNonEmptyTablesInstancesInstanceIdNonEmptyTablesGet** -> AnyType GetNonEmptyTablesInstancesInstanceIdNonEmptyTablesGet(instance_id, schema_id, authorization = var.authorization) - -Get Non Empty Tables - -### Example -```R -library(laminr.api) - -# Get Non Empty Tables -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_schema_id <- "schema_id_example" # character | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **schema_id** | **character**| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **GetRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost** -> AnyType GetRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost(instance_id, module_name, model_name, id_or_uid, schema_id, limit_to_many = 10, include_foreign_keys = FALSE, authorization = var.authorization, get_record_request_body = var.get_record_request_body) - -Get Record - -### Example -```R -library(laminr.api) - -# Get Record -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_module_name <- "module_name_example" # character | -var_model_name <- "model_name_example" # character | -var_id_or_uid <- "id_or_uid_example" # character | -var_schema_id <- "schema_id_example" # character | -var_limit_to_many <- 10 # integer | (Optional) -var_include_foreign_keys <- FALSE # character | (Optional) -var_authorization <- "authorization_example" # character | (Optional) -var_get_record_request_body <- GetRecordRequestBody$new(c("select_example")) # GetRecordRequestBody | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **module_name** | **character**| | - **model_name** | **character**| | - **id_or_uid** | **character**| | - **schema_id** | **character**| | - **limit_to_many** | **integer**| | [optional] [default to 10] - **include_foreign_keys** | **character**| | [optional] [default to FALSE] - **authorization** | **character**| | [optional] - **get_record_request_body** | [**GetRecordRequestBody**](GetRecordRequestBody.md)| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **GetRecordsInstancesInstanceIdModulesModuleNameModelNamePost** -> AnyType GetRecordsInstancesInstanceIdModulesModuleNameModelNamePost(instance_id, module_name, model_name, schema_id, limit = 50, offset = 0, limit_to_many = 10, include_foreign_keys = FALSE, authorization = var.authorization, get_records_request_body = var.get_records_request_body) - -Get Records - -### Example -```R -library(laminr.api) - -# Get Records -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_module_name <- "module_name_example" # character | -var_model_name <- "model_name_example" # character | -var_schema_id <- "schema_id_example" # character | -var_limit <- 50 # integer | (Optional) -var_offset <- 0 # integer | (Optional) -var_limit_to_many <- 10 # integer | (Optional) -var_include_foreign_keys <- FALSE # character | (Optional) -var_authorization <- "authorization_example" # character | (Optional) -var_get_records_request_body <- GetRecordsRequestBody$new(c("select_example"), 123, c(OrderByColumn$new("field_example", "descending_example")), "search_example") # GetRecordsRequestBody | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **module_name** | **character**| | - **model_name** | **character**| | - **schema_id** | **character**| | - **limit** | **integer**| | [optional] [default to 50] - **offset** | **integer**| | [optional] [default to 0] - **limit_to_many** | **integer**| | [optional] [default to 10] - **include_foreign_keys** | **character**| | [optional] [default to FALSE] - **authorization** | **character**| | [optional] - **get_records_request_body** | [**GetRecordsRequestBody**](GetRecordsRequestBody.md)| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **GetRelationCountsInstancesInstanceIdModulesModuleNameModelNameIdCountsGet** -> AnyType GetRelationCountsInstancesInstanceIdModulesModuleNameModelNameIdCountsGet(instance_id, module_name, model_name, id, schema_id, authorization = var.authorization) - -Get Relation Counts - -### Example -```R -library(laminr.api) - -# Get Relation Counts -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_module_name <- "module_name_example" # character | -var_model_name <- "model_name_example" # character | -var_id <- 56 # integer | -var_schema_id <- "schema_id_example" # character | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **module_name** | **character**| | - **model_name** | **character**| | - **id** | **integer**| | - **schema_id** | **character**| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **GetRelationsInstancesInstanceIdSchemaModuleNameModelNameGet** -> AnyType GetRelationsInstancesInstanceIdSchemaModuleNameModelNameGet(module_name, model_name, instance_id, authorization = var.authorization) - -Get Relations - -### Example -```R -library(laminr.api) - -# Get Relations -# -# prepare function argument(s) -var_module_name <- "module_name_example" # character | -var_model_name <- "model_name_example" # character | -var_instance_id <- "instance_id_example" # character | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **module_name** | **character**| | - **model_name** | **character**| | - **instance_id** | **character**| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **GetSchemaInstancesInstanceIdSchemaGet** -> AnyType GetSchemaInstancesInstanceIdSchemaGet(instance_id, authorization = var.authorization) - -Get Schema - -### Example -```R -library(laminr.api) - -# Get Schema -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **GetValuesInstancesInstanceIdModulesModuleNameModelNameFieldsFieldPathPost** -> AnyType GetValuesInstancesInstanceIdModulesModuleNameModelNameFieldsFieldPathPost(instance_id, module_name, model_name, field_path, schema_id, limit = 50, offset = 0, authorization = var.authorization, get_values_request_body = var.get_values_request_body) - -Get Values - -### Example -```R -library(laminr.api) - -# Get Values -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_module_name <- "module_name_example" # character | -var_model_name <- "model_name_example" # character | -var_field_path <- "field_path_example" # character | -var_schema_id <- "schema_id_example" # character | -var_limit <- 50 # integer | (Optional) -var_offset <- 0 # integer | (Optional) -var_authorization <- "authorization_example" # character | (Optional) -var_get_values_request_body <- GetValuesRequestBody$new(123, c(OrderByColumn$new("field_example", "descending_example")), "search_example") # GetValuesRequestBody | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **module_name** | **character**| | - **model_name** | **character**| | - **field_path** | **character**| | - **schema_id** | **character**| | - **limit** | **integer**| | [optional] [default to 50] - **offset** | **integer**| | [optional] [default to 0] - **authorization** | **character**| | [optional] - **get_values_request_body** | [**GetValuesRequestBody**](GetValuesRequestBody.md)| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **GrantS3PermissionsStoragesS3BucketNamePermissionsPut** -> AnyType GrantS3PermissionsStoragesS3BucketNamePermissionsPut(bucket_name, s3_permissions_request, aws_account_id = "767398070972", aws_user_name = "lamin-manager", authorization = var.authorization) - -Grant S3 Permissions - -### Example -```R -library(laminr.api) - -# Grant S3 Permissions -# -# prepare function argument(s) -var_bucket_name <- "bucket_name_example" # character | -var_s3_permissions_request <- S3PermissionsRequest$new("aws_access_key_id_example", "aws_secret_access_key_example", "region_example") # S3PermissionsRequest | -var_aws_account_id <- "767398070972" # character | (Optional) -var_aws_user_name <- "lamin-manager" # character | (Optional) -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **bucket_name** | **character**| | - **s3_permissions_request** | [**S3PermissionsRequest**](S3PermissionsRequest.md)| | - **aws_account_id** | **character**| | [optional] [default to "767398070972"] - **aws_user_name** | **character**| | [optional] [default to "lamin-manager"] - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **GroupByInstancesInstanceIdModulesModuleNameModelNameGroupByPost** -> AnyType GroupByInstancesInstanceIdModulesModuleNameModelNameGroupByPost(instance_id, module_name, model_name, schema_id, group_by_request_body, authorization = var.authorization) - -Group By - -### Example -```R -library(laminr.api) - -# Group By -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_module_name <- "module_name_example" # character | -var_model_name <- "model_name_example" # character | -var_schema_id <- "schema_id_example" # character | -var_group_by_request_body <- GroupByRequestBody$new(c(Dimension$new("field_name_example", "count")), c(Measure$new("field_name_example", "count", "alias_example")), 123) # GroupByRequestBody | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **module_name** | **character**| | - **model_name** | **character**| | - **schema_id** | **character**| | - **group_by_request_body** | [**GroupByRequestBody**](GroupByRequestBody.md)| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **TransferOwnershipInstancesInstanceIdOwnerHandlePatch** -> AnyType TransferOwnershipInstancesInstanceIdOwnerHandlePatch(instance_id, handle, schema_id, authorization = var.authorization) - -Transfer Ownership - -### Example -```R -library(laminr.api) - -# Transfer Ownership -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_handle <- "handle_example" # character | -var_schema_id <- "schema_id_example" # character | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **handle** | **character**| | - **schema_id** | **character**| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **UpdateCollaboratorInstancesInstanceIdCollaboratorsAccountIdPatch** -> AnyType UpdateCollaboratorInstancesInstanceIdCollaboratorsAccountIdPatch(instance_id, account_id, role, authorization = var.authorization) - -Update Collaborator - -### Example -```R -library(laminr.api) - -# Update Collaborator -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_account_id <- "account_id_example" # character | -var_role <- "role_example" # character | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **account_id** | **character**| | - **role** | Enum [admin, write, read] | | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - -# **UpdateRecordInstancesInstanceIdModulesModuleNameModelNameUidPatch** -> AnyType UpdateRecordInstancesInstanceIdModulesModuleNameModelNameUidPatch(instance_id, module_name, model_name, uid, schema_id, body, authorization = var.authorization) - -Update Record - -### Example -```R -library(laminr.api) - -# Update Record -# -# prepare function argument(s) -var_instance_id <- "instance_id_example" # character | -var_module_name <- "module_name_example" # character | -var_model_name <- "model_name_example" # character | -var_uid <- "uid_example" # character | -var_schema_id <- "schema_id_example" # character | -var_body <- TODO # AnyType | -var_authorization <- "authorization_example" # character | (Optional) - -api_instance <- DefaultApi$new() -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **character**| | - **module_name** | **character**| | - **model_name** | **character**| | - **uid** | **character**| | - **schema_id** | **character**| | - **body** | **AnyType**| | - **authorization** | **character**| | [optional] - -### Return type - -AnyType - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | Successful Response | - | -| **422** | Validation Error | - | - diff --git a/docs/Dimension.md b/docs/Dimension.md deleted file mode 100644 index 0f5efb1..0000000 --- a/docs/Dimension.md +++ /dev/null @@ -1,10 +0,0 @@ -# laminr.api::Dimension - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**field_name** | **character** | | -**func** | **character** | | [optional] [Enum: [count, sum, min, max, mean]] - - diff --git a/docs/GetRecordRequestBody.md b/docs/GetRecordRequestBody.md deleted file mode 100644 index d667a82..0000000 --- a/docs/GetRecordRequestBody.md +++ /dev/null @@ -1,9 +0,0 @@ -# laminr.api::GetRecordRequestBody - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**select** | **array[character]** | | [optional] - - diff --git a/docs/GetRecordsRequestBody.md b/docs/GetRecordsRequestBody.md deleted file mode 100644 index 6f56ae0..0000000 --- a/docs/GetRecordsRequestBody.md +++ /dev/null @@ -1,12 +0,0 @@ -# laminr.api::GetRecordsRequestBody - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**select** | **array[character]** | | [optional] -**filter** | **object** | | [optional] -**order_by** | [**array[OrderByColumn]**](OrderByColumn.md) | | [optional] -**search** | **character** | | [optional] [default to ""] - - diff --git a/docs/GetValuesRequestBody.md b/docs/GetValuesRequestBody.md deleted file mode 100644 index 538a999..0000000 --- a/docs/GetValuesRequestBody.md +++ /dev/null @@ -1,11 +0,0 @@ -# laminr.api::GetValuesRequestBody - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**filter** | **object** | | [optional] -**order_by** | [**array[OrderByColumn]**](OrderByColumn.md) | | [optional] -**search** | **character** | | [optional] [default to ""] - - diff --git a/docs/GroupByRequestBody.md b/docs/GroupByRequestBody.md deleted file mode 100644 index 460e24e..0000000 --- a/docs/GroupByRequestBody.md +++ /dev/null @@ -1,11 +0,0 @@ -# laminr.api::GroupByRequestBody - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dimensions** | [**array[Dimension]**](Dimension.md) | | -**measures** | [**array[Measure]**](Measure.md) | | -**filter** | **object** | | [optional] - - diff --git a/docs/HTTPValidationError.md b/docs/HTTPValidationError.md deleted file mode 100644 index fba0f7c..0000000 --- a/docs/HTTPValidationError.md +++ /dev/null @@ -1,9 +0,0 @@ -# laminr.api::HTTPValidationError - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**detail** | [**array[ValidationError]**](ValidationError.md) | | [optional] - - diff --git a/docs/Measure.md b/docs/Measure.md deleted file mode 100644 index 4a2f404..0000000 --- a/docs/Measure.md +++ /dev/null @@ -1,11 +0,0 @@ -# laminr.api::Measure - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**field_name** | **character** | | -**agg_func** | **character** | | [Enum: [count, sum, min, max, mean]] -**alias** | **character** | | [optional] - - diff --git a/docs/OrderByColumn.md b/docs/OrderByColumn.md deleted file mode 100644 index b36088c..0000000 --- a/docs/OrderByColumn.md +++ /dev/null @@ -1,10 +0,0 @@ -# laminr.api::OrderByColumn - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**field** | **character** | | -**descending** | **character** | | [optional] [default to FALSE] - - diff --git a/docs/S3PermissionsRequest.md b/docs/S3PermissionsRequest.md deleted file mode 100644 index c680e6f..0000000 --- a/docs/S3PermissionsRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# laminr.api::S3PermissionsRequest - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**aws_access_key_id** | **character** | | -**aws_secret_access_key** | **character** | | -**region** | **character** | | - - diff --git a/docs/ValidationError.md b/docs/ValidationError.md deleted file mode 100644 index 3e3eb43..0000000 --- a/docs/ValidationError.md +++ /dev/null @@ -1,11 +0,0 @@ -# laminr.api::ValidationError - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**loc** | [**array[ValidationErrorLocInner]**](ValidationError_loc_inner.md) | | -**msg** | **character** | | -**type** | **character** | | - - diff --git a/docs/ValidationErrorLocInner.md b/docs/ValidationErrorLocInner.md deleted file mode 100644 index 032e505..0000000 --- a/docs/ValidationErrorLocInner.md +++ /dev/null @@ -1,8 +0,0 @@ -# laminr.api::ValidationErrorLocInner - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - diff --git a/update_package.sh b/update_package.sh index fdd895b..5b98f3a 100755 --- a/update_package.sh +++ b/update_package.sh @@ -29,6 +29,9 @@ eval $CMD generate \ --package-name $pkg_name \ --additional-properties=packageName=$pkg_name,packageVersion=$pkg_ver,exceptionPackage=rlang +# remove docs/ because this documentation could be generated by pkgdown +rm -r docs/ + # Hack to fix the auto-generated documentation so that checks pass sed -i 's/\[\*\*AnyType\*\*\](AnyType\.md)/AnyType/g' docs/DefaultApi.md sed -i 's/\\link{AnyType}/AnyType/g' R/default_api.R @@ -42,4 +45,4 @@ Rscript -e "devtools::document()" echo echo "NEXT STEPS:" -echo "Copy updated documentation to 'README.qmd' and run 'quarto render README.qmd'" +echo "Run 'quarto render README.qmd'"