diff --git a/README.md b/README.md index 79968c9b16d9d41dea286daa1a16932ce68247a3..88cf5b58d203e38cf11ae0b824c6ddfa01a4b28d 100644 --- a/README.md +++ b/README.md @@ -224,6 +224,9 @@ Class | Method | HTTP request | Description *SelfSessionApi* | [**Login**](docs/SelfSessionApi.md#login) | **GET** /api/v2/self/session | Initiate the login workflow with the default (NFDI4Ing AAI) provider. *SelfSessionApi* | [**LoginWithProvider**](docs/SelfSessionApi.md#loginwithprovider) | **GET** /api/v2/self/session/{externalAuthenticatorId} | Initiate the login workflow with specific provider. *SelfSessionApi* | [**Merge**](docs/SelfSessionApi.md#merge) | **GET** /api/v2/self/session/merge/{externalAuthenticatorId} | Initiate the merge workflow with specific provider. +*SystemStatusApi* | [**ApiV2SystemStatusOptions**](docs/SystemStatusApi.md#apiv2systemstatusoptions) | **OPTIONS** /api/v2/system/status | Responds with the HTTP methods allowed for the endpoint. +*SystemStatusApi* | [**GetInternalMessages**](docs/SystemStatusApi.md#getinternalmessages) | **GET** /api/v2/system/status/internal | Retrieves the internal messages. +*SystemStatusApi* | [**GetNocMessages**](docs/SystemStatusApi.md#getnocmessages) | **GET** /api/v2/system/status/noc | Retrieves the NOC messages. *TitleApi* | [**ApiV2TitlesOptions**](docs/TitleApi.md#apiv2titlesoptions) | **OPTIONS** /api/v2/titles | Responds with the HTTP methods allowed for the endpoint. *TitleApi* | [**GetTitle**](docs/TitleApi.md#gettitle) | **GET** /api/v2/titles/{titleId} | Retrieves a title by ID. *TitleApi* | [**GetTitles**](docs/TitleApi.md#gettitles) | **GET** /api/v2/titles | Retrieves all titles. @@ -309,6 +312,9 @@ Class | Method | HTTP request | Description - [Model.LicenseForResourceManipulationDto](docs/LicenseForResourceManipulationDto.md) - [Model.MaintenanceDto](docs/MaintenanceDto.md) - [Model.MaintenanceDtoPagedResponse](docs/MaintenanceDtoPagedResponse.md) + - [Model.MessageDto](docs/MessageDto.md) + - [Model.MessageDtoPagedResponse](docs/MessageDtoPagedResponse.md) + - [Model.MessageType](docs/MessageType.md) - [Model.MetadataTreeDto](docs/MetadataTreeDto.md) - [Model.MetadataTreeDtoPagedResponse](docs/MetadataTreeDtoPagedResponse.md) - [Model.MetadataTreeDtoResponse](docs/MetadataTreeDtoResponse.md) @@ -340,6 +346,7 @@ Class | Method | HTTP request | Description - [Model.ProjectInvitationForProjectManipulationDto](docs/ProjectInvitationForProjectManipulationDto.md) - [Model.ProjectInvitationResolveDto](docs/ProjectInvitationResolveDto.md) - [Model.ProjectMinimalDto](docs/ProjectMinimalDto.md) + - [Model.ProjectOrganizationDto](docs/ProjectOrganizationDto.md) - [Model.ProjectPublicationRequestDto](docs/ProjectPublicationRequestDto.md) - [Model.ProjectPublicationRequestDtoResponse](docs/ProjectPublicationRequestDtoResponse.md) - [Model.ProjectQuotaDto](docs/ProjectQuotaDto.md) @@ -421,7 +428,6 @@ Class | Method | HTTP request | Description - [Model.UserDtoResponse](docs/UserDtoResponse.md) - [Model.UserEmailDto](docs/UserEmailDto.md) - [Model.UserForUpdateDto](docs/UserForUpdateDto.md) - - [Model.UserInstituteDto](docs/UserInstituteDto.md) - [Model.UserMergeDto](docs/UserMergeDto.md) - [Model.UserMergeDtoResponse](docs/UserMergeDtoResponse.md) - [Model.UserMinimalDto](docs/UserMinimalDto.md) diff --git a/docs/AdminApi.md b/docs/AdminApi.md index c570df3a3539ea39a90c6a5df9c2850eea77afec..1decc56b8bdd0ca51a4c99f6fd47c9f913e9bbd0 100644 --- a/docs/AdminApi.md +++ b/docs/AdminApi.md @@ -95,7 +95,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -137,7 +137,7 @@ namespace Example var httpMethod = new CoscineHttpMethod?(); // CoscineHttpMethod? | The http method to filter activity logs by. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { @@ -247,7 +247,7 @@ namespace Example var includePublicationRequests = true; // bool? | Gets or sets a value indicating whether to include project publication requests in the results. (optional) var pageSize = 56; // int? | Number of items per page. The maximum number of items per page is `250`. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { @@ -354,7 +354,7 @@ namespace Example var includeQuotas = true; // bool? | Value indicating whether to include individual resource quotas. (optional) var pageSize = 56; // int? | Number of items per page. The maximum number of items per page is `250`. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { @@ -458,7 +458,7 @@ namespace Example var tosAccepted = true; // bool? | Gets or sets a value indicating whether the terms of service have been accepted by the user. (optional) var pageSize = 56; // int? | Number of items per page. The maximum number of items per page is `250`. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { @@ -560,7 +560,7 @@ namespace Example var apiInstance = new AdminApi(config); var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/ApplicationProfileApi.md b/docs/ApplicationProfileApi.md index f7020a57e38e5d17c81a8625d0ce675a48d9d727..6129dca71ccbde27d4eddf93c9d512e1771d1c4d 100644 --- a/docs/ApplicationProfileApi.md +++ b/docs/ApplicationProfileApi.md @@ -91,7 +91,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -324,7 +324,7 @@ namespace Example var modules = true; // bool? | Gets or sets a value indicating whether to include modules in the application profiles. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/ApplicationProfileDto.md b/docs/ApplicationProfileDto.md index 0005a75c01ab348040d70810fd9fdc9ad0e40663..2acc6fad992507310d12ef9cc49264fa4c75c1b3 100644 --- a/docs/ApplicationProfileDto.md +++ b/docs/ApplicationProfileDto.md @@ -5,7 +5,7 @@ Represents an application profile data transfer object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Uri** | **string** | The URI associated with the application profile. | [optional] +**Uri** | **string** | The URI associated with the application profile. | **DisplayName** | **string** | The display name for the application profile. | [optional] **Description** | **string** | The description of the application profile. | [optional] **Definition** | [**RdfDefinitionDto**](RdfDefinitionDto.md) | | [optional] diff --git a/docs/ApplicationProfileMinimalDto.md b/docs/ApplicationProfileMinimalDto.md index 42775e29a108bc5b7499d8cd4c8aadac75310856..fd097526dda7fe3e814d2d266fb14974f53793bb 100644 --- a/docs/ApplicationProfileMinimalDto.md +++ b/docs/ApplicationProfileMinimalDto.md @@ -5,7 +5,7 @@ Represents a minimalistic application profile data transfer object. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Uri** | **string** | The URI associated with the application profile. | [optional] +**Uri** | **string** | The URI associated with the application profile. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/BlobApi.md b/docs/BlobApi.md index 35e4fb80a325e82cb97da0534402afc0c3d017a1..d4a77218d9361235411da9c40c16bb5bad95addc 100644 --- a/docs/BlobApi.md +++ b/docs/BlobApi.md @@ -98,7 +98,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/DisciplineApi.md b/docs/DisciplineApi.md index d3b431ece3c61866fe8add0a0e6ae33d95f45f4e..b0fd8ff442f6d1f1cc09aac5259318dcb2958b25 100644 --- a/docs/DisciplineApi.md +++ b/docs/DisciplineApi.md @@ -89,7 +89,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -218,7 +218,7 @@ namespace Example var apiInstance = new DisciplineApi(config); var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/GitlabBranchDto.md b/docs/GitlabBranchDto.md index 5888dc4fbed4c2d4cffa5ee6d2db6c82249759d2..9261b3ce9dcecb75789239995cfc92d66d420714 100644 --- a/docs/GitlabBranchDto.md +++ b/docs/GitlabBranchDto.md @@ -5,13 +5,13 @@ Represents a GitLab branch data transfer object (DTO). Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the GitLab branch. | [optional] -**Merged** | **bool** | Indicates if the branch is merged. | [optional] -**Protected** | **bool** | Indicates if the branch is protected. | [optional] -**Default** | **bool** | Indicates if the branch is set as default. | [optional] -**DevelopersCanPush** | **bool** | Indicates if developers can push changes to the branch. | [optional] -**DevelopersCanMerge** | **bool** | Indicates if developers can merge changes into the branch. | [optional] -**CanPush** | **bool** | Indicates if the user can push changes to the branch. | [optional] +**Name** | **string** | The name of the GitLab branch. | +**Merged** | **bool** | Indicates if the branch is merged. | +**Protected** | **bool** | Indicates if the branch is protected. | +**Default** | **bool** | Indicates if the branch is set as default. | +**DevelopersCanPush** | **bool** | Indicates if developers can push changes to the branch. | +**DevelopersCanMerge** | **bool** | Indicates if developers can merge changes into the branch. | +**CanPush** | **bool** | Indicates if the user can push changes to the branch. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/GitlabProjectDto.md b/docs/GitlabProjectDto.md index 307e8c597eaa3468c1050ea4bd5a8d0f0f944c72..7b91cb09115d6e6f729560dc9770b5daae746577 100644 --- a/docs/GitlabProjectDto.md +++ b/docs/GitlabProjectDto.md @@ -5,19 +5,19 @@ Represents a GitLab project data transfer object (DTO). Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **int** | The unique identifier for the GitLab project. | [optional] -**Archived** | **bool** | Indicates if the GitLab project is archived. | [optional] -**Name** | **string** | The name of the GitLab project. | [optional] -**NameWithNamespace** | **string** | The full name of the GitLab project including namespace. | [optional] -**Description** | **string** | A brief description of the GitLab project. | [optional] -**DefaultBranch** | **string** | The default branch of the GitLab project. | [optional] -**Path** | **string** | The path of the GitLab project. | [optional] -**PathWithNamespace** | **string** | The path of the GitLab project including namespace. | [optional] -**LastActivityAt** | **string** | The timestamp of the last activity related to the GitLab project. | [optional] -**CreatedAt** | **string** | The creation timestamp of the GitLab project. | [optional] -**WebUrl** | **string** | The URL to view the GitLab project in a web browser. | [optional] -**HttpUrlToRepo** | **string** | The HTTP URL to access the GitLab project repository. | [optional] -**SshUrlToRepo** | **string** | The SSH URL to access the GitLab project repository. | [optional] +**Id** | **int** | The unique identifier for the GitLab project. | +**Archived** | **bool** | Indicates if the GitLab project is archived. | +**Name** | **string** | The name of the GitLab project. | +**NameWithNamespace** | **string** | The full name of the GitLab project including namespace. | +**Description** | **string** | A brief description of the GitLab project. | +**DefaultBranch** | **string** | The default branch of the GitLab project. | +**Path** | **string** | The path of the GitLab project. | +**PathWithNamespace** | **string** | The path of the GitLab project including namespace. | +**LastActivityAt** | **string** | The timestamp of the last activity related to the GitLab project. | +**CreatedAt** | **string** | The creation timestamp of the GitLab project. | +**WebUrl** | **string** | The URL to view the GitLab project in a web browser. | +**HttpUrlToRepo** | **string** | The HTTP URL to access the GitLab project repository. | +**SshUrlToRepo** | **string** | The SSH URL to access the GitLab project repository. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/HandleApi.md b/docs/HandleApi.md index 3b8cce40a80375771b2e019e8805450d66037b92..97cbc81350f2a1f45a0930276bad4692b3236bfa 100644 --- a/docs/HandleApi.md +++ b/docs/HandleApi.md @@ -89,7 +89,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/HandleForUpdateDto.md b/docs/HandleForUpdateDto.md index 546c33154be364d41affae7b40f77df1dea108c7..0ea5b4a25e1481c8f66e43407b7f84acae81fefe 100644 --- a/docs/HandleForUpdateDto.md +++ b/docs/HandleForUpdateDto.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Values** | [**List<HandleValueForUpdateDto>**](HandleValueForUpdateDto.md) | | [optional] +**Values** | [**List<HandleValueForUpdateDto>**](HandleValueForUpdateDto.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/HandleValueForUpdateDto.md b/docs/HandleValueForUpdateDto.md index 57ec5b9827982c28618e55e5ed76c54aa263eb8f..556d9ed29d16ed708f95c14795c5d3bfcc427e13 100644 --- a/docs/HandleValueForUpdateDto.md +++ b/docs/HandleValueForUpdateDto.md @@ -5,8 +5,8 @@ Data transfer object (DTO) representing updating a handle. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | The data type of the handle. | [optional] -**ParsedData** | **Object** | The parsed data of the handle. | [optional] +**Type** | **string** | The data type of the handle. | +**ParsedData** | **Object** | The parsed data of the handle. | **Idx** | **int** | The id of the handle. | [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) diff --git a/docs/IdentityProviderDto.md b/docs/IdentityProviderDto.md index 70e854086eca261eefa436b8cc030d271d02565c..597be243377ca148e55fbf5e111cf6c3631dc51b 100644 --- a/docs/IdentityProviderDto.md +++ b/docs/IdentityProviderDto.md @@ -5,8 +5,8 @@ Represents a Data Transfer Object (DTO) for an identity provider. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | Gets or sets the unique identifier for the identity provider. | [optional] -**DisplayName** | **string** | Gets or sets the display name of the identity provider. | [optional] +**Id** | **Guid** | Gets or sets the unique identifier for the identity provider. | +**DisplayName** | **string** | Gets or sets the display name of the identity provider. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LanguageApi.md b/docs/LanguageApi.md index 9336f05c75177388acf52463e69ba6bc7d2de741..d2d8e62d39e283c7856d6c75c5e08611cf183a7c 100644 --- a/docs/LanguageApi.md +++ b/docs/LanguageApi.md @@ -89,7 +89,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -218,7 +218,7 @@ namespace Example var apiInstance = new LanguageApi(config); var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/LanguageDto.md b/docs/LanguageDto.md index 7118222c4b5f827b5ea69280b982bbf45e3616b5..794273a87eaf15649ac2b4dc729b55f7ee2bfd97 100644 --- a/docs/LanguageDto.md +++ b/docs/LanguageDto.md @@ -5,9 +5,9 @@ Represents a Data Transfer Object (DTO) for language details. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | Gets or sets the unique identifier for the language. | [optional] -**DisplayName** | **string** | Gets or sets the display name of the language. | [optional] -**Abbreviation** | **string** | Gets or sets the abbreviation for the language. | [optional] +**Id** | **Guid** | Gets or sets the unique identifier for the language. | +**DisplayName** | **string** | Gets or sets the display name of the language. | +**Abbreviation** | **string** | Gets or sets the abbreviation for the language. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LicenseApi.md b/docs/LicenseApi.md index d9d6a5f82cfe148fc39ac60b6427bfe2d9f12806..c63cb38d155e280342c5aaa46b32965b8050c154 100644 --- a/docs/LicenseApi.md +++ b/docs/LicenseApi.md @@ -89,7 +89,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -218,7 +218,7 @@ namespace Example var apiInstance = new LicenseApi(config); var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/MaintenanceApi.md b/docs/MaintenanceApi.md index 01ebe2e0ffdb1c2c3245b7ed656319ee4d0768cf..51b27738f9e066bd8370c4b2a446764a7afde056 100644 --- a/docs/MaintenanceApi.md +++ b/docs/MaintenanceApi.md @@ -88,7 +88,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/MessageDto.md b/docs/MessageDto.md index fa575a1a8600b54e450fd0517d81db3154cbc3ac..ff0b6af54e9b337e4757a475aa7a4c97ebb9eb0e 100644 --- a/docs/MessageDto.md +++ b/docs/MessageDto.md @@ -4,13 +4,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | ID of the message. | [optional] +**Id** | **string** | ID of the message. | **Body** | **Dictionary<string, string>** | Message body in multiple languages as key-value pairs. The key is the ISO 639-1 Alpha-2 two-letter language code, and the value is the message in that language. | [optional] **Type** | **MessageType** | | [optional] **Title** | **string** | Title of the message. | [optional] **Href** | **string** | URL related to the message. | [optional] -**StartDate** | **DateTime?** | Start date of the message. | [optional] -**EndDate** | **DateTime?** | End date of the message. | [optional] +**StartDate** | **DateTime?** | Start date of the message (UTC). | [optional] +**EndDate** | **DateTime?** | End date of the message (UTC). | [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) diff --git a/docs/OrganizationApi.md b/docs/OrganizationApi.md index 1d16ea1c12266871565d5d2306102d89831dca46..a6cbbe480b1ddfb7e5050ea5190fa882cd86989c 100644 --- a/docs/OrganizationApi.md +++ b/docs/OrganizationApi.md @@ -89,7 +89,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -220,7 +220,7 @@ namespace Example var filterByPublicationService = true; // bool? | Gets or sets the option to find only organizations having the publication service set. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/OrganizationDto.md b/docs/OrganizationDto.md index 0d8363803c3a468f81166a592028145d041c1d8c..37482b4daa16b2064fe1063ca41262eee344eefa 100644 --- a/docs/OrganizationDto.md +++ b/docs/OrganizationDto.md @@ -5,8 +5,8 @@ Represents a data transfer object (DTO) for an organization, including its ROR ( Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Uri** | **string** | The ROR (Research Organization Registry) ID of the organization. | [optional] -**DisplayName** | **string** | The display name of the organization. | [optional] +**Uri** | **string** | The ROR (Research Organization Registry) ID of the organization. | +**DisplayName** | **string** | The display name of the organization. | **Email** | **string** | The email address of the organization. | [optional] **PublicationAdvisoryService** | [**PublicationAdvisoryServiceDto**](PublicationAdvisoryServiceDto.md) | | [optional] diff --git a/docs/OrganizationForProjectManipulationDto.md b/docs/OrganizationForProjectManipulationDto.md index 7266cd8f4cbbe4cc2e0111d558619794c4e46892..e2dc12aef9ca04bf0a55670cd8df145e17320015 100644 --- a/docs/OrganizationForProjectManipulationDto.md +++ b/docs/OrganizationForProjectManipulationDto.md @@ -6,6 +6,7 @@ Data transfer object (DTO) representing an organization for project manipulation Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Uri** | **string** | Gets or initializes the URI of the organization. | +**Responsible** | **bool** | Gets or initializes if the organization is responsible. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PidApi.md b/docs/PidApi.md index b530a9eee381d87873bd9172d1eedb334a8f3d4b..cbc58d68ca8b93174a8e910e54629e8d678dfc7b 100644 --- a/docs/PidApi.md +++ b/docs/PidApi.md @@ -90,7 +90,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -227,7 +227,7 @@ namespace Example var includeDeleted = true; // bool? | Gets or sets a value indicating whether to include deleted pid information. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/PidDto.md b/docs/PidDto.md index 203637775ea219b2a468098f36ee2d0afe22ed60..fd36a4736573e35b4c6baf0cf88a4d23607a6416 100644 --- a/docs/PidDto.md +++ b/docs/PidDto.md @@ -5,8 +5,8 @@ Represents a data transfer object (DTO) for a PID (Persistent Identifier). Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Prefix** | **string** | Gets or sets the prefix of the PID. | [optional] -**Suffix** | **string** | Gets or sets the suffix of the PID. | [optional] +**Prefix** | **string** | Gets or sets the prefix of the PID. | +**Suffix** | **string** | Gets or sets the suffix of the PID. | **Identifier** | **string** | Gets the constructed PID by combining the prefix and suffix (\"{Prefix}/{Suffix}\"). | [optional] [readonly] **Type** | **PidType** | | [optional] **IsEntityValid** | **bool** | Gets or sets a value indicating whether the linked entity is considered valid. | [optional] diff --git a/docs/ProjectAdminDto.md b/docs/ProjectAdminDto.md index c7d05411b5f2e0bc90adc4308378f981f920ac64..c8715ad50c7444c411986f9a707d6377014564e4 100644 --- a/docs/ProjectAdminDto.md +++ b/docs/ProjectAdminDto.md @@ -5,20 +5,20 @@ Represents a data transfer object (DTO) for an administrative view of a project. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | Unique identifier for the project. | [optional] -**Pid** | **string** | Persistent identifier for the project. | [optional] -**Name** | **string** | Name of the project. | [optional] -**Description** | **string** | Description of the project. | [optional] -**StartDate** | **DateTime** | Start date of the project. | [optional] -**EndDate** | **DateTime** | End date of the project. | [optional] +**Id** | **Guid** | Unique identifier for the project. | +**Pid** | **string** | Persistent identifier for the project. | +**Name** | **string** | Name of the project. | +**Description** | **string** | Description of the project. | +**StartDate** | **DateTime** | Start date of the project. | +**EndDate** | **DateTime** | End date of the project. | **Keywords** | **List<string>** | Collection of keywords associated with the project. | [optional] **DisplayName** | **string** | Display name of the project. | [optional] **PrincipleInvestigators** | **string** | Principal investigators involved in the project. | [optional] **GrantId** | **string** | Grant ID associated with the project. | [optional] -**Visibility** | [**VisibilityDto**](VisibilityDto.md) | | [optional] -**Disciplines** | [**List<DisciplineDto>**](DisciplineDto.md) | Disciplines related to the project. | [optional] -**Organizations** | [**List<OrganizationDto>**](OrganizationDto.md) | Organizations associated with the project. | [optional] -**Slug** | **string** | Slug for the project. | [optional] +**Visibility** | [**VisibilityDto**](VisibilityDto.md) | | +**Disciplines** | [**List<DisciplineDto>**](DisciplineDto.md) | Disciplines related to the project. | +**Organizations** | [**List<ProjectOrganizationDto>**](ProjectOrganizationDto.md) | Organizations associated with the project. | +**Slug** | **string** | Slug for the project. | **Creator** | [**UserMinimalDto**](UserMinimalDto.md) | | [optional] **CreationDate** | **DateTime?** | Date of creation of the project. | [optional] **SubProjects** | [**List<ProjectDto>**](ProjectDto.md) | Collection of sub-projects associated with this project. | [optional] diff --git a/docs/ProjectApi.md b/docs/ProjectApi.md index bae3e2b09ccdd2f7da5220b18bb4584507a98b86..cb8171965c1d1ba437954a18e0818a80f5091fa3 100644 --- a/docs/ProjectApi.md +++ b/docs/ProjectApi.md @@ -92,7 +92,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -417,7 +417,7 @@ namespace Example var topLevel = true; // bool? | Gets or sets a value indicating whether to retrieve only top-level projects. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/ProjectDto.md b/docs/ProjectDto.md index 79457ef125e4009eda4e4bca833a8529cc074f95..c694099f721acb54bf838f5bdbb3e49552497860 100644 --- a/docs/ProjectDto.md +++ b/docs/ProjectDto.md @@ -5,20 +5,20 @@ Represents a data transfer object (DTO) for project information. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | Unique identifier for the project. | [optional] -**Pid** | **string** | Persistent identifier for the project. | [optional] -**Name** | **string** | Name of the project. | [optional] -**Description** | **string** | Description of the project. | [optional] -**StartDate** | **DateTime** | Start date of the project. | [optional] -**EndDate** | **DateTime** | End date of the project. | [optional] +**Id** | **Guid** | Unique identifier for the project. | +**Pid** | **string** | Persistent identifier for the project. | +**Name** | **string** | Name of the project. | +**Description** | **string** | Description of the project. | +**StartDate** | **DateTime** | Start date of the project. | +**EndDate** | **DateTime** | End date of the project. | **Keywords** | **List<string>** | Collection of keywords associated with the project. | [optional] **DisplayName** | **string** | Display name of the project. | [optional] **PrincipleInvestigators** | **string** | Principal investigators involved in the project. | [optional] **GrantId** | **string** | Grant ID associated with the project. | [optional] -**Visibility** | [**VisibilityDto**](VisibilityDto.md) | | [optional] -**Disciplines** | [**List<DisciplineDto>**](DisciplineDto.md) | Disciplines related to the project. | [optional] -**Organizations** | [**List<OrganizationDto>**](OrganizationDto.md) | Organizations associated with the project. | [optional] -**Slug** | **string** | Slug for the project. | [optional] +**Visibility** | [**VisibilityDto**](VisibilityDto.md) | | +**Disciplines** | [**List<DisciplineDto>**](DisciplineDto.md) | Disciplines related to the project. | +**Organizations** | [**List<ProjectOrganizationDto>**](ProjectOrganizationDto.md) | Organizations associated with the project. | +**Slug** | **string** | Slug for the project. | **Creator** | [**UserMinimalDto**](UserMinimalDto.md) | | [optional] **CreationDate** | **DateTime?** | Date of creation of the project. | [optional] **SubProjects** | [**List<ProjectDto>**](ProjectDto.md) | Collection of sub-projects associated with this project. | [optional] diff --git a/docs/ProjectInvitationApi.md b/docs/ProjectInvitationApi.md index a9fddec1d431a058e080c29bc4267301035ebaf9..376b4eedade53dcb46fad4b594f1ff2675c606f9 100644 --- a/docs/ProjectInvitationApi.md +++ b/docs/ProjectInvitationApi.md @@ -96,7 +96,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -421,7 +421,7 @@ namespace Example var projectId = "projectId_example"; // string | The Id or slug of the project. var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/ProjectMemberApi.md b/docs/ProjectMemberApi.md index cae0e77a4e0dc5e2d499230af6f40bac20830f06..682771060e08ba776e825e86798128640710f3c8 100644 --- a/docs/ProjectMemberApi.md +++ b/docs/ProjectMemberApi.md @@ -196,7 +196,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -422,7 +422,7 @@ namespace Example var projectId = "projectId_example"; // string | The Id or slug of the project. var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/ProjectMinimalDto.md b/docs/ProjectMinimalDto.md index 2bee62e11dc68e2674eb3c31e09818d0565b078f..0438a85b4d591faf90e1d82c397161b17269f2bc 100644 --- a/docs/ProjectMinimalDto.md +++ b/docs/ProjectMinimalDto.md @@ -5,7 +5,7 @@ Represents a minimal data transfer object (DTO) for a project. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | Unique identifier for the project. | [optional] +**Id** | **Guid** | Unique identifier for the project. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UserInstituteDto.md b/docs/ProjectOrganizationDto.md similarity index 61% rename from docs/UserInstituteDto.md rename to docs/ProjectOrganizationDto.md index d59a48a44f423a65aeb99259d414f6badb9d254a..123686bf7ec5880eb0f47180cfbd35dca567dc52 100644 --- a/docs/UserInstituteDto.md +++ b/docs/ProjectOrganizationDto.md @@ -1,15 +1,15 @@ -# Coscine.ApiClient.Core.Model.UserInstituteDto -Represents a Data Transfer Object (DTO) for user institute information, extending the OrganizationDto. +# Coscine.ApiClient.Core.Model.ProjectOrganizationDto +Represents a data transfer object (DTO) for an organization in the context of a project. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Uri** | **string** | The ROR (Research Organization Registry) ID of the organization. | [optional] -**DisplayName** | **string** | The display name of the organization. | [optional] +**Uri** | **string** | The ROR (Research Organization Registry) ID of the organization. | +**DisplayName** | **string** | The display name of the organization. | **Email** | **string** | The email address of the organization. | [optional] **PublicationAdvisoryService** | [**PublicationAdvisoryServiceDto**](PublicationAdvisoryServiceDto.md) | | [optional] -**ReadOnly** | **bool** | Determines if the organization's details can be modified. Defaults to `true`; manually set to `false`. | [optional] +**Responsible** | **bool** | Determines if the organization is Responsible for a given project. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ProjectPublicationRequestApi.md b/docs/ProjectPublicationRequestApi.md index 16425184edfe769a6d7d6705a4cb5a091d4308cc..5638cbfe1a3019fe0c6ae3692d58e14a6f1a0d0f 100644 --- a/docs/ProjectPublicationRequestApi.md +++ b/docs/ProjectPublicationRequestApi.md @@ -94,7 +94,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/ProjectQuotaApi.md b/docs/ProjectQuotaApi.md index 06eaf98c435b2997aabf87dac12e29d2c5fbf13a..d0e9a33629c53c216e56968e97b7c21681259c64 100644 --- a/docs/ProjectQuotaApi.md +++ b/docs/ProjectQuotaApi.md @@ -95,7 +95,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -227,7 +227,7 @@ namespace Example var projectId = "projectId_example"; // string | The Id or slug of the project. var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/ProjectResourceApi.md b/docs/ProjectResourceApi.md index dd2367a8c3758413e45b989a78a4589165d3f568..944e54a1dea403028921b6af30d42123fc9c565a 100644 --- a/docs/ProjectResourceApi.md +++ b/docs/ProjectResourceApi.md @@ -97,7 +97,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -425,7 +425,7 @@ namespace Example var projectId = "projectId_example"; // string | The Id or slug of the project. var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/ProjectResourceQuotaApi.md b/docs/ProjectResourceQuotaApi.md index f3e6a29e9e74f998d4fa31ec0b3013f415c219c0..162d921615049b5e3c67c7fcd67e4b42e3d1ecc5 100644 --- a/docs/ProjectResourceQuotaApi.md +++ b/docs/ProjectResourceQuotaApi.md @@ -95,7 +95,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/ProjectResourceTypeApi.md b/docs/ProjectResourceTypeApi.md index 255936a05bbc307f8c6018bde7f0efc01972782f..47c647635e89452ca1e4e00a9af86258217c3f04 100644 --- a/docs/ProjectResourceTypeApi.md +++ b/docs/ProjectResourceTypeApi.md @@ -93,7 +93,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/ProvenanceApi.md b/docs/ProvenanceApi.md index 8915cbd5ac3664f5442ffd010d330c130290d4cc..37ccff40a7782fbbc539f1af29352596591673f3 100644 --- a/docs/ProvenanceApi.md +++ b/docs/ProvenanceApi.md @@ -96,7 +96,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/ProvenanceDto.md b/docs/ProvenanceDto.md index 072e564f71a963de41ac9ceac76c2fbb6405b1e9..0f433158b29ae77b850d3e78df01907b561c5de1 100644 --- a/docs/ProvenanceDto.md +++ b/docs/ProvenanceDto.md @@ -5,10 +5,10 @@ Represents a data transfer object (DTO) for provenance information. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | Gets or sets the id of the current metadata graph. | [optional] +**Id** | **string** | Gets or sets the id of the current metadata graph. | **GeneratedAt** | **DateTime?** | Gets or sets the date and time when the metadata was generated. | [optional] -**WasRevisionOf** | **List<string>** | Gets or sets the adapted versions from the specific metadata tree. | [optional] -**Variants** | [**List<VariantDto>**](VariantDto.md) | Gets or sets the variants of the specific metadata tree. | [optional] +**WasRevisionOf** | **List<string>** | Gets or sets the adapted versions from the specific metadata tree. | +**Variants** | [**List<VariantDto>**](VariantDto.md) | Gets or sets the variants of the specific metadata tree. | **SimilarityToLastVersion** | **double?** | The similarity to the last version. | [optional] **WasInvalidatedBy** | **string** | Information if the specific metadata tree was invalidated by something. | [optional] **HashParameters** | [**HashParametersDto**](HashParametersDto.md) | | [optional] diff --git a/docs/ProvenanceForUpdateDto.md b/docs/ProvenanceForUpdateDto.md index 50982e4eed6a8c527c516d23cc28d186496237dd..fbb6df27717e9acaeed15ce29a27f4e9c00aec7c 100644 --- a/docs/ProvenanceForUpdateDto.md +++ b/docs/ProvenanceForUpdateDto.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **SimilarityToLastVersion** | **double?** | The similarity to the last version. | [optional] **MetadataExtractorVersion** | **string** | Gets or initializes the version of the metadata extractor. | [optional] **HashParameters** | [**HashParametersDto**](HashParametersDto.md) | | [optional] -**Id** | **string** | Gets or sets the id of the specific metadata tree. | [optional] +**Id** | **string** | Gets or sets the id of the specific metadata tree. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PublicUserDto.md b/docs/PublicUserDto.md index 635f2310e9ae0b54499f2f5901331f34c47a72e3..f28c90abbd11fa19a38e913a23f559b42f640c05 100644 --- a/docs/PublicUserDto.md +++ b/docs/PublicUserDto.md @@ -5,11 +5,11 @@ Represents a public user data transfer object (DTO). Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | Unique identifier of the user. | [optional] -**DisplayName** | **string** | Display name of the user. | [optional] -**GivenName** | **string** | Given name of the user. | [optional] -**FamilyName** | **string** | Family name of the user. | [optional] -**Email** | **string** | Email address of the user. | [optional] +**Id** | **Guid** | Unique identifier of the user. | +**DisplayName** | **string** | Display name of the user. | +**GivenName** | **string** | Given name of the user. | +**FamilyName** | **string** | Family name of the user. | +**Email** | **string** | Email address of the user. | **Title** | [**TitleDto**](TitleDto.md) | | [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) diff --git a/docs/RdsOptionsDto.md b/docs/RdsOptionsDto.md index d71744b0900a435ceb615fdd2491e8a135cbff5f..44c60a0c30013aab51eaa13764e895accb9bd1ad 100644 --- a/docs/RdsOptionsDto.md +++ b/docs/RdsOptionsDto.md @@ -5,7 +5,7 @@ Represents the data transfer object (DTO) for RDS options. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**BucketName** | **string** | The name of the bucket associated with RDS. | [optional] +**BucketName** | **string** | The name of the bucket associated with RDS. | **Size** | [**QuotaDto**](QuotaDto.md) | | [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) diff --git a/docs/RdsResourceTypeOptionsForManipulationDto.md b/docs/RdsResourceTypeOptionsForManipulationDto.md index d4f8a8210abdfb7ba84197dc75ee41d2135436a4..80908b269d7df18b7124638d05720b636a566280 100644 --- a/docs/RdsResourceTypeOptionsForManipulationDto.md +++ b/docs/RdsResourceTypeOptionsForManipulationDto.md @@ -5,7 +5,7 @@ Represents the data transfer object (DTO) for manipulating RDS Web resource type Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Quota** | [**QuotaForManipulationDto**](QuotaForManipulationDto.md) | | [optional] +**Quota** | [**QuotaForManipulationDto**](QuotaForManipulationDto.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RdsS3OptionsDto.md b/docs/RdsS3OptionsDto.md index 6b475c84fd02a96fd424e51a747cea50da4d806f..7e101963a36f5e6dff5cb6c8a8b63286486302a1 100644 --- a/docs/RdsS3OptionsDto.md +++ b/docs/RdsS3OptionsDto.md @@ -5,12 +5,12 @@ Represents the data transfer object (DTO) for RDS S3 options. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**BucketName** | **string** | The name of the bucket associated with RDS S3. | [optional] -**AccessKeyRead** | **string** | The access key for reading from the RDS S3 bucket. | [optional] -**SecretKeyRead** | **string** | The secret key for reading from the RDS S3 bucket. | [optional] -**AccessKeyWrite** | **string** | The access key for writing to the RDS S3 bucket. | [optional] -**SecretKeyWrite** | **string** | The secret key for writing to the RDS S3 bucket. | [optional] -**Endpoint** | **string** | The endpoint for the RDS S3 bucket. | [optional] +**BucketName** | **string** | The name of the bucket associated with RDS S3. | +**AccessKeyRead** | **string** | The access key for reading from the RDS S3 bucket. | +**SecretKeyRead** | **string** | The secret key for reading from the RDS S3 bucket. | +**AccessKeyWrite** | **string** | The access key for writing to the RDS S3 bucket. | +**SecretKeyWrite** | **string** | The secret key for writing to the RDS S3 bucket. | +**Endpoint** | **string** | The endpoint for the RDS S3 bucket. | **Size** | [**QuotaDto**](QuotaDto.md) | | [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) diff --git a/docs/RdsS3ResourceTypeOptionsForManipulationDto.md b/docs/RdsS3ResourceTypeOptionsForManipulationDto.md index e358585c8d2b05f57371784b9e63caaf960baf54..4b911f22530cd49a4082369bf18a42083203111e 100644 --- a/docs/RdsS3ResourceTypeOptionsForManipulationDto.md +++ b/docs/RdsS3ResourceTypeOptionsForManipulationDto.md @@ -5,7 +5,7 @@ Represents the data transfer object (DTO) for manipulating RDS S3 resource type Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Quota** | [**QuotaForManipulationDto**](QuotaForManipulationDto.md) | | [optional] +**Quota** | [**QuotaForManipulationDto**](QuotaForManipulationDto.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RdsS3WormOptionsDto.md b/docs/RdsS3WormOptionsDto.md index ebaba2680fac3aa6d4710c4fd3d393e8c7508f64..179c5c281c989b3244680e862e5fef0368571172 100644 --- a/docs/RdsS3WormOptionsDto.md +++ b/docs/RdsS3WormOptionsDto.md @@ -5,12 +5,12 @@ Represents the data transfer object (DTO) for RDS S3 WORM options. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**BucketName** | **string** | The name of the bucket associated with RDS S3 WORM. | [optional] -**AccessKeyRead** | **string** | The access key for reading from the RDS S3 WORM bucket. | [optional] -**SecretKeyRead** | **string** | The secret key for reading from the RDS S3 WORM bucket. | [optional] -**AccessKeyWrite** | **string** | The access key for writing to the RDS S3 WORM bucket. | [optional] -**SecretKeyWrite** | **string** | The secret key for writing to the RDS S3 WORM bucket. | [optional] -**Endpoint** | **string** | The endpoint for the RDS S3 WORM bucket. | [optional] +**BucketName** | **string** | The name of the bucket associated with RDS S3 WORM. | +**AccessKeyRead** | **string** | The access key for reading from the RDS S3 WORM bucket. | +**SecretKeyRead** | **string** | The secret key for reading from the RDS S3 WORM bucket. | +**AccessKeyWrite** | **string** | The access key for writing to the RDS S3 WORM bucket. | +**SecretKeyWrite** | **string** | The secret key for writing to the RDS S3 WORM bucket. | +**Endpoint** | **string** | The endpoint for the RDS S3 WORM bucket. | **Size** | [**QuotaDto**](QuotaDto.md) | | [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) diff --git a/docs/RdsS3WormResourceTypeOptionsForManipulationDto.md b/docs/RdsS3WormResourceTypeOptionsForManipulationDto.md index db37d0436ed07a9f951a32f89d976d66a2a9adb6..6b626ab01b9a44e009cd934f52aaecba84b5aff1 100644 --- a/docs/RdsS3WormResourceTypeOptionsForManipulationDto.md +++ b/docs/RdsS3WormResourceTypeOptionsForManipulationDto.md @@ -5,7 +5,7 @@ Represents the data transfer object (DTO) for manipulating RDS S3 WORM resource Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Quota** | [**QuotaForManipulationDto**](QuotaForManipulationDto.md) | | [optional] +**Quota** | [**QuotaForManipulationDto**](QuotaForManipulationDto.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ResourceAdminDto.md b/docs/ResourceAdminDto.md index c2b5e73d02c648ce9d5898c92b14e0ed04348f8c..31f8e118bfa936a494aa8bad81a869409a20a1ae 100644 --- a/docs/ResourceAdminDto.md +++ b/docs/ResourceAdminDto.md @@ -6,26 +6,26 @@ Represents a Data Transfer Object (DTO) for administrative purposes with additio Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **Guid** | Unique identifier for the resource. | [optional] -**Pid** | **string** | Persistent identifier for the resource. | [optional] -**Type** | [**ResourceTypeDto**](ResourceTypeDto.md) | | [optional] -**Name** | **string** | Name of the resource. | [optional] -**DisplayName** | **string** | Display name of the resource. | [optional] -**Description** | **string** | Description of the resource. | [optional] +**Pid** | **string** | Persistent identifier for the resource. | +**Type** | [**ResourceTypeDto**](ResourceTypeDto.md) | | +**Name** | **string** | Name of the resource. | +**DisplayName** | **string** | Display name of the resource. | +**Description** | **string** | Description of the resource. | **Keywords** | **List<string>** | Keywords associated with the resource. | [optional] **License** | [**LicenseDto**](LicenseDto.md) | | [optional] **UsageRights** | **string** | Usage rights associated with the resource. | [optional] **MetadataLocalCopy** | **bool** | Setting for creating a local copy of the metadata. | [optional] **MetadataExtraction** | **bool** | Setting for metadata extraction. | [optional] -**ApplicationProfile** | [**ApplicationProfileMinimalDto**](ApplicationProfileMinimalDto.md) | | [optional] -**FixedValues** | **Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>>** | Fixed values associated with resource manipulation. This dictionary may contain multiple levels and is structured as follows: Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto. | [optional] -**Disciplines** | [**List<DisciplineDto>**](DisciplineDto.md) | Disciplines associated with the resource. | [optional] -**Visibility** | [**VisibilityDto**](VisibilityDto.md) | | [optional] +**ApplicationProfile** | [**ApplicationProfileMinimalDto**](ApplicationProfileMinimalDto.md) | | +**FixedValues** | **Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>>** | Fixed values associated with resource manipulation. This dictionary may contain multiple levels and is structured as follows: Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto. | +**Disciplines** | [**List<DisciplineDto>**](DisciplineDto.md) | Disciplines associated with the resource. | +**Visibility** | [**VisibilityDto**](VisibilityDto.md) | | **DateCreated** | **DateTime?** | Date when the resource was created. | [optional] **Creator** | [**UserMinimalDto**](UserMinimalDto.md) | | [optional] **Archived** | **bool** | Indicates whether the resource is archived. | [optional] **Projects** | [**List<ProjectMinimalDto>**](ProjectMinimalDto.md) | The projects associated with the resource. | [optional] -**Deleted** | **bool** | Indicates whether the resource is deleted. | [optional] -**ProjectResources** | [**List<ProjectResourceMinimalDto>**](ProjectResourceMinimalDto.md) | Collection of minimal project resource details associated with this resource. | [optional] +**Deleted** | **bool** | Indicates whether the resource is deleted. | +**ProjectResources** | [**List<ProjectResourceMinimalDto>**](ProjectResourceMinimalDto.md) | Collection of minimal project resource details associated with this resource. | **ResourceQuota** | [**ResourceQuotaDto**](ResourceQuotaDto.md) | | [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) diff --git a/docs/ResourceApi.md b/docs/ResourceApi.md index efae8d760b7d7f9f501a1e756a42a1906cdd773f..15804941c3df1b460a353e39a4d650ec58cd67c6 100644 --- a/docs/ResourceApi.md +++ b/docs/ResourceApi.md @@ -88,7 +88,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/ResourceDto.md b/docs/ResourceDto.md index 962d442d7f6ff2ad5d370217374ef201a238ef56..517f4a43c5094f2621a6454891aab57570ed442d 100644 --- a/docs/ResourceDto.md +++ b/docs/ResourceDto.md @@ -6,20 +6,20 @@ Represents a Data Transfer Object (DTO) for resource details. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **Guid** | Unique identifier for the resource. | [optional] -**Pid** | **string** | Persistent identifier for the resource. | [optional] -**Type** | [**ResourceTypeDto**](ResourceTypeDto.md) | | [optional] -**Name** | **string** | Name of the resource. | [optional] -**DisplayName** | **string** | Display name of the resource. | [optional] -**Description** | **string** | Description of the resource. | [optional] +**Pid** | **string** | Persistent identifier for the resource. | +**Type** | [**ResourceTypeDto**](ResourceTypeDto.md) | | +**Name** | **string** | Name of the resource. | +**DisplayName** | **string** | Display name of the resource. | +**Description** | **string** | Description of the resource. | **Keywords** | **List<string>** | Keywords associated with the resource. | [optional] **License** | [**LicenseDto**](LicenseDto.md) | | [optional] **UsageRights** | **string** | Usage rights associated with the resource. | [optional] **MetadataLocalCopy** | **bool** | Setting for creating a local copy of the metadata. | [optional] **MetadataExtraction** | **bool** | Setting for metadata extraction. | [optional] -**ApplicationProfile** | [**ApplicationProfileMinimalDto**](ApplicationProfileMinimalDto.md) | | [optional] -**FixedValues** | **Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>>** | Fixed values associated with resource manipulation. This dictionary may contain multiple levels and is structured as follows: Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto. | [optional] -**Disciplines** | [**List<DisciplineDto>**](DisciplineDto.md) | Disciplines associated with the resource. | [optional] -**Visibility** | [**VisibilityDto**](VisibilityDto.md) | | [optional] +**ApplicationProfile** | [**ApplicationProfileMinimalDto**](ApplicationProfileMinimalDto.md) | | +**FixedValues** | **Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>>** | Fixed values associated with resource manipulation. This dictionary may contain multiple levels and is structured as follows: Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto. | +**Disciplines** | [**List<DisciplineDto>**](DisciplineDto.md) | Disciplines associated with the resource. | +**Visibility** | [**VisibilityDto**](VisibilityDto.md) | | **DateCreated** | **DateTime?** | Date when the resource was created. | [optional] **Creator** | [**UserMinimalDto**](UserMinimalDto.md) | | [optional] **Archived** | **bool** | Indicates whether the resource is archived. | [optional] diff --git a/docs/ResourceMinimalDto.md b/docs/ResourceMinimalDto.md index aa780bb48c411fa0a26846ceabb54222498b21fd..0ccba3ad08bd788a3781b86b6b52c8fe022d2d1c 100644 --- a/docs/ResourceMinimalDto.md +++ b/docs/ResourceMinimalDto.md @@ -5,7 +5,7 @@ Represents a minimal Data Transfer Object (DTO) for a resource, containing essen Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | Unique identifier for the resource. | [optional] +**Id** | **Guid** | Unique identifier for the resource. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ResourceQuotaDto.md b/docs/ResourceQuotaDto.md index 037303ea7c273785a099622f1473f3bff76eda0e..e94e814634dc963d0640db8ba1689c25879ae2ac 100644 --- a/docs/ResourceQuotaDto.md +++ b/docs/ResourceQuotaDto.md @@ -5,7 +5,7 @@ Represents a Data Transfer Object (DTO) containing quota information for a resou Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Resource** | [**ResourceMinimalDto**](ResourceMinimalDto.md) | | [optional] +**Resource** | [**ResourceMinimalDto**](ResourceMinimalDto.md) | | **UsedPercentage** | **float?** | The percentage of quota used by the resource. | [optional] **Used** | [**QuotaDto**](QuotaDto.md) | | [optional] **Reserved** | [**QuotaDto**](QuotaDto.md) | | [optional] diff --git a/docs/ResourceTypeApi.md b/docs/ResourceTypeApi.md index 64e27c0d1fd54b426832ca2bc3fe04b71e208222..5391f5398bc0563cd1680bab81bcb71ef18da19f 100644 --- a/docs/ResourceTypeApi.md +++ b/docs/ResourceTypeApi.md @@ -92,7 +92,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/ResourceTypeDto.md b/docs/ResourceTypeDto.md index 23b52393930c3e9886bad320044fe3bd013b3a6a..f226d1b0c0f584f46ebd01735b4d65b5f2c04f1d 100644 --- a/docs/ResourceTypeDto.md +++ b/docs/ResourceTypeDto.md @@ -6,8 +6,8 @@ Represents a resource type. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **Guid** | The unique identifier of the resource type. | [optional] -**GeneralType** | **string** | The general type of the resource. | [optional] -**SpecificType** | **string** | The specific type of the resource. | [optional] +**GeneralType** | **string** | The general type of the resource. | +**SpecificType** | **string** | The specific type of the resource. | **Options** | [**ResourceTypeOptionsDto**](ResourceTypeOptionsDto.md) | | [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) diff --git a/docs/ResourceTypeMinimalDto.md b/docs/ResourceTypeMinimalDto.md index d6e000b714b510c036cc8c5f516f5e48e1acecd8..2b93f7702ce95e1b7cb0b0c44c106dc071ceab6a 100644 --- a/docs/ResourceTypeMinimalDto.md +++ b/docs/ResourceTypeMinimalDto.md @@ -5,8 +5,8 @@ Represents a minimal Data Transfer Object (DTO) for a resource type. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | The unique identifier of the resource type. | [optional] -**SpecificType** | **string** | The specific type of the resource. | [optional] +**Id** | **Guid** | The unique identifier of the resource type. | +**SpecificType** | **string** | The specific type of the resource. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RoleApi.md b/docs/RoleApi.md index e9f65fcfa5465cf0389b81152da7e4935f9683d3..3b87f26d127769e64bdbf465d832f7b412f3f190 100644 --- a/docs/RoleApi.md +++ b/docs/RoleApi.md @@ -89,7 +89,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -218,7 +218,7 @@ namespace Example var apiInstance = new RoleApi(config); var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/RoleDto.md b/docs/RoleDto.md index 09f3bc7f7f4cb6c871c364c387663faa216c4f5a..2f56440bd0f4bb2e4b812df8395b194caeffdf72 100644 --- a/docs/RoleDto.md +++ b/docs/RoleDto.md @@ -5,9 +5,9 @@ Represents a Data Transfer Object (DTO) for a role. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | The unique identifier of the role. | [optional] -**DisplayName** | **string** | The display name of the role. | [optional] -**Description** | **string** | The description of the role. | [optional] +**Id** | **Guid** | The unique identifier of the role. | +**DisplayName** | **string** | The display name of the role. | +**Description** | **string** | The description of the role. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RoleMinimalDto.md b/docs/RoleMinimalDto.md index 3d5c6f707ae0d865e3590b5095a73d21faac096c..69d3175ab12fc6efde56fc2a8e0b8503e0825625 100644 --- a/docs/RoleMinimalDto.md +++ b/docs/RoleMinimalDto.md @@ -5,7 +5,7 @@ Represents a Data Transfer Object (DTO) containing minimal information about a r Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | The unique identifier of the role. | [optional] +**Id** | **Guid** | The unique identifier of the role. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SearchApi.md b/docs/SearchApi.md index 3529894ef306ed4a4e82d38c8d13ebc3483803c3..9c8ac31f0090a02464946984b78c05294e333f4a 100644 --- a/docs/SearchApi.md +++ b/docs/SearchApi.md @@ -88,7 +88,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -126,7 +126,7 @@ namespace Example var category = new SearchCategoryType?(); // SearchCategoryType? | Set the category filter (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/SearchResultDto.md b/docs/SearchResultDto.md index 71e4e71efc058371f8b4c7894c12ee7ced517676..ae89704c7fbc837e13cd1e942d9cdf17d6152596 100644 --- a/docs/SearchResultDto.md +++ b/docs/SearchResultDto.md @@ -5,9 +5,9 @@ Represents a Data Transfer Object (DTO) for search results. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Uri** | **string** | The URI associated with the search result. | [optional] -**Type** | **SearchCategoryType** | | [optional] -**Source** | **Object** | The dynamic source data for the search result. | [optional] +**Uri** | **string** | The URI associated with the search result. | +**Type** | **SearchCategoryType** | | +**Source** | **Object** | The dynamic source data for the search result. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SelfApi.md b/docs/SelfApi.md index b4fa527436286adb5acf668a635ac1a0570886dc..3a4e9bbf43ac971335496906936d929363c8b5be 100644 --- a/docs/SelfApi.md +++ b/docs/SelfApi.md @@ -184,7 +184,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/SelfApiTokenApi.md b/docs/SelfApiTokenApi.md index f43826efa262c662e1e28d2d68a473866c0e177e..3d2b97471ff4e62acc039352036dc5168cf2fcc0 100644 --- a/docs/SelfApiTokenApi.md +++ b/docs/SelfApiTokenApi.md @@ -91,7 +91,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -221,7 +221,7 @@ namespace Example var apiInstance = new SelfApiTokenApi(config); var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/SelfSessionApi.md b/docs/SelfSessionApi.md index d1f5e0bc0be4a2e6c353f86433c37bf47460aa4e..cf1b1bea9e31711b2e0fbf283f168ac92947a8aa 100644 --- a/docs/SelfSessionApi.md +++ b/docs/SelfSessionApi.md @@ -91,7 +91,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -176,7 +176,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -261,7 +261,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -351,7 +351,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -441,7 +441,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/SystemStatusApi.md b/docs/SystemStatusApi.md index 9fd1d2753c651466213afeda4168ee2251542f6a..8c00d02e1707466d2a2f96a6a319e31a4ab3eeb7 100644 --- a/docs/SystemStatusApi.md +++ b/docs/SystemStatusApi.md @@ -89,7 +89,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -121,15 +121,15 @@ namespace Example // config.AddApiKeyPrefix("Authorization", "Bearer"); var apiInstance = new SystemStatusApi(config); - var startDateAfter = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their start date after this date. (optional) - var startDateBefore = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their start date before this date. (optional) - var endDateAfter = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their end date after this date. (optional) - var endDateBefore = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their end date before this date. (optional) + var startDateAfter = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their start date after this date (UTC). (optional) + var startDateBefore = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their start date before this date (UTC). (optional) + var endDateAfter = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their end date after this date (UTC). (optional) + var endDateBefore = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their end date before this date (UTC). (optional) var type = new MessageType?(); // MessageType? | Filter messages by their type (e.g. information, warning, error). (optional) var searchTerm = "searchTerm_example"; // string? | Filter messages by text contained in the messages or title. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { @@ -172,10 +172,10 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **startDateAfter** | **DateTime?** | Will only return messages that have their start date after this date. | [optional] | -| **startDateBefore** | **DateTime?** | Will only return messages that have their start date before this date. | [optional] | -| **endDateAfter** | **DateTime?** | Will only return messages that have their end date after this date. | [optional] | -| **endDateBefore** | **DateTime?** | Will only return messages that have their end date before this date. | [optional] | +| **startDateAfter** | **DateTime?** | Will only return messages that have their start date after this date (UTC). | [optional] | +| **startDateBefore** | **DateTime?** | Will only return messages that have their start date before this date (UTC). | [optional] | +| **endDateAfter** | **DateTime?** | Will only return messages that have their end date after this date (UTC). | [optional] | +| **endDateBefore** | **DateTime?** | Will only return messages that have their end date before this date (UTC). | [optional] | | **type** | [**MessageType?**](MessageType?.md) | Filter messages by their type (e.g. information, warning, error). | [optional] | | **searchTerm** | **string?** | Filter messages by text contained in the messages or title. | [optional] | | **pageNumber** | **int?** | The desired page number. Should be greater than or equal to 1. Default is 1. | [optional] | @@ -231,15 +231,15 @@ namespace Example // config.AddApiKeyPrefix("Authorization", "Bearer"); var apiInstance = new SystemStatusApi(config); - var startDateAfter = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their start date after this date. (optional) - var startDateBefore = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their start date before this date. (optional) - var endDateAfter = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their end date after this date. (optional) - var endDateBefore = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their end date before this date. (optional) + var startDateAfter = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their start date after this date (UTC). (optional) + var startDateBefore = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their start date before this date (UTC). (optional) + var endDateAfter = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their end date after this date (UTC). (optional) + var endDateBefore = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their end date before this date (UTC). (optional) var type = new MessageType?(); // MessageType? | Filter messages by their type (e.g. information, warning, error). (optional) var searchTerm = "searchTerm_example"; // string? | Filter messages by text contained in the messages or title. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { @@ -282,10 +282,10 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **startDateAfter** | **DateTime?** | Will only return messages that have their start date after this date. | [optional] | -| **startDateBefore** | **DateTime?** | Will only return messages that have their start date before this date. | [optional] | -| **endDateAfter** | **DateTime?** | Will only return messages that have their end date after this date. | [optional] | -| **endDateBefore** | **DateTime?** | Will only return messages that have their end date before this date. | [optional] | +| **startDateAfter** | **DateTime?** | Will only return messages that have their start date after this date (UTC). | [optional] | +| **startDateBefore** | **DateTime?** | Will only return messages that have their start date before this date (UTC). | [optional] | +| **endDateAfter** | **DateTime?** | Will only return messages that have their end date after this date (UTC). | [optional] | +| **endDateBefore** | **DateTime?** | Will only return messages that have their end date before this date (UTC). | [optional] | | **type** | [**MessageType?**](MessageType?.md) | Filter messages by their type (e.g. information, warning, error). | [optional] | | **searchTerm** | **string?** | Filter messages by text contained in the messages or title. | [optional] | | **pageNumber** | **int?** | The desired page number. Should be greater than or equal to 1. Default is 1. | [optional] | diff --git a/docs/TermsOfServiceDto.md b/docs/TermsOfServiceDto.md index 87551ffa3952c6b84ba24a1c575aad7fc31ac942..65e2486147f012c03ec1cf2f5bc36a01ff126fc1 100644 --- a/docs/TermsOfServiceDto.md +++ b/docs/TermsOfServiceDto.md @@ -5,9 +5,9 @@ Represents the Data Transfer Object (DTO) for terms of service information. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**VarVersion** | **string** | The version of the terms of service. | [optional] -**Href** | **string** | The URI point to the content of ToS' version | [optional] -**IsCurrent** | **bool** | Indicates whether these terms of service are current or not. | [optional] +**VarVersion** | **string** | The version of the terms of service. | +**Href** | **string** | The URI point to the content of ToS' version | +**IsCurrent** | **bool** | Indicates whether these terms of service are current or not. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TitleApi.md b/docs/TitleApi.md index 38ac118431bb7644aba877ab8974b626bfcac5d1..f6fcb093bc9d802f09f2e3bd4a6d954aca020b5c 100644 --- a/docs/TitleApi.md +++ b/docs/TitleApi.md @@ -89,7 +89,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -218,7 +218,7 @@ namespace Example var apiInstance = new TitleApi(config); var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/TitleDto.md b/docs/TitleDto.md index e56bb9b5839b24d0d2b6f9084b8078bb9f2a7a1c..0bc20df49bfa53ccd1e17efed6d3693da4086a3c 100644 --- a/docs/TitleDto.md +++ b/docs/TitleDto.md @@ -5,8 +5,8 @@ Represents the Data Transfer Object (DTO) for title information. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | The identifier for the title. | [optional] -**DisplayName** | **string** | The displayed name of the title. | [optional] +**Id** | **Guid** | The identifier for the title. | +**DisplayName** | **string** | The displayed name of the title. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TosApi.md b/docs/TosApi.md index b51ec29a3d5eafb1a8ddf509fd1dfa30e95e6e40..7195cb43e528cdfa57fe6514dec023f9ba2459ec 100644 --- a/docs/TosApi.md +++ b/docs/TosApi.md @@ -88,7 +88,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/TreeApi.md b/docs/TreeApi.md index 8c72c0e7fe28108eef55fb33381625f624a1c6ea..1e9eae4d3b4b6465637217dbeaea9ba210f841ba 100644 --- a/docs/TreeApi.md +++ b/docs/TreeApi.md @@ -102,7 +102,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -444,7 +444,7 @@ namespace Example var path = "path_example"; // string? | Gets or sets the path of the file tree. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { @@ -554,7 +554,7 @@ namespace Example var includeProvenance = true; // bool? | Gets or sets if provenance metadata should be included. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/UserApi.md b/docs/UserApi.md index b7edc6c97307a150ceb09e07b1be1ee819f7cb70..bca37a0aa9323190dc025f6c466e21d26fd2b1ba 100644 --- a/docs/UserApi.md +++ b/docs/UserApi.md @@ -88,7 +88,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/UserDto.md b/docs/UserDto.md index 77dd53be433cafa8a2b3475ed1e5b99afe076592..16228bd115dac0c501d7062658fe34fbd6ae6553 100644 --- a/docs/UserDto.md +++ b/docs/UserDto.md @@ -5,19 +5,18 @@ Represents a Data Transfer Object (DTO) for user-related information. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | The unique identifier of the user. | [optional] -**DisplayName** | **string** | The display name of the user. | [optional] -**GivenName** | **string** | The given name of the user. | [optional] -**FamilyName** | **string** | The family name of the user. | [optional] -**Emails** | [**List<UserEmailDto>**](UserEmailDto.md) | The email addresses associated with the user. | [optional] +**Id** | **Guid** | The unique identifier of the user. | +**DisplayName** | **string** | The display name of the user. | +**GivenName** | **string** | The given name of the user. | +**FamilyName** | **string** | The family name of the user. | +**Emails** | [**List<UserEmailDto>**](UserEmailDto.md) | The email addresses associated with the user. | **Title** | [**TitleDto**](TitleDto.md) | | [optional] -**Language** | [**LanguageDto**](LanguageDto.md) | | [optional] -**AreToSAccepted** | **bool** | Indicates if the terms of service are accepted by the user. | [optional] +**Language** | [**LanguageDto**](LanguageDto.md) | | +**AreToSAccepted** | **bool** | Indicates if the terms of service are accepted by the user. | **LatestActivity** | **DateTime?** | The date and time of the latest activity of the user. | [optional] -**Disciplines** | [**List<DisciplineDto>**](DisciplineDto.md) | The disciplines associated with the user. | [optional] -**Organizations** | [**List<UserOrganizationDto>**](UserOrganizationDto.md) | The organizations associated with the user. | [optional] -**Institutes** | [**List<UserInstituteDto>**](UserInstituteDto.md) | The institutes associated with the user. | [optional] -**Identities** | [**List<IdentityProviderDto>**](IdentityProviderDto.md) | The identity providers associated with the user. | [optional] +**Disciplines** | [**List<DisciplineDto>**](DisciplineDto.md) | The disciplines associated with the user. | +**Organizations** | [**List<UserOrganizationDto>**](UserOrganizationDto.md) | The organizations associated with the user. | +**Identities** | [**List<IdentityProviderDto>**](IdentityProviderDto.md) | The identity providers associated with the user. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UserForUpdateDto.md b/docs/UserForUpdateDto.md index aec4d48a18fbe2afb87ad2fdce648f467418a825..688af9ad599fd5f4de72d430f6156d0787e324a5 100644 --- a/docs/UserForUpdateDto.md +++ b/docs/UserForUpdateDto.md @@ -11,7 +11,6 @@ Name | Type | Description | Notes **Title** | [**TitleForUserManipulationDto**](TitleForUserManipulationDto.md) | | [optional] **Language** | [**LanguageForUserManipulationDto**](LanguageForUserManipulationDto.md) | | **Organization** | **string** | The user's organization. | [optional] -**Institute** | **string** | The user's institute. | [optional] **Disciplines** | [**List<DisciplineForUserManipulationDto>**](DisciplineForUserManipulationDto.md) | The disciplines associated with the user for manipulation. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UserMergeDto.md b/docs/UserMergeDto.md index 3d02819708ba0c10d28ce33b75bc56b6edf6a097..a8c46fa04641792f23a770bf5f5dcbf2f3708b08 100644 --- a/docs/UserMergeDto.md +++ b/docs/UserMergeDto.md @@ -5,7 +5,7 @@ Represents a Data Transfer Object (DTO) for merging user accounts. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Token** | **string** | The token required for merging user accounts. | [optional] +**Token** | **string** | The token required for merging user accounts. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UserMinimalDto.md b/docs/UserMinimalDto.md index 58afb47ce3a4ca5db5d00c17c417782e18b6df4e..9ca1fc3605acec8959b6b959af3b19aa7b3e9764 100644 --- a/docs/UserMinimalDto.md +++ b/docs/UserMinimalDto.md @@ -5,7 +5,7 @@ Represents a minimal Data Transfer Object (DTO) for user information. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **Guid** | The unique identifier for the user. | [optional] +**Id** | **Guid** | The unique identifier for the user. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UserOrganizationDto.md b/docs/UserOrganizationDto.md index ec68c5112ad5e6767bc1352733f0f816d59e8e04..34b10f305f48e43856dbf3c4f0c3ee07d9fadf3b 100644 --- a/docs/UserOrganizationDto.md +++ b/docs/UserOrganizationDto.md @@ -5,11 +5,11 @@ Represents a Data Transfer Object (DTO) for user-related organization informatio Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Uri** | **string** | The ROR (Research Organization Registry) ID of the organization. | [optional] -**DisplayName** | **string** | The display name of the organization. | [optional] +**Uri** | **string** | The ROR (Research Organization Registry) ID of the organization. | +**DisplayName** | **string** | The display name of the organization. | **Email** | **string** | The email address of the organization. | [optional] **PublicationAdvisoryService** | [**PublicationAdvisoryServiceDto**](PublicationAdvisoryServiceDto.md) | | [optional] -**ReadOnly** | **bool** | Determines if the organization's details can be modified. | [optional] +**ReadOnly** | **bool** | Determines if the organization's details can be modified. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/VisibilityApi.md b/docs/VisibilityApi.md index 583e6a866a2ed6107e120df00448f295ebb27b9c..8bd562295f7943aae618e20bc5b5fc4f02eed4c7 100644 --- a/docs/VisibilityApi.md +++ b/docs/VisibilityApi.md @@ -89,7 +89,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -123,7 +123,7 @@ namespace Example var apiInstance = new VisibilityApi(config); var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/VocabularyApi.md b/docs/VocabularyApi.md index d5de6ec1bcdcb5997e1080f46271987f7fcdc68e..242e3ddafa36dca19d0ad18671e2e972c1519efd 100644 --- a/docs/VocabularyApi.md +++ b/docs/VocabularyApi.md @@ -90,7 +90,7 @@ void (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | Success | - | +| **200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -126,7 +126,7 @@ namespace Example var language = new AcceptedLanguage?(); // AcceptedLanguage? | Gets or sets the language for which the vocabularies are requested. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { @@ -327,7 +327,7 @@ namespace Example var language = new AcceptedLanguage?(); // AcceptedLanguage? | Gets or sets the language for which the vocabulary instances are requested. (optional) var pageSize = 56; // int? | Number of items per page. The maximum number of items per page is `150`. (optional) var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional) - var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) + var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional) try { diff --git a/docs/VocabularyDto.md b/docs/VocabularyDto.md index f951bbe47d72f0ddaa99a70e9003bd691228e4a0..b6d966ea696e2a6d68cf0aa76c862b9edb33b0b3 100644 --- a/docs/VocabularyDto.md +++ b/docs/VocabularyDto.md @@ -5,8 +5,8 @@ Represents a Data Transfer Object (DTO) for vocabulary details. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**GraphUri** | **string** | The URI of the graph containing the vocabulary. | [optional] -**ClassUri** | **string** | The URI of the top-level parent class in the vocabulary. | [optional] +**GraphUri** | **string** | The URI of the graph containing the vocabulary. | +**ClassUri** | **string** | The URI of the top-level parent class in the vocabulary. | **DisplayName** | **string** | The display name of the vocabulary. | [optional] **Description** | **string** | The description of the vocabulary. | [optional] diff --git a/docs/VocabularyInstanceDto.md b/docs/VocabularyInstanceDto.md index e89c7bbf62fecfbea6d386346ce74e12a0b36217..3ee59d0259d95077130c8d25854e6967cc5c934e 100644 --- a/docs/VocabularyInstanceDto.md +++ b/docs/VocabularyInstanceDto.md @@ -5,7 +5,7 @@ Represents a Data Transfer Object (DTO) for vocabulary instance details. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**GraphUri** | **string** | The URI of the graph containing the vocabulary. | [optional] +**GraphUri** | **string** | The URI of the graph containing the vocabulary. | **InstanceUri** | **string** | The URI of the instance. | [optional] **TypeUri** | **string** | The URI representing the type of the instance. | [optional] **SubClassOfUri** | **string** | The URI of the direct parent class. | [optional] diff --git a/src/Coscine.ApiClient.Core.Test/Coscine.ApiClient.Core.Test.csproj b/src/Coscine.ApiClient.Core.Test/Coscine.ApiClient.Core.Test.csproj index ba8fd716e7d85fa95ba47d19e9a1ed514568359f..4f5781e92c5d4e3b2b83d7d65070a60de9fe2fb3 100644 --- a/src/Coscine.ApiClient.Core.Test/Coscine.ApiClient.Core.Test.csproj +++ b/src/Coscine.ApiClient.Core.Test/Coscine.ApiClient.Core.Test.csproj @@ -6,7 +6,7 @@ <TargetFramework>net8.0</TargetFramework> <IsPackable>false</IsPackable> <Nullable>annotations</Nullable> - <Version>1.9.3</Version></PropertyGroup> + </PropertyGroup> <ItemGroup> <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" /> diff --git a/src/Coscine.ApiClient.Core.Test/Model/OrganizationForProjectManipulationDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/OrganizationForProjectManipulationDtoTests.cs index 9d17d4919e05bbe190fa42cd6f35f05ab18e7bcc..9382ae152083b4552605583c326f1987d341b047 100644 --- a/src/Coscine.ApiClient.Core.Test/Model/OrganizationForProjectManipulationDtoTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Model/OrganizationForProjectManipulationDtoTests.cs @@ -63,5 +63,14 @@ namespace Coscine.ApiClient.Core.Test.Model { // TODO unit test for the property 'Uri' } + + /// <summary> + /// Test the property 'Responsible' + /// </summary> + [Fact] + public void ResponsibleTest() + { + // TODO unit test for the property 'Responsible' + } } } diff --git a/src/Coscine.ApiClient.Core.Test/Model/UserInstituteDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/ProjectOrganizationDtoTests.cs similarity index 73% rename from src/Coscine.ApiClient.Core.Test/Model/UserInstituteDtoTests.cs rename to src/Coscine.ApiClient.Core.Test/Model/ProjectOrganizationDtoTests.cs index 4fb040e16949b1f43f23685a55685b307291accb..0684baaeb0a41b42fea29bcafe78f109f42447e1 100644 --- a/src/Coscine.ApiClient.Core.Test/Model/UserInstituteDtoTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Model/ProjectOrganizationDtoTests.cs @@ -23,21 +23,21 @@ using Newtonsoft.Json; namespace Coscine.ApiClient.Core.Test.Model { /// <summary> - /// Class for testing UserInstituteDto + /// Class for testing ProjectOrganizationDto /// </summary> /// <remarks> /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). /// Please update the test case below to test the model. /// </remarks> - public class UserInstituteDtoTests : IDisposable + public class ProjectOrganizationDtoTests : IDisposable { - // TODO uncomment below to declare an instance variable for UserInstituteDto - //private UserInstituteDto instance; + // TODO uncomment below to declare an instance variable for ProjectOrganizationDto + //private ProjectOrganizationDto instance; - public UserInstituteDtoTests() + public ProjectOrganizationDtoTests() { - // TODO uncomment below to create an instance of UserInstituteDto - //instance = new UserInstituteDto(); + // TODO uncomment below to create an instance of ProjectOrganizationDto + //instance = new ProjectOrganizationDto(); } public void Dispose() @@ -46,13 +46,13 @@ namespace Coscine.ApiClient.Core.Test.Model } /// <summary> - /// Test an instance of UserInstituteDto + /// Test an instance of ProjectOrganizationDto /// </summary> [Fact] - public void UserInstituteDtoInstanceTest() + public void ProjectOrganizationDtoInstanceTest() { - // TODO uncomment below to test "IsType" UserInstituteDto - //Assert.IsType<UserInstituteDto>(instance); + // TODO uncomment below to test "IsType" ProjectOrganizationDto + //Assert.IsType<ProjectOrganizationDto>(instance); } /// <summary> @@ -92,12 +92,12 @@ namespace Coscine.ApiClient.Core.Test.Model } /// <summary> - /// Test the property 'ReadOnly' + /// Test the property 'Responsible' /// </summary> [Fact] - public void ReadOnlyTest() + public void ResponsibleTest() { - // TODO unit test for the property 'ReadOnly' + // TODO unit test for the property 'Responsible' } } } diff --git a/src/Coscine.ApiClient.Core.Test/Model/UserDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/UserDtoTests.cs index 562f27b991fb46947a1a67621049e2ca4ebd6c37..880e0b4cfc004ac046dd44e5eb3a6e580816de4d 100644 --- a/src/Coscine.ApiClient.Core.Test/Model/UserDtoTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Model/UserDtoTests.cs @@ -154,15 +154,6 @@ namespace Coscine.ApiClient.Core.Test.Model // TODO unit test for the property 'Organizations' } - /// <summary> - /// Test the property 'Institutes' - /// </summary> - [Fact] - public void InstitutesTest() - { - // TODO unit test for the property 'Institutes' - } - /// <summary> /// Test the property 'Identities' /// </summary> diff --git a/src/Coscine.ApiClient.Core.Test/Model/UserForUpdateDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/UserForUpdateDtoTests.cs index deb80e03e09f8d07688b5a9dee1da592aa01be5b..413800c388da28d59d701822cac06ea37a5ffe3a 100644 --- a/src/Coscine.ApiClient.Core.Test/Model/UserForUpdateDtoTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Model/UserForUpdateDtoTests.cs @@ -109,15 +109,6 @@ namespace Coscine.ApiClient.Core.Test.Model // TODO unit test for the property 'Organization' } - /// <summary> - /// Test the property 'Institute' - /// </summary> - [Fact] - public void InstituteTest() - { - // TODO unit test for the property 'Institute' - } - /// <summary> /// Test the property 'Disciplines' /// </summary> diff --git a/src/Coscine.ApiClient.Core/Api/SystemStatusApi.cs b/src/Coscine.ApiClient.Core/Api/SystemStatusApi.cs index 8dd35a26c85e8e6633b447a7e9d392d2ae6baa8f..581b6704e444f826136473de013cf20e1e994eda 100644 --- a/src/Coscine.ApiClient.Core/Api/SystemStatusApi.cs +++ b/src/Coscine.ApiClient.Core/Api/SystemStatusApi.cs @@ -49,10 +49,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves the internal messages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -69,10 +69,10 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -85,10 +85,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves the NOC messages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -105,10 +105,10 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -156,10 +156,10 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -177,10 +177,10 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -197,10 +197,10 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -218,10 +218,10 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -487,10 +487,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves the internal messages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -508,10 +508,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves the internal messages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -608,10 +608,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves the internal messages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -630,10 +630,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves the internal messages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -733,10 +733,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves the NOC messages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -754,10 +754,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves the NOC messages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -854,10 +854,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves the NOC messages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> @@ -876,10 +876,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves the NOC messages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="startDateAfter">Will only return messages that have their start date after this date. (optional)</param> - /// <param name="startDateBefore">Will only return messages that have their start date before this date. (optional)</param> - /// <param name="endDateAfter">Will only return messages that have their end date after this date. (optional)</param> - /// <param name="endDateBefore">Will only return messages that have their end date before this date. (optional)</param> + /// <param name="startDateAfter">Will only return messages that have their start date after this date (UTC). (optional)</param> + /// <param name="startDateBefore">Will only return messages that have their start date before this date (UTC). (optional)</param> + /// <param name="endDateAfter">Will only return messages that have their end date after this date (UTC). (optional)</param> + /// <param name="endDateBefore">Will only return messages that have their end date before this date (UTC). (optional)</param> /// <param name="type">Filter messages by their type (e.g. information, warning, error). (optional)</param> /// <param name="searchTerm">Filter messages by text contained in the messages or title. (optional)</param> /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> diff --git a/src/Coscine.ApiClient.Core/Coscine.ApiClient.Core.csproj b/src/Coscine.ApiClient.Core/Coscine.ApiClient.Core.csproj index 6920b683236858a8ba8a29e3cd8a7837a8cb42e5..d95edf2ca80568e9c968c8ce97ff606524cee21e 100644 --- a/src/Coscine.ApiClient.Core/Coscine.ApiClient.Core.csproj +++ b/src/Coscine.ApiClient.Core/Coscine.ApiClient.Core.csproj @@ -12,7 +12,7 @@ <Description>A library generated from a OpenAPI doc</Description> <Copyright>No Copyright</Copyright> <RootNamespace>Coscine.ApiClient.Core</RootNamespace> - <Version>1.9.3</Version> + <Version>1.0.0</Version> <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\Coscine.ApiClient.Core.xml</DocumentationFile> <RepositoryUrl>https://github.com/GIT_USER_ID/GIT_REPO_ID.git</RepositoryUrl> <RepositoryType>git</RepositoryType> diff --git a/src/Coscine.ApiClient.Core/Model/ApplicationProfileDto.cs b/src/Coscine.ApiClient.Core/Model/ApplicationProfileDto.cs index 4ea4e4f9abb9a47cfeb8e25572e763459a426f9b..6c1ed298f3684cd33831a5e3f3b152ed0217e34e 100644 --- a/src/Coscine.ApiClient.Core/Model/ApplicationProfileDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ApplicationProfileDto.cs @@ -35,12 +35,22 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ApplicationProfileDto" /> class. /// </summary> - /// <param name="uri">The URI associated with the application profile..</param> + [JsonConstructorAttribute] + protected ApplicationProfileDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="ApplicationProfileDto" /> class. + /// </summary> + /// <param name="uri">The URI associated with the application profile. (required).</param> /// <param name="displayName">The display name for the application profile..</param> /// <param name="description">The description of the application profile..</param> /// <param name="definition">definition.</param> public ApplicationProfileDto(string uri = default(string), string displayName = default(string), string description = default(string), RdfDefinitionDto definition = default(RdfDefinitionDto)) { + // to ensure "uri" is required (not null) + if (uri == null) + { + throw new ArgumentNullException("uri is a required property for ApplicationProfileDto and cannot be null"); + } this.Uri = uri; this.DisplayName = displayName; this.Description = description; @@ -51,7 +61,7 @@ namespace Coscine.ApiClient.Core.Model /// The URI associated with the application profile. /// </summary> /// <value>The URI associated with the application profile.</value> - [DataMember(Name = "uri", EmitDefaultValue = false)] + [DataMember(Name = "uri", IsRequired = true, EmitDefaultValue = true)] public string Uri { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/ApplicationProfileMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/ApplicationProfileMinimalDto.cs index fc4d7990191fe7d871316f109a523608603f97ad..227607e28f1138ac42fc1d0de97045baf9347905 100644 --- a/src/Coscine.ApiClient.Core/Model/ApplicationProfileMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ApplicationProfileMinimalDto.cs @@ -35,9 +35,19 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ApplicationProfileMinimalDto" /> class. /// </summary> - /// <param name="uri">The URI associated with the application profile..</param> + [JsonConstructorAttribute] + protected ApplicationProfileMinimalDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="ApplicationProfileMinimalDto" /> class. + /// </summary> + /// <param name="uri">The URI associated with the application profile. (required).</param> public ApplicationProfileMinimalDto(string uri = default(string)) { + // to ensure "uri" is required (not null) + if (uri == null) + { + throw new ArgumentNullException("uri is a required property for ApplicationProfileMinimalDto and cannot be null"); + } this.Uri = uri; } @@ -45,7 +55,7 @@ namespace Coscine.ApiClient.Core.Model /// The URI associated with the application profile. /// </summary> /// <value>The URI associated with the application profile.</value> - [DataMember(Name = "uri", EmitDefaultValue = false)] + [DataMember(Name = "uri", IsRequired = true, EmitDefaultValue = true)] public string Uri { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/GitlabBranchDto.cs b/src/Coscine.ApiClient.Core/Model/GitlabBranchDto.cs index 980b581858f29fe15675ed1b08f5895e80905668..4b52fcfe52fadae75b4bdd8e213ed488448481cb 100644 --- a/src/Coscine.ApiClient.Core/Model/GitlabBranchDto.cs +++ b/src/Coscine.ApiClient.Core/Model/GitlabBranchDto.cs @@ -35,15 +35,25 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="GitlabBranchDto" /> class. /// </summary> - /// <param name="name">The name of the GitLab branch..</param> - /// <param name="merged">Indicates if the branch is merged..</param> - /// <param name="varProtected">Indicates if the branch is protected..</param> - /// <param name="varDefault">Indicates if the branch is set as default..</param> - /// <param name="developersCanPush">Indicates if developers can push changes to the branch..</param> - /// <param name="developersCanMerge">Indicates if developers can merge changes into the branch..</param> - /// <param name="canPush">Indicates if the user can push changes to the branch..</param> + [JsonConstructorAttribute] + protected GitlabBranchDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="GitlabBranchDto" /> class. + /// </summary> + /// <param name="name">The name of the GitLab branch. (required).</param> + /// <param name="merged">Indicates if the branch is merged. (required).</param> + /// <param name="varProtected">Indicates if the branch is protected. (required).</param> + /// <param name="varDefault">Indicates if the branch is set as default. (required).</param> + /// <param name="developersCanPush">Indicates if developers can push changes to the branch. (required).</param> + /// <param name="developersCanMerge">Indicates if developers can merge changes into the branch. (required).</param> + /// <param name="canPush">Indicates if the user can push changes to the branch. (required).</param> public GitlabBranchDto(string name = default(string), bool merged = default(bool), bool varProtected = default(bool), bool varDefault = default(bool), bool developersCanPush = default(bool), bool developersCanMerge = default(bool), bool canPush = default(bool)) { + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for GitlabBranchDto and cannot be null"); + } this.Name = name; this.Merged = merged; this.Protected = varProtected; @@ -57,49 +67,49 @@ namespace Coscine.ApiClient.Core.Model /// The name of the GitLab branch. /// </summary> /// <value>The name of the GitLab branch.</value> - [DataMember(Name = "name", EmitDefaultValue = false)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> /// Indicates if the branch is merged. /// </summary> /// <value>Indicates if the branch is merged.</value> - [DataMember(Name = "merged", EmitDefaultValue = true)] + [DataMember(Name = "merged", IsRequired = true, EmitDefaultValue = true)] public bool Merged { get; set; } /// <summary> /// Indicates if the branch is protected. /// </summary> /// <value>Indicates if the branch is protected.</value> - [DataMember(Name = "protected", EmitDefaultValue = true)] + [DataMember(Name = "protected", IsRequired = true, EmitDefaultValue = true)] public bool Protected { get; set; } /// <summary> /// Indicates if the branch is set as default. /// </summary> /// <value>Indicates if the branch is set as default.</value> - [DataMember(Name = "default", EmitDefaultValue = true)] + [DataMember(Name = "default", IsRequired = true, EmitDefaultValue = true)] public bool Default { get; set; } /// <summary> /// Indicates if developers can push changes to the branch. /// </summary> /// <value>Indicates if developers can push changes to the branch.</value> - [DataMember(Name = "developersCanPush", EmitDefaultValue = true)] + [DataMember(Name = "developersCanPush", IsRequired = true, EmitDefaultValue = true)] public bool DevelopersCanPush { get; set; } /// <summary> /// Indicates if developers can merge changes into the branch. /// </summary> /// <value>Indicates if developers can merge changes into the branch.</value> - [DataMember(Name = "developersCanMerge", EmitDefaultValue = true)] + [DataMember(Name = "developersCanMerge", IsRequired = true, EmitDefaultValue = true)] public bool DevelopersCanMerge { get; set; } /// <summary> /// Indicates if the user can push changes to the branch. /// </summary> /// <value>Indicates if the user can push changes to the branch.</value> - [DataMember(Name = "canPush", EmitDefaultValue = true)] + [DataMember(Name = "canPush", IsRequired = true, EmitDefaultValue = true)] public bool CanPush { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/GitlabProjectDto.cs b/src/Coscine.ApiClient.Core/Model/GitlabProjectDto.cs index 68cceeafacbd2355ec1d1f171b95e0f3ef3288d6..74e3c45ac3813fac87b4d2188cc3d7f8b733d3b1 100644 --- a/src/Coscine.ApiClient.Core/Model/GitlabProjectDto.cs +++ b/src/Coscine.ApiClient.Core/Model/GitlabProjectDto.cs @@ -35,33 +35,93 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="GitlabProjectDto" /> class. /// </summary> - /// <param name="id">The unique identifier for the GitLab project..</param> - /// <param name="archived">Indicates if the GitLab project is archived..</param> - /// <param name="name">The name of the GitLab project..</param> - /// <param name="nameWithNamespace">The full name of the GitLab project including namespace..</param> - /// <param name="description">A brief description of the GitLab project..</param> - /// <param name="defaultBranch">The default branch of the GitLab project..</param> - /// <param name="path">The path of the GitLab project..</param> - /// <param name="pathWithNamespace">The path of the GitLab project including namespace..</param> - /// <param name="lastActivityAt">The timestamp of the last activity related to the GitLab project..</param> - /// <param name="createdAt">The creation timestamp of the GitLab project..</param> - /// <param name="webUrl">The URL to view the GitLab project in a web browser..</param> - /// <param name="httpUrlToRepo">The HTTP URL to access the GitLab project repository..</param> - /// <param name="sshUrlToRepo">The SSH URL to access the GitLab project repository..</param> + [JsonConstructorAttribute] + protected GitlabProjectDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="GitlabProjectDto" /> class. + /// </summary> + /// <param name="id">The unique identifier for the GitLab project. (required).</param> + /// <param name="archived">Indicates if the GitLab project is archived. (required).</param> + /// <param name="name">The name of the GitLab project. (required).</param> + /// <param name="nameWithNamespace">The full name of the GitLab project including namespace. (required).</param> + /// <param name="description">A brief description of the GitLab project. (required).</param> + /// <param name="defaultBranch">The default branch of the GitLab project. (required).</param> + /// <param name="path">The path of the GitLab project. (required).</param> + /// <param name="pathWithNamespace">The path of the GitLab project including namespace. (required).</param> + /// <param name="lastActivityAt">The timestamp of the last activity related to the GitLab project. (required).</param> + /// <param name="createdAt">The creation timestamp of the GitLab project. (required).</param> + /// <param name="webUrl">The URL to view the GitLab project in a web browser. (required).</param> + /// <param name="httpUrlToRepo">The HTTP URL to access the GitLab project repository. (required).</param> + /// <param name="sshUrlToRepo">The SSH URL to access the GitLab project repository. (required).</param> public GitlabProjectDto(int id = default(int), bool archived = default(bool), string name = default(string), string nameWithNamespace = default(string), string description = default(string), string defaultBranch = default(string), string path = default(string), string pathWithNamespace = default(string), string lastActivityAt = default(string), string createdAt = default(string), string webUrl = default(string), string httpUrlToRepo = default(string), string sshUrlToRepo = default(string)) { this.Id = id; this.Archived = archived; + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for GitlabProjectDto and cannot be null"); + } this.Name = name; + // to ensure "nameWithNamespace" is required (not null) + if (nameWithNamespace == null) + { + throw new ArgumentNullException("nameWithNamespace is a required property for GitlabProjectDto and cannot be null"); + } this.NameWithNamespace = nameWithNamespace; + // to ensure "description" is required (not null) + if (description == null) + { + throw new ArgumentNullException("description is a required property for GitlabProjectDto and cannot be null"); + } this.Description = description; + // to ensure "defaultBranch" is required (not null) + if (defaultBranch == null) + { + throw new ArgumentNullException("defaultBranch is a required property for GitlabProjectDto and cannot be null"); + } this.DefaultBranch = defaultBranch; + // to ensure "path" is required (not null) + if (path == null) + { + throw new ArgumentNullException("path is a required property for GitlabProjectDto and cannot be null"); + } this.Path = path; + // to ensure "pathWithNamespace" is required (not null) + if (pathWithNamespace == null) + { + throw new ArgumentNullException("pathWithNamespace is a required property for GitlabProjectDto and cannot be null"); + } this.PathWithNamespace = pathWithNamespace; + // to ensure "lastActivityAt" is required (not null) + if (lastActivityAt == null) + { + throw new ArgumentNullException("lastActivityAt is a required property for GitlabProjectDto and cannot be null"); + } this.LastActivityAt = lastActivityAt; + // to ensure "createdAt" is required (not null) + if (createdAt == null) + { + throw new ArgumentNullException("createdAt is a required property for GitlabProjectDto and cannot be null"); + } this.CreatedAt = createdAt; + // to ensure "webUrl" is required (not null) + if (webUrl == null) + { + throw new ArgumentNullException("webUrl is a required property for GitlabProjectDto and cannot be null"); + } this.WebUrl = webUrl; + // to ensure "httpUrlToRepo" is required (not null) + if (httpUrlToRepo == null) + { + throw new ArgumentNullException("httpUrlToRepo is a required property for GitlabProjectDto and cannot be null"); + } this.HttpUrlToRepo = httpUrlToRepo; + // to ensure "sshUrlToRepo" is required (not null) + if (sshUrlToRepo == null) + { + throw new ArgumentNullException("sshUrlToRepo is a required property for GitlabProjectDto and cannot be null"); + } this.SshUrlToRepo = sshUrlToRepo; } @@ -69,91 +129,91 @@ namespace Coscine.ApiClient.Core.Model /// The unique identifier for the GitLab project. /// </summary> /// <value>The unique identifier for the GitLab project.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public int Id { get; set; } /// <summary> /// Indicates if the GitLab project is archived. /// </summary> /// <value>Indicates if the GitLab project is archived.</value> - [DataMember(Name = "archived", EmitDefaultValue = true)] + [DataMember(Name = "archived", IsRequired = true, EmitDefaultValue = true)] public bool Archived { get; set; } /// <summary> /// The name of the GitLab project. /// </summary> /// <value>The name of the GitLab project.</value> - [DataMember(Name = "name", EmitDefaultValue = false)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> /// The full name of the GitLab project including namespace. /// </summary> /// <value>The full name of the GitLab project including namespace.</value> - [DataMember(Name = "nameWithNamespace", EmitDefaultValue = false)] + [DataMember(Name = "nameWithNamespace", IsRequired = true, EmitDefaultValue = true)] public string NameWithNamespace { get; set; } /// <summary> /// A brief description of the GitLab project. /// </summary> /// <value>A brief description of the GitLab project.</value> - [DataMember(Name = "description", EmitDefaultValue = false)] + [DataMember(Name = "description", IsRequired = true, EmitDefaultValue = true)] public string Description { get; set; } /// <summary> /// The default branch of the GitLab project. /// </summary> /// <value>The default branch of the GitLab project.</value> - [DataMember(Name = "defaultBranch", EmitDefaultValue = false)] + [DataMember(Name = "defaultBranch", IsRequired = true, EmitDefaultValue = true)] public string DefaultBranch { get; set; } /// <summary> /// The path of the GitLab project. /// </summary> /// <value>The path of the GitLab project.</value> - [DataMember(Name = "path", EmitDefaultValue = false)] + [DataMember(Name = "path", IsRequired = true, EmitDefaultValue = true)] public string Path { get; set; } /// <summary> /// The path of the GitLab project including namespace. /// </summary> /// <value>The path of the GitLab project including namespace.</value> - [DataMember(Name = "pathWithNamespace", EmitDefaultValue = false)] + [DataMember(Name = "pathWithNamespace", IsRequired = true, EmitDefaultValue = true)] public string PathWithNamespace { get; set; } /// <summary> /// The timestamp of the last activity related to the GitLab project. /// </summary> /// <value>The timestamp of the last activity related to the GitLab project.</value> - [DataMember(Name = "lastActivityAt", EmitDefaultValue = false)] + [DataMember(Name = "lastActivityAt", IsRequired = true, EmitDefaultValue = true)] public string LastActivityAt { get; set; } /// <summary> /// The creation timestamp of the GitLab project. /// </summary> /// <value>The creation timestamp of the GitLab project.</value> - [DataMember(Name = "createdAt", EmitDefaultValue = false)] + [DataMember(Name = "createdAt", IsRequired = true, EmitDefaultValue = true)] public string CreatedAt { get; set; } /// <summary> /// The URL to view the GitLab project in a web browser. /// </summary> /// <value>The URL to view the GitLab project in a web browser.</value> - [DataMember(Name = "webUrl", EmitDefaultValue = false)] + [DataMember(Name = "webUrl", IsRequired = true, EmitDefaultValue = true)] public string WebUrl { get; set; } /// <summary> /// The HTTP URL to access the GitLab project repository. /// </summary> /// <value>The HTTP URL to access the GitLab project repository.</value> - [DataMember(Name = "httpUrlToRepo", EmitDefaultValue = false)] + [DataMember(Name = "httpUrlToRepo", IsRequired = true, EmitDefaultValue = true)] public string HttpUrlToRepo { get; set; } /// <summary> /// The SSH URL to access the GitLab project repository. /// </summary> /// <value>The SSH URL to access the GitLab project repository.</value> - [DataMember(Name = "sshUrlToRepo", EmitDefaultValue = false)] + [DataMember(Name = "sshUrlToRepo", IsRequired = true, EmitDefaultValue = true)] public string SshUrlToRepo { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/HandleForUpdateDto.cs b/src/Coscine.ApiClient.Core/Model/HandleForUpdateDto.cs index 63f0c8aa5256e35ddbcac903d124e299dbce352a..6a3a336969b66504e3b466ba0cd4625b6a6e1f72 100644 --- a/src/Coscine.ApiClient.Core/Model/HandleForUpdateDto.cs +++ b/src/Coscine.ApiClient.Core/Model/HandleForUpdateDto.cs @@ -35,16 +35,26 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="HandleForUpdateDto" /> class. /// </summary> - /// <param name="values">values.</param> + [JsonConstructorAttribute] + protected HandleForUpdateDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="HandleForUpdateDto" /> class. + /// </summary> + /// <param name="values">values (required).</param> public HandleForUpdateDto(List<HandleValueForUpdateDto> values = default(List<HandleValueForUpdateDto>)) { + // to ensure "values" is required (not null) + if (values == null) + { + throw new ArgumentNullException("values is a required property for HandleForUpdateDto and cannot be null"); + } this.Values = values; } /// <summary> /// Gets or Sets Values /// </summary> - [DataMember(Name = "values", EmitDefaultValue = false)] + [DataMember(Name = "values", IsRequired = true, EmitDefaultValue = true)] public List<HandleValueForUpdateDto> Values { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/HandleValueForUpdateDto.cs b/src/Coscine.ApiClient.Core/Model/HandleValueForUpdateDto.cs index 0061996ace8147d467bde1098732c2dd4ce9edb2..92f1dd525c0edcbf5f97ffccb9e0cd335f418b40 100644 --- a/src/Coscine.ApiClient.Core/Model/HandleValueForUpdateDto.cs +++ b/src/Coscine.ApiClient.Core/Model/HandleValueForUpdateDto.cs @@ -35,12 +35,27 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="HandleValueForUpdateDto" /> class. /// </summary> - /// <param name="type">The data type of the handle..</param> - /// <param name="parsedData">The parsed data of the handle..</param> + [JsonConstructorAttribute] + protected HandleValueForUpdateDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="HandleValueForUpdateDto" /> class. + /// </summary> + /// <param name="type">The data type of the handle. (required).</param> + /// <param name="parsedData">The parsed data of the handle. (required).</param> /// <param name="idx">The id of the handle..</param> public HandleValueForUpdateDto(string type = default(string), Object parsedData = default(Object), int idx = default(int)) { + // to ensure "type" is required (not null) + if (type == null) + { + throw new ArgumentNullException("type is a required property for HandleValueForUpdateDto and cannot be null"); + } this.Type = type; + // to ensure "parsedData" is required (not null) + if (parsedData == null) + { + throw new ArgumentNullException("parsedData is a required property for HandleValueForUpdateDto and cannot be null"); + } this.ParsedData = parsedData; this.Idx = idx; } @@ -49,14 +64,14 @@ namespace Coscine.ApiClient.Core.Model /// The data type of the handle. /// </summary> /// <value>The data type of the handle.</value> - [DataMember(Name = "type", EmitDefaultValue = false)] + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } /// <summary> /// The parsed data of the handle. /// </summary> /// <value>The parsed data of the handle.</value> - [DataMember(Name = "parsed_data", EmitDefaultValue = true)] + [DataMember(Name = "parsed_data", IsRequired = true, EmitDefaultValue = true)] public Object ParsedData { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/IdentityProviderDto.cs b/src/Coscine.ApiClient.Core/Model/IdentityProviderDto.cs index b968a8d37164bd62871d0a25332f6312842f9cce..e16a1eafb98dc3a594468f9907f2984974bae7d3 100644 --- a/src/Coscine.ApiClient.Core/Model/IdentityProviderDto.cs +++ b/src/Coscine.ApiClient.Core/Model/IdentityProviderDto.cs @@ -35,11 +35,21 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="IdentityProviderDto" /> class. /// </summary> - /// <param name="id">Gets or sets the unique identifier for the identity provider..</param> - /// <param name="displayName">Gets or sets the display name of the identity provider..</param> + [JsonConstructorAttribute] + protected IdentityProviderDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="IdentityProviderDto" /> class. + /// </summary> + /// <param name="id">Gets or sets the unique identifier for the identity provider. (required).</param> + /// <param name="displayName">Gets or sets the display name of the identity provider. (required).</param> public IdentityProviderDto(Guid id = default(Guid), string displayName = default(string)) { this.Id = id; + // to ensure "displayName" is required (not null) + if (displayName == null) + { + throw new ArgumentNullException("displayName is a required property for IdentityProviderDto and cannot be null"); + } this.DisplayName = displayName; } @@ -47,14 +57,14 @@ namespace Coscine.ApiClient.Core.Model /// Gets or sets the unique identifier for the identity provider. /// </summary> /// <value>Gets or sets the unique identifier for the identity provider.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> /// Gets or sets the display name of the identity provider. /// </summary> /// <value>Gets or sets the display name of the identity provider.</value> - [DataMember(Name = "displayName", EmitDefaultValue = false)] + [DataMember(Name = "displayName", IsRequired = true, EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/LanguageDto.cs b/src/Coscine.ApiClient.Core/Model/LanguageDto.cs index 9064da071a01529a2b6a372302aa6f7e8dd8c27b..677d7e1a1f6f1ad4ed7fde28ec69c96ce0bd98a0 100644 --- a/src/Coscine.ApiClient.Core/Model/LanguageDto.cs +++ b/src/Coscine.ApiClient.Core/Model/LanguageDto.cs @@ -35,13 +35,28 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="LanguageDto" /> class. /// </summary> - /// <param name="id">Gets or sets the unique identifier for the language..</param> - /// <param name="displayName">Gets or sets the display name of the language..</param> - /// <param name="abbreviation">Gets or sets the abbreviation for the language..</param> + [JsonConstructorAttribute] + protected LanguageDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="LanguageDto" /> class. + /// </summary> + /// <param name="id">Gets or sets the unique identifier for the language. (required).</param> + /// <param name="displayName">Gets or sets the display name of the language. (required).</param> + /// <param name="abbreviation">Gets or sets the abbreviation for the language. (required).</param> public LanguageDto(Guid id = default(Guid), string displayName = default(string), string abbreviation = default(string)) { this.Id = id; + // to ensure "displayName" is required (not null) + if (displayName == null) + { + throw new ArgumentNullException("displayName is a required property for LanguageDto and cannot be null"); + } this.DisplayName = displayName; + // to ensure "abbreviation" is required (not null) + if (abbreviation == null) + { + throw new ArgumentNullException("abbreviation is a required property for LanguageDto and cannot be null"); + } this.Abbreviation = abbreviation; } @@ -49,21 +64,21 @@ namespace Coscine.ApiClient.Core.Model /// Gets or sets the unique identifier for the language. /// </summary> /// <value>Gets or sets the unique identifier for the language.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> /// Gets or sets the display name of the language. /// </summary> /// <value>Gets or sets the display name of the language.</value> - [DataMember(Name = "displayName", EmitDefaultValue = false)] + [DataMember(Name = "displayName", IsRequired = true, EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> /// Gets or sets the abbreviation for the language. /// </summary> /// <value>Gets or sets the abbreviation for the language.</value> - [DataMember(Name = "abbreviation", EmitDefaultValue = false)] + [DataMember(Name = "abbreviation", IsRequired = true, EmitDefaultValue = true)] public string Abbreviation { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/MessageDto.cs b/src/Coscine.ApiClient.Core/Model/MessageDto.cs index 35006fa7e2d9b62c18db08b6d2a887058cf327e9..81b3b84517839a2b7b624546cfee704f180484d0 100644 --- a/src/Coscine.ApiClient.Core/Model/MessageDto.cs +++ b/src/Coscine.ApiClient.Core/Model/MessageDto.cs @@ -41,15 +41,25 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="MessageDto" /> class. /// </summary> - /// <param name="id">ID of the message..</param> + [JsonConstructorAttribute] + protected MessageDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="MessageDto" /> class. + /// </summary> + /// <param name="id">ID of the message. (required).</param> /// <param name="body">Message body in multiple languages as key-value pairs. The key is the ISO 639-1 Alpha-2 two-letter language code, and the value is the message in that language..</param> /// <param name="type">type.</param> /// <param name="title">Title of the message..</param> /// <param name="href">URL related to the message..</param> - /// <param name="startDate">Start date of the message..</param> - /// <param name="endDate">End date of the message..</param> + /// <param name="startDate">Start date of the message (UTC)..</param> + /// <param name="endDate">End date of the message (UTC)..</param> public MessageDto(string id = default(string), Dictionary<string, string> body = default(Dictionary<string, string>), MessageType? type = default(MessageType?), string title = default(string), string href = default(string), DateTime? startDate = default(DateTime?), DateTime? endDate = default(DateTime?)) { + // to ensure "id" is required (not null) + if (id == null) + { + throw new ArgumentNullException("id is a required property for MessageDto and cannot be null"); + } this.Id = id; this.Body = body; this.Type = type; @@ -63,7 +73,7 @@ namespace Coscine.ApiClient.Core.Model /// ID of the message. /// </summary> /// <value>ID of the message.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public string Id { get; set; } /// <summary> @@ -88,16 +98,16 @@ namespace Coscine.ApiClient.Core.Model public string Href { get; set; } /// <summary> - /// Start date of the message. + /// Start date of the message (UTC). /// </summary> - /// <value>Start date of the message.</value> + /// <value>Start date of the message (UTC).</value> [DataMember(Name = "startDate", EmitDefaultValue = true)] public DateTime? StartDate { get; set; } /// <summary> - /// End date of the message. + /// End date of the message (UTC). /// </summary> - /// <value>End date of the message.</value> + /// <value>End date of the message (UTC).</value> [DataMember(Name = "endDate", EmitDefaultValue = true)] public DateTime? EndDate { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/OrganizationDto.cs b/src/Coscine.ApiClient.Core/Model/OrganizationDto.cs index dd7233b97027cca136c7fb3c67139d6702bcae26..eec212c9eef888d738f59a7173a8821c00971662 100644 --- a/src/Coscine.ApiClient.Core/Model/OrganizationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/OrganizationDto.cs @@ -35,13 +35,28 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="OrganizationDto" /> class. /// </summary> - /// <param name="uri">The ROR (Research Organization Registry) ID of the organization..</param> - /// <param name="displayName">The display name of the organization..</param> + [JsonConstructorAttribute] + protected OrganizationDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="OrganizationDto" /> class. + /// </summary> + /// <param name="uri">The ROR (Research Organization Registry) ID of the organization. (required).</param> + /// <param name="displayName">The display name of the organization. (required).</param> /// <param name="email">The email address of the organization..</param> /// <param name="publicationAdvisoryService">publicationAdvisoryService.</param> public OrganizationDto(string uri = default(string), string displayName = default(string), string email = default(string), PublicationAdvisoryServiceDto publicationAdvisoryService = default(PublicationAdvisoryServiceDto)) { + // to ensure "uri" is required (not null) + if (uri == null) + { + throw new ArgumentNullException("uri is a required property for OrganizationDto and cannot be null"); + } this.Uri = uri; + // to ensure "displayName" is required (not null) + if (displayName == null) + { + throw new ArgumentNullException("displayName is a required property for OrganizationDto and cannot be null"); + } this.DisplayName = displayName; this.Email = email; this.PublicationAdvisoryService = publicationAdvisoryService; @@ -51,14 +66,14 @@ namespace Coscine.ApiClient.Core.Model /// The ROR (Research Organization Registry) ID of the organization. /// </summary> /// <value>The ROR (Research Organization Registry) ID of the organization.</value> - [DataMember(Name = "uri", EmitDefaultValue = false)] + [DataMember(Name = "uri", IsRequired = true, EmitDefaultValue = true)] public string Uri { get; set; } /// <summary> /// The display name of the organization. /// </summary> /// <value>The display name of the organization.</value> - [DataMember(Name = "displayName", EmitDefaultValue = false)] + [DataMember(Name = "displayName", IsRequired = true, EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/OrganizationForProjectManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/OrganizationForProjectManipulationDto.cs index 7252f5138115b544afdd3fada68f5ce30a795418..621d266f3ef166c8c130d8714394ca144e90203a 100644 --- a/src/Coscine.ApiClient.Core/Model/OrganizationForProjectManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/OrganizationForProjectManipulationDto.cs @@ -41,7 +41,8 @@ namespace Coscine.ApiClient.Core.Model /// Initializes a new instance of the <see cref="OrganizationForProjectManipulationDto" /> class. /// </summary> /// <param name="uri">Gets or initializes the URI of the organization. (required).</param> - public OrganizationForProjectManipulationDto(string uri = default(string)) + /// <param name="responsible">Gets or initializes if the organization is responsible. (required).</param> + public OrganizationForProjectManipulationDto(string uri = default(string), bool responsible = default(bool)) { // to ensure "uri" is required (not null) if (uri == null) @@ -49,6 +50,7 @@ namespace Coscine.ApiClient.Core.Model throw new ArgumentNullException("uri is a required property for OrganizationForProjectManipulationDto and cannot be null"); } this.Uri = uri; + this.Responsible = responsible; } /// <summary> @@ -58,6 +60,13 @@ namespace Coscine.ApiClient.Core.Model [DataMember(Name = "uri", IsRequired = true, EmitDefaultValue = true)] public string Uri { get; set; } + /// <summary> + /// Gets or initializes if the organization is responsible. + /// </summary> + /// <value>Gets or initializes if the organization is responsible.</value> + [DataMember(Name = "responsible", IsRequired = true, EmitDefaultValue = true)] + public bool Responsible { get; set; } + /// <summary> /// Returns the string presentation of the object /// </summary> @@ -67,6 +76,7 @@ namespace Coscine.ApiClient.Core.Model StringBuilder sb = new StringBuilder(); sb.Append("class OrganizationForProjectManipulationDto {\n"); sb.Append(" Uri: ").Append(Uri).Append("\n"); + sb.Append(" Responsible: ").Append(Responsible).Append("\n"); sb.Append("}\n"); return sb.ToString(); } diff --git a/src/Coscine.ApiClient.Core/Model/PidDto.cs b/src/Coscine.ApiClient.Core/Model/PidDto.cs index f2b529b2d06e5343203a11da2f318922c9b43e3c..8960d3d989bb30b28b3dd19ec9f97b1acc6b959a 100644 --- a/src/Coscine.ApiClient.Core/Model/PidDto.cs +++ b/src/Coscine.ApiClient.Core/Model/PidDto.cs @@ -41,13 +41,28 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="PidDto" /> class. /// </summary> - /// <param name="prefix">Gets or sets the prefix of the PID..</param> - /// <param name="suffix">Gets or sets the suffix of the PID..</param> + [JsonConstructorAttribute] + protected PidDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="PidDto" /> class. + /// </summary> + /// <param name="prefix">Gets or sets the prefix of the PID. (required).</param> + /// <param name="suffix">Gets or sets the suffix of the PID. (required).</param> /// <param name="type">type.</param> /// <param name="isEntityValid">Gets or sets a value indicating whether the linked entity is considered valid..</param> public PidDto(string prefix = default(string), string suffix = default(string), PidType? type = default(PidType?), bool isEntityValid = default(bool)) { + // to ensure "prefix" is required (not null) + if (prefix == null) + { + throw new ArgumentNullException("prefix is a required property for PidDto and cannot be null"); + } this.Prefix = prefix; + // to ensure "suffix" is required (not null) + if (suffix == null) + { + throw new ArgumentNullException("suffix is a required property for PidDto and cannot be null"); + } this.Suffix = suffix; this.Type = type; this.IsEntityValid = isEntityValid; @@ -57,14 +72,14 @@ namespace Coscine.ApiClient.Core.Model /// Gets or sets the prefix of the PID. /// </summary> /// <value>Gets or sets the prefix of the PID.</value> - [DataMember(Name = "prefix", EmitDefaultValue = false)] + [DataMember(Name = "prefix", IsRequired = true, EmitDefaultValue = true)] public string Prefix { get; set; } /// <summary> /// Gets or sets the suffix of the PID. /// </summary> /// <value>Gets or sets the suffix of the PID.</value> - [DataMember(Name = "suffix", EmitDefaultValue = false)] + [DataMember(Name = "suffix", IsRequired = true, EmitDefaultValue = true)] public string Suffix { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/ProjectAdminDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectAdminDto.cs index 8f7bb8b9725f8ac79d54644650fd5b2107677f5e..62a6a71d09427959aa7b388c75fcb76becb94ff0 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectAdminDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectAdminDto.cs @@ -35,20 +35,25 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectAdminDto" /> class. /// </summary> - /// <param name="id">Unique identifier for the project..</param> - /// <param name="pid">Persistent identifier for the project..</param> - /// <param name="name">Name of the project..</param> - /// <param name="description">Description of the project..</param> - /// <param name="startDate">Start date of the project..</param> - /// <param name="endDate">End date of the project..</param> + [JsonConstructorAttribute] + protected ProjectAdminDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="ProjectAdminDto" /> class. + /// </summary> + /// <param name="id">Unique identifier for the project. (required).</param> + /// <param name="pid">Persistent identifier for the project. (required).</param> + /// <param name="name">Name of the project. (required).</param> + /// <param name="description">Description of the project. (required).</param> + /// <param name="startDate">Start date of the project. (required).</param> + /// <param name="endDate">End date of the project. (required).</param> /// <param name="keywords">Collection of keywords associated with the project..</param> /// <param name="displayName">Display name of the project..</param> /// <param name="principleInvestigators">Principal investigators involved in the project..</param> /// <param name="grantId">Grant ID associated with the project..</param> - /// <param name="visibility">visibility.</param> - /// <param name="disciplines">Disciplines related to the project..</param> - /// <param name="organizations">Organizations associated with the project..</param> - /// <param name="slug">Slug for the project..</param> + /// <param name="visibility">visibility (required).</param> + /// <param name="disciplines">Disciplines related to the project. (required).</param> + /// <param name="organizations">Organizations associated with the project. (required).</param> + /// <param name="slug">Slug for the project. (required).</param> /// <param name="creator">creator.</param> /// <param name="creationDate">Date of creation of the project..</param> /// <param name="subProjects">Collection of sub-projects associated with this project..</param> @@ -58,22 +63,57 @@ namespace Coscine.ApiClient.Core.Model /// <param name="projectRoles">Collection of minimal project role details associated with the project..</param> /// <param name="projectQuota">Collection of project quotas associated with the project..</param> /// <param name="publicationRequests">Collection of project publication requests associated with the project..</param> - public ProjectAdminDto(Guid id = default(Guid), string pid = default(string), string name = default(string), string description = default(string), DateTime startDate = default(DateTime), DateTime endDate = default(DateTime), List<string> keywords = default(List<string>), string displayName = default(string), string principleInvestigators = default(string), string grantId = default(string), VisibilityDto visibility = default(VisibilityDto), List<DisciplineDto> disciplines = default(List<DisciplineDto>), List<OrganizationDto> organizations = default(List<OrganizationDto>), string slug = default(string), UserMinimalDto creator = default(UserMinimalDto), DateTime? creationDate = default(DateTime?), List<ProjectDto> subProjects = default(List<ProjectDto>), ProjectMinimalDto parent = default(ProjectMinimalDto), bool deleted = default(bool), List<ProjectResourceMinimalDto> projectResources = default(List<ProjectResourceMinimalDto>), List<ProjectRoleMinimalDto> projectRoles = default(List<ProjectRoleMinimalDto>), List<ProjectQuotaDto> projectQuota = default(List<ProjectQuotaDto>), List<ProjectPublicationRequestDto> publicationRequests = default(List<ProjectPublicationRequestDto>)) + public ProjectAdminDto(Guid id = default(Guid), string pid = default(string), string name = default(string), string description = default(string), DateTime startDate = default(DateTime), DateTime endDate = default(DateTime), List<string> keywords = default(List<string>), string displayName = default(string), string principleInvestigators = default(string), string grantId = default(string), VisibilityDto visibility = default(VisibilityDto), List<DisciplineDto> disciplines = default(List<DisciplineDto>), List<ProjectOrganizationDto> organizations = default(List<ProjectOrganizationDto>), string slug = default(string), UserMinimalDto creator = default(UserMinimalDto), DateTime? creationDate = default(DateTime?), List<ProjectDto> subProjects = default(List<ProjectDto>), ProjectMinimalDto parent = default(ProjectMinimalDto), bool deleted = default(bool), List<ProjectResourceMinimalDto> projectResources = default(List<ProjectResourceMinimalDto>), List<ProjectRoleMinimalDto> projectRoles = default(List<ProjectRoleMinimalDto>), List<ProjectQuotaDto> projectQuota = default(List<ProjectQuotaDto>), List<ProjectPublicationRequestDto> publicationRequests = default(List<ProjectPublicationRequestDto>)) { this.Id = id; + // to ensure "pid" is required (not null) + if (pid == null) + { + throw new ArgumentNullException("pid is a required property for ProjectAdminDto and cannot be null"); + } this.Pid = pid; + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for ProjectAdminDto and cannot be null"); + } this.Name = name; + // to ensure "description" is required (not null) + if (description == null) + { + throw new ArgumentNullException("description is a required property for ProjectAdminDto and cannot be null"); + } this.Description = description; this.StartDate = startDate; this.EndDate = endDate; - this.Keywords = keywords; - this.DisplayName = displayName; - this.PrincipleInvestigators = principleInvestigators; - this.GrantId = grantId; + // to ensure "visibility" is required (not null) + if (visibility == null) + { + throw new ArgumentNullException("visibility is a required property for ProjectAdminDto and cannot be null"); + } this.Visibility = visibility; + // to ensure "disciplines" is required (not null) + if (disciplines == null) + { + throw new ArgumentNullException("disciplines is a required property for ProjectAdminDto and cannot be null"); + } this.Disciplines = disciplines; + // to ensure "organizations" is required (not null) + if (organizations == null) + { + throw new ArgumentNullException("organizations is a required property for ProjectAdminDto and cannot be null"); + } this.Organizations = organizations; + // to ensure "slug" is required (not null) + if (slug == null) + { + throw new ArgumentNullException("slug is a required property for ProjectAdminDto and cannot be null"); + } this.Slug = slug; + this.Keywords = keywords; + this.DisplayName = displayName; + this.PrincipleInvestigators = principleInvestigators; + this.GrantId = grantId; this.Creator = creator; this.CreationDate = creationDate; this.SubProjects = subProjects; @@ -89,42 +129,42 @@ namespace Coscine.ApiClient.Core.Model /// Unique identifier for the project. /// </summary> /// <value>Unique identifier for the project.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> /// Persistent identifier for the project. /// </summary> /// <value>Persistent identifier for the project.</value> - [DataMember(Name = "pid", EmitDefaultValue = false)] + [DataMember(Name = "pid", IsRequired = true, EmitDefaultValue = true)] public string Pid { get; set; } /// <summary> /// Name of the project. /// </summary> /// <value>Name of the project.</value> - [DataMember(Name = "name", EmitDefaultValue = false)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> /// Description of the project. /// </summary> /// <value>Description of the project.</value> - [DataMember(Name = "description", EmitDefaultValue = false)] + [DataMember(Name = "description", IsRequired = true, EmitDefaultValue = true)] public string Description { get; set; } /// <summary> /// Start date of the project. /// </summary> /// <value>Start date of the project.</value> - [DataMember(Name = "startDate", EmitDefaultValue = false)] + [DataMember(Name = "startDate", IsRequired = true, EmitDefaultValue = true)] public DateTime StartDate { get; set; } /// <summary> /// End date of the project. /// </summary> /// <value>End date of the project.</value> - [DataMember(Name = "endDate", EmitDefaultValue = false)] + [DataMember(Name = "endDate", IsRequired = true, EmitDefaultValue = true)] public DateTime EndDate { get; set; } /// <summary> @@ -158,28 +198,28 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Gets or Sets Visibility /// </summary> - [DataMember(Name = "visibility", EmitDefaultValue = false)] + [DataMember(Name = "visibility", IsRequired = true, EmitDefaultValue = true)] public VisibilityDto Visibility { get; set; } /// <summary> /// Disciplines related to the project. /// </summary> /// <value>Disciplines related to the project.</value> - [DataMember(Name = "disciplines", EmitDefaultValue = false)] + [DataMember(Name = "disciplines", IsRequired = true, EmitDefaultValue = true)] public List<DisciplineDto> Disciplines { get; set; } /// <summary> /// Organizations associated with the project. /// </summary> /// <value>Organizations associated with the project.</value> - [DataMember(Name = "organizations", EmitDefaultValue = false)] - public List<OrganizationDto> Organizations { get; set; } + [DataMember(Name = "organizations", IsRequired = true, EmitDefaultValue = true)] + public List<ProjectOrganizationDto> Organizations { get; set; } /// <summary> /// Slug for the project. /// </summary> /// <value>Slug for the project.</value> - [DataMember(Name = "slug", EmitDefaultValue = false)] + [DataMember(Name = "slug", IsRequired = true, EmitDefaultValue = true)] public string Slug { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/ProjectDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectDto.cs index 1a5dd014b632ae5ace264235043beb99fdb509d7..3ce4474121339536df48ee0063c3dd83288e0144 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectDto.cs @@ -35,40 +35,80 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectDto" /> class. /// </summary> - /// <param name="id">Unique identifier for the project..</param> - /// <param name="pid">Persistent identifier for the project..</param> - /// <param name="name">Name of the project..</param> - /// <param name="description">Description of the project..</param> - /// <param name="startDate">Start date of the project..</param> - /// <param name="endDate">End date of the project..</param> + [JsonConstructorAttribute] + protected ProjectDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="ProjectDto" /> class. + /// </summary> + /// <param name="id">Unique identifier for the project. (required).</param> + /// <param name="pid">Persistent identifier for the project. (required).</param> + /// <param name="name">Name of the project. (required).</param> + /// <param name="description">Description of the project. (required).</param> + /// <param name="startDate">Start date of the project. (required).</param> + /// <param name="endDate">End date of the project. (required).</param> /// <param name="keywords">Collection of keywords associated with the project..</param> /// <param name="displayName">Display name of the project..</param> /// <param name="principleInvestigators">Principal investigators involved in the project..</param> /// <param name="grantId">Grant ID associated with the project..</param> - /// <param name="visibility">visibility.</param> - /// <param name="disciplines">Disciplines related to the project..</param> - /// <param name="organizations">Organizations associated with the project..</param> - /// <param name="slug">Slug for the project..</param> + /// <param name="visibility">visibility (required).</param> + /// <param name="disciplines">Disciplines related to the project. (required).</param> + /// <param name="organizations">Organizations associated with the project. (required).</param> + /// <param name="slug">Slug for the project. (required).</param> /// <param name="creator">creator.</param> /// <param name="creationDate">Date of creation of the project..</param> /// <param name="subProjects">Collection of sub-projects associated with this project..</param> /// <param name="parent">parent.</param> - public ProjectDto(Guid id = default(Guid), string pid = default(string), string name = default(string), string description = default(string), DateTime startDate = default(DateTime), DateTime endDate = default(DateTime), List<string> keywords = default(List<string>), string displayName = default(string), string principleInvestigators = default(string), string grantId = default(string), VisibilityDto visibility = default(VisibilityDto), List<DisciplineDto> disciplines = default(List<DisciplineDto>), List<OrganizationDto> organizations = default(List<OrganizationDto>), string slug = default(string), UserMinimalDto creator = default(UserMinimalDto), DateTime? creationDate = default(DateTime?), List<ProjectDto> subProjects = default(List<ProjectDto>), ProjectMinimalDto parent = default(ProjectMinimalDto)) + public ProjectDto(Guid id = default(Guid), string pid = default(string), string name = default(string), string description = default(string), DateTime startDate = default(DateTime), DateTime endDate = default(DateTime), List<string> keywords = default(List<string>), string displayName = default(string), string principleInvestigators = default(string), string grantId = default(string), VisibilityDto visibility = default(VisibilityDto), List<DisciplineDto> disciplines = default(List<DisciplineDto>), List<ProjectOrganizationDto> organizations = default(List<ProjectOrganizationDto>), string slug = default(string), UserMinimalDto creator = default(UserMinimalDto), DateTime? creationDate = default(DateTime?), List<ProjectDto> subProjects = default(List<ProjectDto>), ProjectMinimalDto parent = default(ProjectMinimalDto)) { this.Id = id; + // to ensure "pid" is required (not null) + if (pid == null) + { + throw new ArgumentNullException("pid is a required property for ProjectDto and cannot be null"); + } this.Pid = pid; + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for ProjectDto and cannot be null"); + } this.Name = name; + // to ensure "description" is required (not null) + if (description == null) + { + throw new ArgumentNullException("description is a required property for ProjectDto and cannot be null"); + } this.Description = description; this.StartDate = startDate; this.EndDate = endDate; - this.Keywords = keywords; - this.DisplayName = displayName; - this.PrincipleInvestigators = principleInvestigators; - this.GrantId = grantId; + // to ensure "visibility" is required (not null) + if (visibility == null) + { + throw new ArgumentNullException("visibility is a required property for ProjectDto and cannot be null"); + } this.Visibility = visibility; + // to ensure "disciplines" is required (not null) + if (disciplines == null) + { + throw new ArgumentNullException("disciplines is a required property for ProjectDto and cannot be null"); + } this.Disciplines = disciplines; + // to ensure "organizations" is required (not null) + if (organizations == null) + { + throw new ArgumentNullException("organizations is a required property for ProjectDto and cannot be null"); + } this.Organizations = organizations; + // to ensure "slug" is required (not null) + if (slug == null) + { + throw new ArgumentNullException("slug is a required property for ProjectDto and cannot be null"); + } this.Slug = slug; + this.Keywords = keywords; + this.DisplayName = displayName; + this.PrincipleInvestigators = principleInvestigators; + this.GrantId = grantId; this.Creator = creator; this.CreationDate = creationDate; this.SubProjects = subProjects; @@ -79,42 +119,42 @@ namespace Coscine.ApiClient.Core.Model /// Unique identifier for the project. /// </summary> /// <value>Unique identifier for the project.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> /// Persistent identifier for the project. /// </summary> /// <value>Persistent identifier for the project.</value> - [DataMember(Name = "pid", EmitDefaultValue = false)] + [DataMember(Name = "pid", IsRequired = true, EmitDefaultValue = true)] public string Pid { get; set; } /// <summary> /// Name of the project. /// </summary> /// <value>Name of the project.</value> - [DataMember(Name = "name", EmitDefaultValue = false)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> /// Description of the project. /// </summary> /// <value>Description of the project.</value> - [DataMember(Name = "description", EmitDefaultValue = false)] + [DataMember(Name = "description", IsRequired = true, EmitDefaultValue = true)] public string Description { get; set; } /// <summary> /// Start date of the project. /// </summary> /// <value>Start date of the project.</value> - [DataMember(Name = "startDate", EmitDefaultValue = false)] + [DataMember(Name = "startDate", IsRequired = true, EmitDefaultValue = true)] public DateTime StartDate { get; set; } /// <summary> /// End date of the project. /// </summary> /// <value>End date of the project.</value> - [DataMember(Name = "endDate", EmitDefaultValue = false)] + [DataMember(Name = "endDate", IsRequired = true, EmitDefaultValue = true)] public DateTime EndDate { get; set; } /// <summary> @@ -148,28 +188,28 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Gets or Sets Visibility /// </summary> - [DataMember(Name = "visibility", EmitDefaultValue = false)] + [DataMember(Name = "visibility", IsRequired = true, EmitDefaultValue = true)] public VisibilityDto Visibility { get; set; } /// <summary> /// Disciplines related to the project. /// </summary> /// <value>Disciplines related to the project.</value> - [DataMember(Name = "disciplines", EmitDefaultValue = false)] + [DataMember(Name = "disciplines", IsRequired = true, EmitDefaultValue = true)] public List<DisciplineDto> Disciplines { get; set; } /// <summary> /// Organizations associated with the project. /// </summary> /// <value>Organizations associated with the project.</value> - [DataMember(Name = "organizations", EmitDefaultValue = false)] - public List<OrganizationDto> Organizations { get; set; } + [DataMember(Name = "organizations", IsRequired = true, EmitDefaultValue = true)] + public List<ProjectOrganizationDto> Organizations { get; set; } /// <summary> /// Slug for the project. /// </summary> /// <value>Slug for the project.</value> - [DataMember(Name = "slug", EmitDefaultValue = false)] + [DataMember(Name = "slug", IsRequired = true, EmitDefaultValue = true)] public string Slug { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/ProjectMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectMinimalDto.cs index a4be4a7f95297b6d84422bc9f06693fe709dc2e2..63e96e7d654bd8aa5ed286fbe61e6dd25aca9391 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectMinimalDto.cs @@ -35,7 +35,12 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectMinimalDto" /> class. /// </summary> - /// <param name="id">Unique identifier for the project..</param> + [JsonConstructorAttribute] + protected ProjectMinimalDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="ProjectMinimalDto" /> class. + /// </summary> + /// <param name="id">Unique identifier for the project. (required).</param> public ProjectMinimalDto(Guid id = default(Guid)) { this.Id = id; @@ -45,7 +50,7 @@ namespace Coscine.ApiClient.Core.Model /// Unique identifier for the project. /// </summary> /// <value>Unique identifier for the project.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/UserInstituteDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectOrganizationDto.cs similarity index 64% rename from src/Coscine.ApiClient.Core/Model/UserInstituteDto.cs rename to src/Coscine.ApiClient.Core/Model/ProjectOrganizationDto.cs index 081c82b40d99a3d9199fdb2e9a0a40a80217bab9..f7bdab5408ae14352f6b1915ad6a59aba95c14e4 100644 --- a/src/Coscine.ApiClient.Core/Model/UserInstituteDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectOrganizationDto.cs @@ -27,40 +27,55 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// Represents a Data Transfer Object (DTO) for user institute information, extending the OrganizationDto. + /// Represents a data transfer object (DTO) for an organization in the context of a project. /// </summary> - [DataContract(Name = "UserInstituteDto")] - public partial class UserInstituteDto : IValidatableObject + [DataContract(Name = "ProjectOrganizationDto")] + public partial class ProjectOrganizationDto : IValidatableObject { /// <summary> - /// Initializes a new instance of the <see cref="UserInstituteDto" /> class. + /// Initializes a new instance of the <see cref="ProjectOrganizationDto" /> class. /// </summary> - /// <param name="uri">The ROR (Research Organization Registry) ID of the organization..</param> - /// <param name="displayName">The display name of the organization..</param> + [JsonConstructorAttribute] + protected ProjectOrganizationDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="ProjectOrganizationDto" /> class. + /// </summary> + /// <param name="uri">The ROR (Research Organization Registry) ID of the organization. (required).</param> + /// <param name="displayName">The display name of the organization. (required).</param> /// <param name="email">The email address of the organization..</param> /// <param name="publicationAdvisoryService">publicationAdvisoryService.</param> - /// <param name="readOnly">Determines if the organization's details can be modified. Defaults to `true`; manually set to `false`..</param> - public UserInstituteDto(string uri = default(string), string displayName = default(string), string email = default(string), PublicationAdvisoryServiceDto publicationAdvisoryService = default(PublicationAdvisoryServiceDto), bool readOnly = default(bool)) + /// <param name="responsible">Determines if the organization is Responsible for a given project. (required).</param> + public ProjectOrganizationDto(string uri = default(string), string displayName = default(string), string email = default(string), PublicationAdvisoryServiceDto publicationAdvisoryService = default(PublicationAdvisoryServiceDto), bool responsible = default(bool)) { + // to ensure "uri" is required (not null) + if (uri == null) + { + throw new ArgumentNullException("uri is a required property for ProjectOrganizationDto and cannot be null"); + } this.Uri = uri; + // to ensure "displayName" is required (not null) + if (displayName == null) + { + throw new ArgumentNullException("displayName is a required property for ProjectOrganizationDto and cannot be null"); + } this.DisplayName = displayName; + this.Responsible = responsible; this.Email = email; this.PublicationAdvisoryService = publicationAdvisoryService; - this.ReadOnly = readOnly; } /// <summary> /// The ROR (Research Organization Registry) ID of the organization. /// </summary> /// <value>The ROR (Research Organization Registry) ID of the organization.</value> - [DataMember(Name = "uri", EmitDefaultValue = false)] + [DataMember(Name = "uri", IsRequired = true, EmitDefaultValue = true)] public string Uri { get; set; } /// <summary> /// The display name of the organization. /// </summary> /// <value>The display name of the organization.</value> - [DataMember(Name = "displayName", EmitDefaultValue = false)] + [DataMember(Name = "displayName", IsRequired = true, EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> @@ -77,11 +92,11 @@ namespace Coscine.ApiClient.Core.Model public PublicationAdvisoryServiceDto PublicationAdvisoryService { get; set; } /// <summary> - /// Determines if the organization's details can be modified. Defaults to `true`; manually set to `false`. + /// Determines if the organization is Responsible for a given project. /// </summary> - /// <value>Determines if the organization's details can be modified. Defaults to `true`; manually set to `false`.</value> - [DataMember(Name = "readOnly", EmitDefaultValue = true)] - public bool ReadOnly { get; set; } + /// <value>Determines if the organization is Responsible for a given project.</value> + [DataMember(Name = "responsible", IsRequired = true, EmitDefaultValue = true)] + public bool Responsible { get; set; } /// <summary> /// Returns the string presentation of the object @@ -90,12 +105,12 @@ namespace Coscine.ApiClient.Core.Model public override string ToString() { StringBuilder sb = new StringBuilder(); - sb.Append("class UserInstituteDto {\n"); + sb.Append("class ProjectOrganizationDto {\n"); sb.Append(" Uri: ").Append(Uri).Append("\n"); sb.Append(" DisplayName: ").Append(DisplayName).Append("\n"); sb.Append(" Email: ").Append(Email).Append("\n"); sb.Append(" PublicationAdvisoryService: ").Append(PublicationAdvisoryService).Append("\n"); - sb.Append(" ReadOnly: ").Append(ReadOnly).Append("\n"); + sb.Append(" Responsible: ").Append(Responsible).Append("\n"); sb.Append("}\n"); return sb.ToString(); } diff --git a/src/Coscine.ApiClient.Core/Model/ProvenanceDto.cs b/src/Coscine.ApiClient.Core/Model/ProvenanceDto.cs index a4a144fe237dfa47f8ee09bea7fba004879a0d5c..766d31603cd1950e4a3513af26d9d71e89d1b2c3 100644 --- a/src/Coscine.ApiClient.Core/Model/ProvenanceDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProvenanceDto.cs @@ -35,19 +35,39 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProvenanceDto" /> class. /// </summary> - /// <param name="id">Gets or sets the id of the current metadata graph..</param> + [JsonConstructorAttribute] + protected ProvenanceDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="ProvenanceDto" /> class. + /// </summary> + /// <param name="id">Gets or sets the id of the current metadata graph. (required).</param> /// <param name="generatedAt">Gets or sets the date and time when the metadata was generated..</param> - /// <param name="wasRevisionOf">Gets or sets the adapted versions from the specific metadata tree..</param> - /// <param name="variants">Gets or sets the variants of the specific metadata tree..</param> + /// <param name="wasRevisionOf">Gets or sets the adapted versions from the specific metadata tree. (required).</param> + /// <param name="variants">Gets or sets the variants of the specific metadata tree. (required).</param> /// <param name="similarityToLastVersion">The similarity to the last version..</param> /// <param name="wasInvalidatedBy">Information if the specific metadata tree was invalidated by something..</param> /// <param name="hashParameters">hashParameters.</param> public ProvenanceDto(string id = default(string), DateTime? generatedAt = default(DateTime?), List<string> wasRevisionOf = default(List<string>), List<VariantDto> variants = default(List<VariantDto>), double? similarityToLastVersion = default(double?), string wasInvalidatedBy = default(string), HashParametersDto hashParameters = default(HashParametersDto)) { + // to ensure "id" is required (not null) + if (id == null) + { + throw new ArgumentNullException("id is a required property for ProvenanceDto and cannot be null"); + } this.Id = id; - this.GeneratedAt = generatedAt; + // to ensure "wasRevisionOf" is required (not null) + if (wasRevisionOf == null) + { + throw new ArgumentNullException("wasRevisionOf is a required property for ProvenanceDto and cannot be null"); + } this.WasRevisionOf = wasRevisionOf; + // to ensure "variants" is required (not null) + if (variants == null) + { + throw new ArgumentNullException("variants is a required property for ProvenanceDto and cannot be null"); + } this.Variants = variants; + this.GeneratedAt = generatedAt; this.SimilarityToLastVersion = similarityToLastVersion; this.WasInvalidatedBy = wasInvalidatedBy; this.HashParameters = hashParameters; @@ -57,7 +77,7 @@ namespace Coscine.ApiClient.Core.Model /// Gets or sets the id of the current metadata graph. /// </summary> /// <value>Gets or sets the id of the current metadata graph.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public string Id { get; set; } /// <summary> @@ -71,14 +91,14 @@ namespace Coscine.ApiClient.Core.Model /// Gets or sets the adapted versions from the specific metadata tree. /// </summary> /// <value>Gets or sets the adapted versions from the specific metadata tree.</value> - [DataMember(Name = "wasRevisionOf", EmitDefaultValue = false)] + [DataMember(Name = "wasRevisionOf", IsRequired = true, EmitDefaultValue = true)] public List<string> WasRevisionOf { get; set; } /// <summary> /// Gets or sets the variants of the specific metadata tree. /// </summary> /// <value>Gets or sets the variants of the specific metadata tree.</value> - [DataMember(Name = "variants", EmitDefaultValue = false)] + [DataMember(Name = "variants", IsRequired = true, EmitDefaultValue = true)] public List<VariantDto> Variants { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/ProvenanceForUpdateDto.cs b/src/Coscine.ApiClient.Core/Model/ProvenanceForUpdateDto.cs index c339a22e2a6b6db15349408e71ad98452d7182f1..99e983af64e89b5c625c1f7e83e67cbc00f9cd76 100644 --- a/src/Coscine.ApiClient.Core/Model/ProvenanceForUpdateDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProvenanceForUpdateDto.cs @@ -32,6 +32,11 @@ namespace Coscine.ApiClient.Core.Model [DataContract(Name = "ProvenanceForUpdateDto")] public partial class ProvenanceForUpdateDto : IValidatableObject { + /// <summary> + /// Initializes a new instance of the <see cref="ProvenanceForUpdateDto" /> class. + /// </summary> + [JsonConstructorAttribute] + protected ProvenanceForUpdateDto() { } /// <summary> /// Initializes a new instance of the <see cref="ProvenanceForUpdateDto" /> class. /// </summary> @@ -41,16 +46,21 @@ namespace Coscine.ApiClient.Core.Model /// <param name="similarityToLastVersion">The similarity to the last version..</param> /// <param name="metadataExtractorVersion">Gets or initializes the version of the metadata extractor..</param> /// <param name="hashParameters">hashParameters.</param> - /// <param name="id">Gets or sets the id of the specific metadata tree..</param> + /// <param name="id">Gets or sets the id of the specific metadata tree. (required).</param> public ProvenanceForUpdateDto(List<string> wasRevisionOf = default(List<string>), List<VariantDto> variants = default(List<VariantDto>), string wasInvalidatedBy = default(string), double? similarityToLastVersion = default(double?), string metadataExtractorVersion = default(string), HashParametersDto hashParameters = default(HashParametersDto), string id = default(string)) { + // to ensure "id" is required (not null) + if (id == null) + { + throw new ArgumentNullException("id is a required property for ProvenanceForUpdateDto and cannot be null"); + } + this.Id = id; this.WasRevisionOf = wasRevisionOf; this.Variants = variants; this.WasInvalidatedBy = wasInvalidatedBy; this.SimilarityToLastVersion = similarityToLastVersion; this.MetadataExtractorVersion = metadataExtractorVersion; this.HashParameters = hashParameters; - this.Id = id; } /// <summary> @@ -98,7 +108,7 @@ namespace Coscine.ApiClient.Core.Model /// Gets or sets the id of the specific metadata tree. /// </summary> /// <value>Gets or sets the id of the specific metadata tree.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public string Id { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/PublicUserDto.cs b/src/Coscine.ApiClient.Core/Model/PublicUserDto.cs index d6dd5cb64f72d7681e88433e9fd98949a27d7086..47ab39ee312342e79dcda27943da76c0204d9b14 100644 --- a/src/Coscine.ApiClient.Core/Model/PublicUserDto.cs +++ b/src/Coscine.ApiClient.Core/Model/PublicUserDto.cs @@ -35,18 +35,43 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="PublicUserDto" /> class. /// </summary> - /// <param name="id">Unique identifier of the user..</param> - /// <param name="displayName">Display name of the user..</param> - /// <param name="givenName">Given name of the user..</param> - /// <param name="familyName">Family name of the user..</param> - /// <param name="email">Email address of the user..</param> + [JsonConstructorAttribute] + protected PublicUserDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="PublicUserDto" /> class. + /// </summary> + /// <param name="id">Unique identifier of the user. (required).</param> + /// <param name="displayName">Display name of the user. (required).</param> + /// <param name="givenName">Given name of the user. (required).</param> + /// <param name="familyName">Family name of the user. (required).</param> + /// <param name="email">Email address of the user. (required).</param> /// <param name="title">title.</param> public PublicUserDto(Guid id = default(Guid), string displayName = default(string), string givenName = default(string), string familyName = default(string), string email = default(string), TitleDto title = default(TitleDto)) { this.Id = id; + // to ensure "displayName" is required (not null) + if (displayName == null) + { + throw new ArgumentNullException("displayName is a required property for PublicUserDto and cannot be null"); + } this.DisplayName = displayName; + // to ensure "givenName" is required (not null) + if (givenName == null) + { + throw new ArgumentNullException("givenName is a required property for PublicUserDto and cannot be null"); + } this.GivenName = givenName; + // to ensure "familyName" is required (not null) + if (familyName == null) + { + throw new ArgumentNullException("familyName is a required property for PublicUserDto and cannot be null"); + } this.FamilyName = familyName; + // to ensure "email" is required (not null) + if (email == null) + { + throw new ArgumentNullException("email is a required property for PublicUserDto and cannot be null"); + } this.Email = email; this.Title = title; } @@ -55,35 +80,35 @@ namespace Coscine.ApiClient.Core.Model /// Unique identifier of the user. /// </summary> /// <value>Unique identifier of the user.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> /// Display name of the user. /// </summary> /// <value>Display name of the user.</value> - [DataMember(Name = "displayName", EmitDefaultValue = false)] + [DataMember(Name = "displayName", IsRequired = true, EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> /// Given name of the user. /// </summary> /// <value>Given name of the user.</value> - [DataMember(Name = "givenName", EmitDefaultValue = false)] + [DataMember(Name = "givenName", IsRequired = true, EmitDefaultValue = true)] public string GivenName { get; set; } /// <summary> /// Family name of the user. /// </summary> /// <value>Family name of the user.</value> - [DataMember(Name = "familyName", EmitDefaultValue = false)] + [DataMember(Name = "familyName", IsRequired = true, EmitDefaultValue = true)] public string FamilyName { get; set; } /// <summary> /// Email address of the user. /// </summary> /// <value>Email address of the user.</value> - [DataMember(Name = "email", EmitDefaultValue = false)] + [DataMember(Name = "email", IsRequired = true, EmitDefaultValue = true)] public string Email { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/PublicationRequestForCreationDtoResponse.cs b/src/Coscine.ApiClient.Core/Model/PublicationRequestForCreationDtoResponse.cs deleted file mode 100644 index 32b40512bb2eaa0c4e5fc7697bf39543d6ed9261..0000000000000000000000000000000000000000 --- a/src/Coscine.ApiClient.Core/Model/PublicationRequestForCreationDtoResponse.cs +++ /dev/null @@ -1,116 +0,0 @@ -/* - * Coscine Web API - * - * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project. - * - * The version of the OpenAPI document: 2.0 - * Contact: servicedesk@itc.rwth-aachen.de - * Generated by: https://github.com/openapitools/openapi-generator.git - */ - - -using System; -using System.Collections; -using System.Collections.Generic; -using System.Collections.ObjectModel; -using System.Linq; -using System.IO; -using System.Runtime.Serialization; -using System.Text; -using System.Text.RegularExpressions; -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; -using Newtonsoft.Json.Linq; -using System.ComponentModel.DataAnnotations; -using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; - -namespace Coscine.ApiClient.Core.Model -{ - /// <summary> - /// PublicationRequestForCreationDtoResponse - /// </summary> - [DataContract(Name = "PublicationRequestForCreationDtoResponse")] - public partial class PublicationRequestForCreationDtoResponse : IValidatableObject - { - /// <summary> - /// Initializes a new instance of the <see cref="PublicationRequestForCreationDtoResponse" /> class. - /// </summary> - /// <param name="data">data.</param> - /// <param name="statusCode">statusCode.</param> - /// <param name="traceId">traceId.</param> - public PublicationRequestForCreationDtoResponse(PublicationRequestForCreationDto data = default(PublicationRequestForCreationDto), int? statusCode = default(int?), string traceId = default(string)) - { - this.Data = data; - this.StatusCode = statusCode; - this.TraceId = traceId; - } - - /// <summary> - /// Gets or Sets Data - /// </summary> - [DataMember(Name = "data", EmitDefaultValue = false)] - public PublicationRequestForCreationDto Data { get; set; } - - /// <summary> - /// Gets or Sets IsSuccess - /// </summary> - [DataMember(Name = "isSuccess", EmitDefaultValue = true)] - public bool IsSuccess { get; private set; } - - /// <summary> - /// Returns false as IsSuccess should not be serialized given that it's read-only. - /// </summary> - /// <returns>false (boolean)</returns> - public bool ShouldSerializeIsSuccess() - { - return false; - } - /// <summary> - /// Gets or Sets StatusCode - /// </summary> - [DataMember(Name = "statusCode", EmitDefaultValue = true)] - public int? StatusCode { get; set; } - - /// <summary> - /// Gets or Sets TraceId - /// </summary> - [DataMember(Name = "traceId", EmitDefaultValue = true)] - public string TraceId { get; set; } - - /// <summary> - /// Returns the string presentation of the object - /// </summary> - /// <returns>String presentation of the object</returns> - public override string ToString() - { - StringBuilder sb = new StringBuilder(); - sb.Append("class PublicationRequestForCreationDtoResponse {\n"); - sb.Append(" Data: ").Append(Data).Append("\n"); - sb.Append(" IsSuccess: ").Append(IsSuccess).Append("\n"); - sb.Append(" StatusCode: ").Append(StatusCode).Append("\n"); - sb.Append(" TraceId: ").Append(TraceId).Append("\n"); - sb.Append("}\n"); - return sb.ToString(); - } - - /// <summary> - /// Returns the JSON string presentation of the object - /// </summary> - /// <returns>JSON string presentation of the object</returns> - public virtual string ToJson() - { - return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); - } - - /// <summary> - /// To validate all properties of the instance - /// </summary> - /// <param name="validationContext">Validation context</param> - /// <returns>Validation Result</returns> - IEnumerable<ValidationResult> IValidatableObject.Validate(ValidationContext validationContext) - { - yield break; - } - } - -} diff --git a/src/Coscine.ApiClient.Core/Model/RdsOptionsDto.cs b/src/Coscine.ApiClient.Core/Model/RdsOptionsDto.cs index 4b55115c82c30cfac7eacc67c9bd477da548d7b7..b8a9f95be8555ede3e4e4f6c95a313500416713c 100644 --- a/src/Coscine.ApiClient.Core/Model/RdsOptionsDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdsOptionsDto.cs @@ -35,10 +35,20 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RdsOptionsDto" /> class. /// </summary> - /// <param name="bucketName">The name of the bucket associated with RDS..</param> + [JsonConstructorAttribute] + protected RdsOptionsDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="RdsOptionsDto" /> class. + /// </summary> + /// <param name="bucketName">The name of the bucket associated with RDS. (required).</param> /// <param name="size">size.</param> public RdsOptionsDto(string bucketName = default(string), QuotaDto size = default(QuotaDto)) { + // to ensure "bucketName" is required (not null) + if (bucketName == null) + { + throw new ArgumentNullException("bucketName is a required property for RdsOptionsDto and cannot be null"); + } this.BucketName = bucketName; this.Size = size; } @@ -47,7 +57,7 @@ namespace Coscine.ApiClient.Core.Model /// The name of the bucket associated with RDS. /// </summary> /// <value>The name of the bucket associated with RDS.</value> - [DataMember(Name = "bucketName", EmitDefaultValue = false)] + [DataMember(Name = "bucketName", IsRequired = true, EmitDefaultValue = true)] public string BucketName { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/RdsResourceTypeOptionsForManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/RdsResourceTypeOptionsForManipulationDto.cs index e136c5e629a20a1e24f20d0417cdaf7bf9cb6ff9..974e0ea6fad4caf605a6193479016e9b846d44ed 100644 --- a/src/Coscine.ApiClient.Core/Model/RdsResourceTypeOptionsForManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdsResourceTypeOptionsForManipulationDto.cs @@ -35,16 +35,26 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RdsResourceTypeOptionsForManipulationDto" /> class. /// </summary> - /// <param name="quota">quota.</param> + [JsonConstructorAttribute] + protected RdsResourceTypeOptionsForManipulationDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="RdsResourceTypeOptionsForManipulationDto" /> class. + /// </summary> + /// <param name="quota">quota (required).</param> public RdsResourceTypeOptionsForManipulationDto(QuotaForManipulationDto quota = default(QuotaForManipulationDto)) { + // to ensure "quota" is required (not null) + if (quota == null) + { + throw new ArgumentNullException("quota is a required property for RdsResourceTypeOptionsForManipulationDto and cannot be null"); + } this.Quota = quota; } /// <summary> /// Gets or Sets Quota /// </summary> - [DataMember(Name = "quota", EmitDefaultValue = false)] + [DataMember(Name = "quota", IsRequired = true, EmitDefaultValue = true)] public QuotaForManipulationDto Quota { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/RdsS3OptionsDto.cs b/src/Coscine.ApiClient.Core/Model/RdsS3OptionsDto.cs index 14270e1fb21c323bb7b540e9220c8ab8e9ee3e60..292b43d6d6086359c579314b1ffa7eb0b150cde2 100644 --- a/src/Coscine.ApiClient.Core/Model/RdsS3OptionsDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdsS3OptionsDto.cs @@ -35,20 +35,55 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RdsS3OptionsDto" /> class. /// </summary> - /// <param name="bucketName">The name of the bucket associated with RDS S3..</param> - /// <param name="accessKeyRead">The access key for reading from the RDS S3 bucket..</param> - /// <param name="secretKeyRead">The secret key for reading from the RDS S3 bucket..</param> - /// <param name="accessKeyWrite">The access key for writing to the RDS S3 bucket..</param> - /// <param name="secretKeyWrite">The secret key for writing to the RDS S3 bucket..</param> - /// <param name="endpoint">The endpoint for the RDS S3 bucket..</param> + [JsonConstructorAttribute] + protected RdsS3OptionsDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="RdsS3OptionsDto" /> class. + /// </summary> + /// <param name="bucketName">The name of the bucket associated with RDS S3. (required).</param> + /// <param name="accessKeyRead">The access key for reading from the RDS S3 bucket. (required).</param> + /// <param name="secretKeyRead">The secret key for reading from the RDS S3 bucket. (required).</param> + /// <param name="accessKeyWrite">The access key for writing to the RDS S3 bucket. (required).</param> + /// <param name="secretKeyWrite">The secret key for writing to the RDS S3 bucket. (required).</param> + /// <param name="endpoint">The endpoint for the RDS S3 bucket. (required).</param> /// <param name="size">size.</param> public RdsS3OptionsDto(string bucketName = default(string), string accessKeyRead = default(string), string secretKeyRead = default(string), string accessKeyWrite = default(string), string secretKeyWrite = default(string), string endpoint = default(string), QuotaDto size = default(QuotaDto)) { + // to ensure "bucketName" is required (not null) + if (bucketName == null) + { + throw new ArgumentNullException("bucketName is a required property for RdsS3OptionsDto and cannot be null"); + } this.BucketName = bucketName; + // to ensure "accessKeyRead" is required (not null) + if (accessKeyRead == null) + { + throw new ArgumentNullException("accessKeyRead is a required property for RdsS3OptionsDto and cannot be null"); + } this.AccessKeyRead = accessKeyRead; + // to ensure "secretKeyRead" is required (not null) + if (secretKeyRead == null) + { + throw new ArgumentNullException("secretKeyRead is a required property for RdsS3OptionsDto and cannot be null"); + } this.SecretKeyRead = secretKeyRead; + // to ensure "accessKeyWrite" is required (not null) + if (accessKeyWrite == null) + { + throw new ArgumentNullException("accessKeyWrite is a required property for RdsS3OptionsDto and cannot be null"); + } this.AccessKeyWrite = accessKeyWrite; + // to ensure "secretKeyWrite" is required (not null) + if (secretKeyWrite == null) + { + throw new ArgumentNullException("secretKeyWrite is a required property for RdsS3OptionsDto and cannot be null"); + } this.SecretKeyWrite = secretKeyWrite; + // to ensure "endpoint" is required (not null) + if (endpoint == null) + { + throw new ArgumentNullException("endpoint is a required property for RdsS3OptionsDto and cannot be null"); + } this.Endpoint = endpoint; this.Size = size; } @@ -57,42 +92,42 @@ namespace Coscine.ApiClient.Core.Model /// The name of the bucket associated with RDS S3. /// </summary> /// <value>The name of the bucket associated with RDS S3.</value> - [DataMember(Name = "bucketName", EmitDefaultValue = false)] + [DataMember(Name = "bucketName", IsRequired = true, EmitDefaultValue = true)] public string BucketName { get; set; } /// <summary> /// The access key for reading from the RDS S3 bucket. /// </summary> /// <value>The access key for reading from the RDS S3 bucket.</value> - [DataMember(Name = "accessKeyRead", EmitDefaultValue = false)] + [DataMember(Name = "accessKeyRead", IsRequired = true, EmitDefaultValue = true)] public string AccessKeyRead { get; set; } /// <summary> /// The secret key for reading from the RDS S3 bucket. /// </summary> /// <value>The secret key for reading from the RDS S3 bucket.</value> - [DataMember(Name = "secretKeyRead", EmitDefaultValue = false)] + [DataMember(Name = "secretKeyRead", IsRequired = true, EmitDefaultValue = true)] public string SecretKeyRead { get; set; } /// <summary> /// The access key for writing to the RDS S3 bucket. /// </summary> /// <value>The access key for writing to the RDS S3 bucket.</value> - [DataMember(Name = "accessKeyWrite", EmitDefaultValue = false)] + [DataMember(Name = "accessKeyWrite", IsRequired = true, EmitDefaultValue = true)] public string AccessKeyWrite { get; set; } /// <summary> /// The secret key for writing to the RDS S3 bucket. /// </summary> /// <value>The secret key for writing to the RDS S3 bucket.</value> - [DataMember(Name = "secretKeyWrite", EmitDefaultValue = false)] + [DataMember(Name = "secretKeyWrite", IsRequired = true, EmitDefaultValue = true)] public string SecretKeyWrite { get; set; } /// <summary> /// The endpoint for the RDS S3 bucket. /// </summary> /// <value>The endpoint for the RDS S3 bucket.</value> - [DataMember(Name = "endpoint", EmitDefaultValue = false)] + [DataMember(Name = "endpoint", IsRequired = true, EmitDefaultValue = true)] public string Endpoint { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/RdsS3ResourceTypeOptionsForManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/RdsS3ResourceTypeOptionsForManipulationDto.cs index 78f100e1340ba9f1b7855db52b984498e617b845..759eaac842c443559595145209ac44eb83b336a0 100644 --- a/src/Coscine.ApiClient.Core/Model/RdsS3ResourceTypeOptionsForManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdsS3ResourceTypeOptionsForManipulationDto.cs @@ -35,16 +35,26 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RdsS3ResourceTypeOptionsForManipulationDto" /> class. /// </summary> - /// <param name="quota">quota.</param> + [JsonConstructorAttribute] + protected RdsS3ResourceTypeOptionsForManipulationDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="RdsS3ResourceTypeOptionsForManipulationDto" /> class. + /// </summary> + /// <param name="quota">quota (required).</param> public RdsS3ResourceTypeOptionsForManipulationDto(QuotaForManipulationDto quota = default(QuotaForManipulationDto)) { + // to ensure "quota" is required (not null) + if (quota == null) + { + throw new ArgumentNullException("quota is a required property for RdsS3ResourceTypeOptionsForManipulationDto and cannot be null"); + } this.Quota = quota; } /// <summary> /// Gets or Sets Quota /// </summary> - [DataMember(Name = "quota", EmitDefaultValue = false)] + [DataMember(Name = "quota", IsRequired = true, EmitDefaultValue = true)] public QuotaForManipulationDto Quota { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/RdsS3WormOptionsDto.cs b/src/Coscine.ApiClient.Core/Model/RdsS3WormOptionsDto.cs index 4030411a967d64cf7a6a7d3a2d0cecaa89adf391..d044b41d2fc664082649ca50ed110b0da77ccda6 100644 --- a/src/Coscine.ApiClient.Core/Model/RdsS3WormOptionsDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdsS3WormOptionsDto.cs @@ -35,20 +35,55 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RdsS3WormOptionsDto" /> class. /// </summary> - /// <param name="bucketName">The name of the bucket associated with RDS S3 WORM..</param> - /// <param name="accessKeyRead">The access key for reading from the RDS S3 WORM bucket..</param> - /// <param name="secretKeyRead">The secret key for reading from the RDS S3 WORM bucket..</param> - /// <param name="accessKeyWrite">The access key for writing to the RDS S3 WORM bucket..</param> - /// <param name="secretKeyWrite">The secret key for writing to the RDS S3 WORM bucket..</param> - /// <param name="endpoint">The endpoint for the RDS S3 WORM bucket..</param> + [JsonConstructorAttribute] + protected RdsS3WormOptionsDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="RdsS3WormOptionsDto" /> class. + /// </summary> + /// <param name="bucketName">The name of the bucket associated with RDS S3 WORM. (required).</param> + /// <param name="accessKeyRead">The access key for reading from the RDS S3 WORM bucket. (required).</param> + /// <param name="secretKeyRead">The secret key for reading from the RDS S3 WORM bucket. (required).</param> + /// <param name="accessKeyWrite">The access key for writing to the RDS S3 WORM bucket. (required).</param> + /// <param name="secretKeyWrite">The secret key for writing to the RDS S3 WORM bucket. (required).</param> + /// <param name="endpoint">The endpoint for the RDS S3 WORM bucket. (required).</param> /// <param name="size">size.</param> public RdsS3WormOptionsDto(string bucketName = default(string), string accessKeyRead = default(string), string secretKeyRead = default(string), string accessKeyWrite = default(string), string secretKeyWrite = default(string), string endpoint = default(string), QuotaDto size = default(QuotaDto)) { + // to ensure "bucketName" is required (not null) + if (bucketName == null) + { + throw new ArgumentNullException("bucketName is a required property for RdsS3WormOptionsDto and cannot be null"); + } this.BucketName = bucketName; + // to ensure "accessKeyRead" is required (not null) + if (accessKeyRead == null) + { + throw new ArgumentNullException("accessKeyRead is a required property for RdsS3WormOptionsDto and cannot be null"); + } this.AccessKeyRead = accessKeyRead; + // to ensure "secretKeyRead" is required (not null) + if (secretKeyRead == null) + { + throw new ArgumentNullException("secretKeyRead is a required property for RdsS3WormOptionsDto and cannot be null"); + } this.SecretKeyRead = secretKeyRead; + // to ensure "accessKeyWrite" is required (not null) + if (accessKeyWrite == null) + { + throw new ArgumentNullException("accessKeyWrite is a required property for RdsS3WormOptionsDto and cannot be null"); + } this.AccessKeyWrite = accessKeyWrite; + // to ensure "secretKeyWrite" is required (not null) + if (secretKeyWrite == null) + { + throw new ArgumentNullException("secretKeyWrite is a required property for RdsS3WormOptionsDto and cannot be null"); + } this.SecretKeyWrite = secretKeyWrite; + // to ensure "endpoint" is required (not null) + if (endpoint == null) + { + throw new ArgumentNullException("endpoint is a required property for RdsS3WormOptionsDto and cannot be null"); + } this.Endpoint = endpoint; this.Size = size; } @@ -57,42 +92,42 @@ namespace Coscine.ApiClient.Core.Model /// The name of the bucket associated with RDS S3 WORM. /// </summary> /// <value>The name of the bucket associated with RDS S3 WORM.</value> - [DataMember(Name = "bucketName", EmitDefaultValue = false)] + [DataMember(Name = "bucketName", IsRequired = true, EmitDefaultValue = true)] public string BucketName { get; set; } /// <summary> /// The access key for reading from the RDS S3 WORM bucket. /// </summary> /// <value>The access key for reading from the RDS S3 WORM bucket.</value> - [DataMember(Name = "accessKeyRead", EmitDefaultValue = false)] + [DataMember(Name = "accessKeyRead", IsRequired = true, EmitDefaultValue = true)] public string AccessKeyRead { get; set; } /// <summary> /// The secret key for reading from the RDS S3 WORM bucket. /// </summary> /// <value>The secret key for reading from the RDS S3 WORM bucket.</value> - [DataMember(Name = "secretKeyRead", EmitDefaultValue = false)] + [DataMember(Name = "secretKeyRead", IsRequired = true, EmitDefaultValue = true)] public string SecretKeyRead { get; set; } /// <summary> /// The access key for writing to the RDS S3 WORM bucket. /// </summary> /// <value>The access key for writing to the RDS S3 WORM bucket.</value> - [DataMember(Name = "accessKeyWrite", EmitDefaultValue = false)] + [DataMember(Name = "accessKeyWrite", IsRequired = true, EmitDefaultValue = true)] public string AccessKeyWrite { get; set; } /// <summary> /// The secret key for writing to the RDS S3 WORM bucket. /// </summary> /// <value>The secret key for writing to the RDS S3 WORM bucket.</value> - [DataMember(Name = "secretKeyWrite", EmitDefaultValue = false)] + [DataMember(Name = "secretKeyWrite", IsRequired = true, EmitDefaultValue = true)] public string SecretKeyWrite { get; set; } /// <summary> /// The endpoint for the RDS S3 WORM bucket. /// </summary> /// <value>The endpoint for the RDS S3 WORM bucket.</value> - [DataMember(Name = "endpoint", EmitDefaultValue = false)] + [DataMember(Name = "endpoint", IsRequired = true, EmitDefaultValue = true)] public string Endpoint { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/RdsS3WormResourceTypeOptionsForManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/RdsS3WormResourceTypeOptionsForManipulationDto.cs index 4325b41e935ae239d4afeeadd20c29757859789e..39a1266d5bcb1de3e620b26d42433aa717b67bb2 100644 --- a/src/Coscine.ApiClient.Core/Model/RdsS3WormResourceTypeOptionsForManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdsS3WormResourceTypeOptionsForManipulationDto.cs @@ -35,16 +35,26 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RdsS3WormResourceTypeOptionsForManipulationDto" /> class. /// </summary> - /// <param name="quota">quota.</param> + [JsonConstructorAttribute] + protected RdsS3WormResourceTypeOptionsForManipulationDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="RdsS3WormResourceTypeOptionsForManipulationDto" /> class. + /// </summary> + /// <param name="quota">quota (required).</param> public RdsS3WormResourceTypeOptionsForManipulationDto(QuotaForManipulationDto quota = default(QuotaForManipulationDto)) { + // to ensure "quota" is required (not null) + if (quota == null) + { + throw new ArgumentNullException("quota is a required property for RdsS3WormResourceTypeOptionsForManipulationDto and cannot be null"); + } this.Quota = quota; } /// <summary> /// Gets or Sets Quota /// </summary> - [DataMember(Name = "quota", EmitDefaultValue = false)] + [DataMember(Name = "quota", IsRequired = true, EmitDefaultValue = true)] public QuotaForManipulationDto Quota { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/ResourceAdminDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceAdminDto.cs index c0eb36d6e229a8f431600a506fa2058e79813d1c..3cd72799e4a6fd20685692e67ebc6798c7c56a44 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceAdminDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceAdminDto.cs @@ -32,54 +32,109 @@ namespace Coscine.ApiClient.Core.Model [DataContract(Name = "ResourceAdminDto")] public partial class ResourceAdminDto : IValidatableObject { + /// <summary> + /// Initializes a new instance of the <see cref="ResourceAdminDto" /> class. + /// </summary> + [JsonConstructorAttribute] + protected ResourceAdminDto() { } /// <summary> /// Initializes a new instance of the <see cref="ResourceAdminDto" /> class. /// </summary> /// <param name="id">Unique identifier for the resource..</param> - /// <param name="pid">Persistent identifier for the resource..</param> - /// <param name="type">type.</param> - /// <param name="name">Name of the resource..</param> - /// <param name="displayName">Display name of the resource..</param> - /// <param name="description">Description of the resource..</param> + /// <param name="pid">Persistent identifier for the resource. (required).</param> + /// <param name="type">type (required).</param> + /// <param name="name">Name of the resource. (required).</param> + /// <param name="displayName">Display name of the resource. (required).</param> + /// <param name="description">Description of the resource. (required).</param> /// <param name="keywords">Keywords associated with the resource..</param> /// <param name="license">license.</param> /// <param name="usageRights">Usage rights associated with the resource..</param> /// <param name="metadataLocalCopy">Setting for creating a local copy of the metadata..</param> /// <param name="metadataExtraction">Setting for metadata extraction..</param> - /// <param name="applicationProfile">applicationProfile.</param> - /// <param name="fixedValues">Fixed values associated with resource manipulation. This dictionary may contain multiple levels and is structured as follows: Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto..</param> - /// <param name="disciplines">Disciplines associated with the resource..</param> - /// <param name="visibility">visibility.</param> + /// <param name="applicationProfile">applicationProfile (required).</param> + /// <param name="fixedValues">Fixed values associated with resource manipulation. This dictionary may contain multiple levels and is structured as follows: Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto. (required).</param> + /// <param name="disciplines">Disciplines associated with the resource. (required).</param> + /// <param name="visibility">visibility (required).</param> /// <param name="dateCreated">Date when the resource was created..</param> /// <param name="creator">creator.</param> /// <param name="archived">Indicates whether the resource is archived..</param> /// <param name="projects">The projects associated with the resource..</param> - /// <param name="deleted">Indicates whether the resource is deleted..</param> - /// <param name="projectResources">Collection of minimal project resource details associated with this resource..</param> + /// <param name="deleted">Indicates whether the resource is deleted. (required).</param> + /// <param name="projectResources">Collection of minimal project resource details associated with this resource. (required).</param> /// <param name="resourceQuota">resourceQuota.</param> public ResourceAdminDto(Guid id = default(Guid), string pid = default(string), ResourceTypeDto type = default(ResourceTypeDto), string name = default(string), string displayName = default(string), string description = default(string), List<string> keywords = default(List<string>), LicenseDto license = default(LicenseDto), string usageRights = default(string), bool metadataLocalCopy = default(bool), bool metadataExtraction = default(bool), ApplicationProfileMinimalDto applicationProfile = default(ApplicationProfileMinimalDto), Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>> fixedValues = default(Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>>), List<DisciplineDto> disciplines = default(List<DisciplineDto>), VisibilityDto visibility = default(VisibilityDto), DateTime? dateCreated = default(DateTime?), UserMinimalDto creator = default(UserMinimalDto), bool archived = default(bool), List<ProjectMinimalDto> projects = default(List<ProjectMinimalDto>), bool deleted = default(bool), List<ProjectResourceMinimalDto> projectResources = default(List<ProjectResourceMinimalDto>), ResourceQuotaDto resourceQuota = default(ResourceQuotaDto)) { - this.Id = id; + // to ensure "pid" is required (not null) + if (pid == null) + { + throw new ArgumentNullException("pid is a required property for ResourceAdminDto and cannot be null"); + } this.Pid = pid; + // to ensure "type" is required (not null) + if (type == null) + { + throw new ArgumentNullException("type is a required property for ResourceAdminDto and cannot be null"); + } this.Type = type; + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for ResourceAdminDto and cannot be null"); + } this.Name = name; + // to ensure "displayName" is required (not null) + if (displayName == null) + { + throw new ArgumentNullException("displayName is a required property for ResourceAdminDto and cannot be null"); + } this.DisplayName = displayName; + // to ensure "description" is required (not null) + if (description == null) + { + throw new ArgumentNullException("description is a required property for ResourceAdminDto and cannot be null"); + } this.Description = description; + // to ensure "applicationProfile" is required (not null) + if (applicationProfile == null) + { + throw new ArgumentNullException("applicationProfile is a required property for ResourceAdminDto and cannot be null"); + } + this.ApplicationProfile = applicationProfile; + // to ensure "fixedValues" is required (not null) + if (fixedValues == null) + { + throw new ArgumentNullException("fixedValues is a required property for ResourceAdminDto and cannot be null"); + } + this.FixedValues = fixedValues; + // to ensure "disciplines" is required (not null) + if (disciplines == null) + { + throw new ArgumentNullException("disciplines is a required property for ResourceAdminDto and cannot be null"); + } + this.Disciplines = disciplines; + // to ensure "visibility" is required (not null) + if (visibility == null) + { + throw new ArgumentNullException("visibility is a required property for ResourceAdminDto and cannot be null"); + } + this.Visibility = visibility; + this.Deleted = deleted; + // to ensure "projectResources" is required (not null) + if (projectResources == null) + { + throw new ArgumentNullException("projectResources is a required property for ResourceAdminDto and cannot be null"); + } + this.ProjectResources = projectResources; + this.Id = id; this.Keywords = keywords; this.License = license; this.UsageRights = usageRights; this.MetadataLocalCopy = metadataLocalCopy; this.MetadataExtraction = metadataExtraction; - this.ApplicationProfile = applicationProfile; - this.FixedValues = fixedValues; - this.Disciplines = disciplines; - this.Visibility = visibility; this.DateCreated = dateCreated; this.Creator = creator; this.Archived = archived; this.Projects = projects; - this.Deleted = deleted; - this.ProjectResources = projectResources; this.ResourceQuota = resourceQuota; } @@ -94,34 +149,34 @@ namespace Coscine.ApiClient.Core.Model /// Persistent identifier for the resource. /// </summary> /// <value>Persistent identifier for the resource.</value> - [DataMember(Name = "pid", EmitDefaultValue = false)] + [DataMember(Name = "pid", IsRequired = true, EmitDefaultValue = true)] public string Pid { get; set; } /// <summary> /// Gets or Sets Type /// </summary> - [DataMember(Name = "type", EmitDefaultValue = false)] + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public ResourceTypeDto Type { get; set; } /// <summary> /// Name of the resource. /// </summary> /// <value>Name of the resource.</value> - [DataMember(Name = "name", EmitDefaultValue = false)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> /// Display name of the resource. /// </summary> /// <value>Display name of the resource.</value> - [DataMember(Name = "displayName", EmitDefaultValue = false)] + [DataMember(Name = "displayName", IsRequired = true, EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> /// Description of the resource. /// </summary> /// <value>Description of the resource.</value> - [DataMember(Name = "description", EmitDefaultValue = false)] + [DataMember(Name = "description", IsRequired = true, EmitDefaultValue = true)] public string Description { get; set; } /// <summary> @@ -161,27 +216,27 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Gets or Sets ApplicationProfile /// </summary> - [DataMember(Name = "applicationProfile", EmitDefaultValue = false)] + [DataMember(Name = "applicationProfile", IsRequired = true, EmitDefaultValue = true)] public ApplicationProfileMinimalDto ApplicationProfile { get; set; } /// <summary> /// Fixed values associated with resource manipulation. This dictionary may contain multiple levels and is structured as follows: Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto. /// </summary> /// <value>Fixed values associated with resource manipulation. This dictionary may contain multiple levels and is structured as follows: Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto.</value> - [DataMember(Name = "fixedValues", EmitDefaultValue = false)] + [DataMember(Name = "fixedValues", IsRequired = true, EmitDefaultValue = true)] public Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>> FixedValues { get; set; } /// <summary> /// Disciplines associated with the resource. /// </summary> /// <value>Disciplines associated with the resource.</value> - [DataMember(Name = "disciplines", EmitDefaultValue = false)] + [DataMember(Name = "disciplines", IsRequired = true, EmitDefaultValue = true)] public List<DisciplineDto> Disciplines { get; set; } /// <summary> /// Gets or Sets Visibility /// </summary> - [DataMember(Name = "visibility", EmitDefaultValue = false)] + [DataMember(Name = "visibility", IsRequired = true, EmitDefaultValue = true)] public VisibilityDto Visibility { get; set; } /// <summary> @@ -215,14 +270,14 @@ namespace Coscine.ApiClient.Core.Model /// Indicates whether the resource is deleted. /// </summary> /// <value>Indicates whether the resource is deleted.</value> - [DataMember(Name = "deleted", EmitDefaultValue = true)] + [DataMember(Name = "deleted", IsRequired = true, EmitDefaultValue = true)] public bool Deleted { get; set; } /// <summary> /// Collection of minimal project resource details associated with this resource. /// </summary> /// <value>Collection of minimal project resource details associated with this resource.</value> - [DataMember(Name = "projectResources", EmitDefaultValue = false)] + [DataMember(Name = "projectResources", IsRequired = true, EmitDefaultValue = true)] public List<ProjectResourceMinimalDto> ProjectResources { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/ResourceDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceDto.cs index 63bd8a4bac4acd80372c44ee32c81a9ae4fc5cad..456e69074e3d05e977573e51c6af0f83f03b9964 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceDto.cs @@ -32,45 +32,95 @@ namespace Coscine.ApiClient.Core.Model [DataContract(Name = "ResourceDto")] public partial class ResourceDto : IValidatableObject { + /// <summary> + /// Initializes a new instance of the <see cref="ResourceDto" /> class. + /// </summary> + [JsonConstructorAttribute] + protected ResourceDto() { } /// <summary> /// Initializes a new instance of the <see cref="ResourceDto" /> class. /// </summary> /// <param name="id">Unique identifier for the resource..</param> - /// <param name="pid">Persistent identifier for the resource..</param> - /// <param name="type">type.</param> - /// <param name="name">Name of the resource..</param> - /// <param name="displayName">Display name of the resource..</param> - /// <param name="description">Description of the resource..</param> + /// <param name="pid">Persistent identifier for the resource. (required).</param> + /// <param name="type">type (required).</param> + /// <param name="name">Name of the resource. (required).</param> + /// <param name="displayName">Display name of the resource. (required).</param> + /// <param name="description">Description of the resource. (required).</param> /// <param name="keywords">Keywords associated with the resource..</param> /// <param name="license">license.</param> /// <param name="usageRights">Usage rights associated with the resource..</param> /// <param name="metadataLocalCopy">Setting for creating a local copy of the metadata..</param> /// <param name="metadataExtraction">Setting for metadata extraction..</param> - /// <param name="applicationProfile">applicationProfile.</param> - /// <param name="fixedValues">Fixed values associated with resource manipulation. This dictionary may contain multiple levels and is structured as follows: Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto..</param> - /// <param name="disciplines">Disciplines associated with the resource..</param> - /// <param name="visibility">visibility.</param> + /// <param name="applicationProfile">applicationProfile (required).</param> + /// <param name="fixedValues">Fixed values associated with resource manipulation. This dictionary may contain multiple levels and is structured as follows: Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto. (required).</param> + /// <param name="disciplines">Disciplines associated with the resource. (required).</param> + /// <param name="visibility">visibility (required).</param> /// <param name="dateCreated">Date when the resource was created..</param> /// <param name="creator">creator.</param> /// <param name="archived">Indicates whether the resource is archived..</param> /// <param name="projects">The projects associated with the resource..</param> public ResourceDto(Guid id = default(Guid), string pid = default(string), ResourceTypeDto type = default(ResourceTypeDto), string name = default(string), string displayName = default(string), string description = default(string), List<string> keywords = default(List<string>), LicenseDto license = default(LicenseDto), string usageRights = default(string), bool metadataLocalCopy = default(bool), bool metadataExtraction = default(bool), ApplicationProfileMinimalDto applicationProfile = default(ApplicationProfileMinimalDto), Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>> fixedValues = default(Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>>), List<DisciplineDto> disciplines = default(List<DisciplineDto>), VisibilityDto visibility = default(VisibilityDto), DateTime? dateCreated = default(DateTime?), UserMinimalDto creator = default(UserMinimalDto), bool archived = default(bool), List<ProjectMinimalDto> projects = default(List<ProjectMinimalDto>)) { - this.Id = id; + // to ensure "pid" is required (not null) + if (pid == null) + { + throw new ArgumentNullException("pid is a required property for ResourceDto and cannot be null"); + } this.Pid = pid; + // to ensure "type" is required (not null) + if (type == null) + { + throw new ArgumentNullException("type is a required property for ResourceDto and cannot be null"); + } this.Type = type; + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for ResourceDto and cannot be null"); + } this.Name = name; + // to ensure "displayName" is required (not null) + if (displayName == null) + { + throw new ArgumentNullException("displayName is a required property for ResourceDto and cannot be null"); + } this.DisplayName = displayName; + // to ensure "description" is required (not null) + if (description == null) + { + throw new ArgumentNullException("description is a required property for ResourceDto and cannot be null"); + } this.Description = description; + // to ensure "applicationProfile" is required (not null) + if (applicationProfile == null) + { + throw new ArgumentNullException("applicationProfile is a required property for ResourceDto and cannot be null"); + } + this.ApplicationProfile = applicationProfile; + // to ensure "fixedValues" is required (not null) + if (fixedValues == null) + { + throw new ArgumentNullException("fixedValues is a required property for ResourceDto and cannot be null"); + } + this.FixedValues = fixedValues; + // to ensure "disciplines" is required (not null) + if (disciplines == null) + { + throw new ArgumentNullException("disciplines is a required property for ResourceDto and cannot be null"); + } + this.Disciplines = disciplines; + // to ensure "visibility" is required (not null) + if (visibility == null) + { + throw new ArgumentNullException("visibility is a required property for ResourceDto and cannot be null"); + } + this.Visibility = visibility; + this.Id = id; this.Keywords = keywords; this.License = license; this.UsageRights = usageRights; this.MetadataLocalCopy = metadataLocalCopy; this.MetadataExtraction = metadataExtraction; - this.ApplicationProfile = applicationProfile; - this.FixedValues = fixedValues; - this.Disciplines = disciplines; - this.Visibility = visibility; this.DateCreated = dateCreated; this.Creator = creator; this.Archived = archived; @@ -88,34 +138,34 @@ namespace Coscine.ApiClient.Core.Model /// Persistent identifier for the resource. /// </summary> /// <value>Persistent identifier for the resource.</value> - [DataMember(Name = "pid", EmitDefaultValue = false)] + [DataMember(Name = "pid", IsRequired = true, EmitDefaultValue = true)] public string Pid { get; set; } /// <summary> /// Gets or Sets Type /// </summary> - [DataMember(Name = "type", EmitDefaultValue = false)] + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public ResourceTypeDto Type { get; set; } /// <summary> /// Name of the resource. /// </summary> /// <value>Name of the resource.</value> - [DataMember(Name = "name", EmitDefaultValue = false)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> /// Display name of the resource. /// </summary> /// <value>Display name of the resource.</value> - [DataMember(Name = "displayName", EmitDefaultValue = false)] + [DataMember(Name = "displayName", IsRequired = true, EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> /// Description of the resource. /// </summary> /// <value>Description of the resource.</value> - [DataMember(Name = "description", EmitDefaultValue = false)] + [DataMember(Name = "description", IsRequired = true, EmitDefaultValue = true)] public string Description { get; set; } /// <summary> @@ -155,27 +205,27 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Gets or Sets ApplicationProfile /// </summary> - [DataMember(Name = "applicationProfile", EmitDefaultValue = false)] + [DataMember(Name = "applicationProfile", IsRequired = true, EmitDefaultValue = true)] public ApplicationProfileMinimalDto ApplicationProfile { get; set; } /// <summary> /// Fixed values associated with resource manipulation. This dictionary may contain multiple levels and is structured as follows: Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto. /// </summary> /// <value>Fixed values associated with resource manipulation. This dictionary may contain multiple levels and is structured as follows: Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto.</value> - [DataMember(Name = "fixedValues", EmitDefaultValue = false)] + [DataMember(Name = "fixedValues", IsRequired = true, EmitDefaultValue = true)] public Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>> FixedValues { get; set; } /// <summary> /// Disciplines associated with the resource. /// </summary> /// <value>Disciplines associated with the resource.</value> - [DataMember(Name = "disciplines", EmitDefaultValue = false)] + [DataMember(Name = "disciplines", IsRequired = true, EmitDefaultValue = true)] public List<DisciplineDto> Disciplines { get; set; } /// <summary> /// Gets or Sets Visibility /// </summary> - [DataMember(Name = "visibility", EmitDefaultValue = false)] + [DataMember(Name = "visibility", IsRequired = true, EmitDefaultValue = true)] public VisibilityDto Visibility { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/ResourceMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceMinimalDto.cs index 3660f15968029c052e0540771acbf35af7667baf..4304235245f619b0cbb92b754b4b453db0215ada 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceMinimalDto.cs @@ -35,7 +35,12 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceMinimalDto" /> class. /// </summary> - /// <param name="id">Unique identifier for the resource..</param> + [JsonConstructorAttribute] + protected ResourceMinimalDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="ResourceMinimalDto" /> class. + /// </summary> + /// <param name="id">Unique identifier for the resource. (required).</param> public ResourceMinimalDto(Guid id = default(Guid)) { this.Id = id; @@ -45,7 +50,7 @@ namespace Coscine.ApiClient.Core.Model /// Unique identifier for the resource. /// </summary> /// <value>Unique identifier for the resource.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/ResourceQuotaDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceQuotaDto.cs index 61e845e1d698f80256daec301207518a799c20d4..dee79bea75cb004c29bb93b68ae7e7bda856a876 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceQuotaDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceQuotaDto.cs @@ -35,12 +35,22 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceQuotaDto" /> class. /// </summary> - /// <param name="resource">resource.</param> + [JsonConstructorAttribute] + protected ResourceQuotaDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="ResourceQuotaDto" /> class. + /// </summary> + /// <param name="resource">resource (required).</param> /// <param name="usedPercentage">The percentage of quota used by the resource..</param> /// <param name="used">used.</param> /// <param name="reserved">reserved.</param> public ResourceQuotaDto(ResourceMinimalDto resource = default(ResourceMinimalDto), float? usedPercentage = default(float?), QuotaDto used = default(QuotaDto), QuotaDto reserved = default(QuotaDto)) { + // to ensure "resource" is required (not null) + if (resource == null) + { + throw new ArgumentNullException("resource is a required property for ResourceQuotaDto and cannot be null"); + } this.Resource = resource; this.UsedPercentage = usedPercentage; this.Used = used; @@ -50,7 +60,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Gets or Sets Resource /// </summary> - [DataMember(Name = "resource", EmitDefaultValue = false)] + [DataMember(Name = "resource", IsRequired = true, EmitDefaultValue = true)] public ResourceMinimalDto Resource { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/ResourceTypeDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceTypeDto.cs index cc86ef943807758d95b7bff0051a5d6413b572b4..319c920147976733cb4c001fa9196271b859d59a 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceTypeDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceTypeDto.cs @@ -32,18 +32,33 @@ namespace Coscine.ApiClient.Core.Model [DataContract(Name = "ResourceTypeDto")] public partial class ResourceTypeDto : IValidatableObject { + /// <summary> + /// Initializes a new instance of the <see cref="ResourceTypeDto" /> class. + /// </summary> + [JsonConstructorAttribute] + protected ResourceTypeDto() { } /// <summary> /// Initializes a new instance of the <see cref="ResourceTypeDto" /> class. /// </summary> /// <param name="id">The unique identifier of the resource type..</param> - /// <param name="generalType">The general type of the resource..</param> - /// <param name="specificType">The specific type of the resource..</param> + /// <param name="generalType">The general type of the resource. (required).</param> + /// <param name="specificType">The specific type of the resource. (required).</param> /// <param name="options">options.</param> public ResourceTypeDto(Guid id = default(Guid), string generalType = default(string), string specificType = default(string), ResourceTypeOptionsDto options = default(ResourceTypeOptionsDto)) { - this.Id = id; + // to ensure "generalType" is required (not null) + if (generalType == null) + { + throw new ArgumentNullException("generalType is a required property for ResourceTypeDto and cannot be null"); + } this.GeneralType = generalType; + // to ensure "specificType" is required (not null) + if (specificType == null) + { + throw new ArgumentNullException("specificType is a required property for ResourceTypeDto and cannot be null"); + } this.SpecificType = specificType; + this.Id = id; this.Options = options; } @@ -58,14 +73,14 @@ namespace Coscine.ApiClient.Core.Model /// The general type of the resource. /// </summary> /// <value>The general type of the resource.</value> - [DataMember(Name = "generalType", EmitDefaultValue = false)] + [DataMember(Name = "generalType", IsRequired = true, EmitDefaultValue = true)] public string GeneralType { get; set; } /// <summary> /// The specific type of the resource. /// </summary> /// <value>The specific type of the resource.</value> - [DataMember(Name = "specificType", EmitDefaultValue = false)] + [DataMember(Name = "specificType", IsRequired = true, EmitDefaultValue = true)] public string SpecificType { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/ResourceTypeMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceTypeMinimalDto.cs index bbe2cee360c57c1ce3fa3ec9972697322251e1c7..dceccd7b9935e8c673cab014ecca2879f9427a92 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceTypeMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceTypeMinimalDto.cs @@ -35,11 +35,21 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceTypeMinimalDto" /> class. /// </summary> - /// <param name="id">The unique identifier of the resource type..</param> - /// <param name="specificType">The specific type of the resource..</param> + [JsonConstructorAttribute] + protected ResourceTypeMinimalDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="ResourceTypeMinimalDto" /> class. + /// </summary> + /// <param name="id">The unique identifier of the resource type. (required).</param> + /// <param name="specificType">The specific type of the resource. (required).</param> public ResourceTypeMinimalDto(Guid id = default(Guid), string specificType = default(string)) { this.Id = id; + // to ensure "specificType" is required (not null) + if (specificType == null) + { + throw new ArgumentNullException("specificType is a required property for ResourceTypeMinimalDto and cannot be null"); + } this.SpecificType = specificType; } @@ -47,14 +57,14 @@ namespace Coscine.ApiClient.Core.Model /// The unique identifier of the resource type. /// </summary> /// <value>The unique identifier of the resource type.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> /// The specific type of the resource. /// </summary> /// <value>The specific type of the resource.</value> - [DataMember(Name = "specificType", EmitDefaultValue = false)] + [DataMember(Name = "specificType", IsRequired = true, EmitDefaultValue = true)] public string SpecificType { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/RoleDto.cs b/src/Coscine.ApiClient.Core/Model/RoleDto.cs index 4649506adf13a23119593af75890bcbb996687f6..002ad7a774ad5cef0e653cbc6a2e158416b091e0 100644 --- a/src/Coscine.ApiClient.Core/Model/RoleDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RoleDto.cs @@ -35,13 +35,28 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RoleDto" /> class. /// </summary> - /// <param name="id">The unique identifier of the role..</param> - /// <param name="displayName">The display name of the role..</param> - /// <param name="description">The description of the role..</param> + [JsonConstructorAttribute] + protected RoleDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="RoleDto" /> class. + /// </summary> + /// <param name="id">The unique identifier of the role. (required).</param> + /// <param name="displayName">The display name of the role. (required).</param> + /// <param name="description">The description of the role. (required).</param> public RoleDto(Guid id = default(Guid), string displayName = default(string), string description = default(string)) { this.Id = id; + // to ensure "displayName" is required (not null) + if (displayName == null) + { + throw new ArgumentNullException("displayName is a required property for RoleDto and cannot be null"); + } this.DisplayName = displayName; + // to ensure "description" is required (not null) + if (description == null) + { + throw new ArgumentNullException("description is a required property for RoleDto and cannot be null"); + } this.Description = description; } @@ -49,21 +64,21 @@ namespace Coscine.ApiClient.Core.Model /// The unique identifier of the role. /// </summary> /// <value>The unique identifier of the role.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> /// The display name of the role. /// </summary> /// <value>The display name of the role.</value> - [DataMember(Name = "displayName", EmitDefaultValue = false)] + [DataMember(Name = "displayName", IsRequired = true, EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> /// The description of the role. /// </summary> /// <value>The description of the role.</value> - [DataMember(Name = "description", EmitDefaultValue = false)] + [DataMember(Name = "description", IsRequired = true, EmitDefaultValue = true)] public string Description { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/RoleMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/RoleMinimalDto.cs index 530eea35984d5c6a0845567aae0f7b39cf2ed428..cbbf57e3263620642bbb013313379447c055e7be 100644 --- a/src/Coscine.ApiClient.Core/Model/RoleMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RoleMinimalDto.cs @@ -35,7 +35,12 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RoleMinimalDto" /> class. /// </summary> - /// <param name="id">The unique identifier of the role..</param> + [JsonConstructorAttribute] + protected RoleMinimalDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="RoleMinimalDto" /> class. + /// </summary> + /// <param name="id">The unique identifier of the role. (required).</param> public RoleMinimalDto(Guid id = default(Guid)) { this.Id = id; @@ -45,7 +50,7 @@ namespace Coscine.ApiClient.Core.Model /// The unique identifier of the role. /// </summary> /// <value>The unique identifier of the role.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/SearchResultDto.cs b/src/Coscine.ApiClient.Core/Model/SearchResultDto.cs index f4adc40593fc6221b6cb215c4af67e78b4b4b790..3a4ae690a7983cc28f276be0b66d1aaa0728b652 100644 --- a/src/Coscine.ApiClient.Core/Model/SearchResultDto.cs +++ b/src/Coscine.ApiClient.Core/Model/SearchResultDto.cs @@ -36,18 +36,33 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Gets or Sets Type /// </summary> - [DataMember(Name = "type", EmitDefaultValue = false)] - public SearchCategoryType? Type { get; set; } + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] + public SearchCategoryType Type { get; set; } /// <summary> /// Initializes a new instance of the <see cref="SearchResultDto" /> class. /// </summary> - /// <param name="uri">The URI associated with the search result..</param> - /// <param name="type">type.</param> - /// <param name="source">The dynamic source data for the search result..</param> - public SearchResultDto(string uri = default(string), SearchCategoryType? type = default(SearchCategoryType?), Object source = default(Object)) + [JsonConstructorAttribute] + protected SearchResultDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="SearchResultDto" /> class. + /// </summary> + /// <param name="uri">The URI associated with the search result. (required).</param> + /// <param name="type">type (required).</param> + /// <param name="source">The dynamic source data for the search result. (required).</param> + public SearchResultDto(string uri = default(string), SearchCategoryType type = default(SearchCategoryType), Object source = default(Object)) { + // to ensure "uri" is required (not null) + if (uri == null) + { + throw new ArgumentNullException("uri is a required property for SearchResultDto and cannot be null"); + } this.Uri = uri; this.Type = type; + // to ensure "source" is required (not null) + if (source == null) + { + throw new ArgumentNullException("source is a required property for SearchResultDto and cannot be null"); + } this.Source = source; } @@ -55,14 +70,14 @@ namespace Coscine.ApiClient.Core.Model /// The URI associated with the search result. /// </summary> /// <value>The URI associated with the search result.</value> - [DataMember(Name = "uri", EmitDefaultValue = false)] + [DataMember(Name = "uri", IsRequired = true, EmitDefaultValue = true)] public string Uri { get; set; } /// <summary> /// The dynamic source data for the search result. /// </summary> /// <value>The dynamic source data for the search result.</value> - [DataMember(Name = "source", EmitDefaultValue = true)] + [DataMember(Name = "source", IsRequired = true, EmitDefaultValue = true)] public Object Source { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/TermsOfServiceDto.cs b/src/Coscine.ApiClient.Core/Model/TermsOfServiceDto.cs index 1c261140509fde894e12e56da8f7fc60e434e4fd..b639b07f9266d269a6a2a3d74953ed8252506a4d 100644 --- a/src/Coscine.ApiClient.Core/Model/TermsOfServiceDto.cs +++ b/src/Coscine.ApiClient.Core/Model/TermsOfServiceDto.cs @@ -35,12 +35,27 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="TermsOfServiceDto" /> class. /// </summary> - /// <param name="varVersion">The version of the terms of service..</param> - /// <param name="href">The URI point to the content of ToS' version.</param> - /// <param name="isCurrent">Indicates whether these terms of service are current or not..</param> + [JsonConstructorAttribute] + protected TermsOfServiceDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="TermsOfServiceDto" /> class. + /// </summary> + /// <param name="varVersion">The version of the terms of service. (required).</param> + /// <param name="href">The URI point to the content of ToS' version (required).</param> + /// <param name="isCurrent">Indicates whether these terms of service are current or not. (required).</param> public TermsOfServiceDto(string varVersion = default(string), string href = default(string), bool isCurrent = default(bool)) { + // to ensure "varVersion" is required (not null) + if (varVersion == null) + { + throw new ArgumentNullException("varVersion is a required property for TermsOfServiceDto and cannot be null"); + } this.VarVersion = varVersion; + // to ensure "href" is required (not null) + if (href == null) + { + throw new ArgumentNullException("href is a required property for TermsOfServiceDto and cannot be null"); + } this.Href = href; this.IsCurrent = isCurrent; } @@ -49,21 +64,21 @@ namespace Coscine.ApiClient.Core.Model /// The version of the terms of service. /// </summary> /// <value>The version of the terms of service.</value> - [DataMember(Name = "version", EmitDefaultValue = false)] + [DataMember(Name = "version", IsRequired = true, EmitDefaultValue = true)] public string VarVersion { get; set; } /// <summary> /// The URI point to the content of ToS' version /// </summary> /// <value>The URI point to the content of ToS' version</value> - [DataMember(Name = "href", EmitDefaultValue = false)] + [DataMember(Name = "href", IsRequired = true, EmitDefaultValue = true)] public string Href { get; set; } /// <summary> /// Indicates whether these terms of service are current or not. /// </summary> /// <value>Indicates whether these terms of service are current or not.</value> - [DataMember(Name = "isCurrent", EmitDefaultValue = true)] + [DataMember(Name = "isCurrent", IsRequired = true, EmitDefaultValue = true)] public bool IsCurrent { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/TitleDto.cs b/src/Coscine.ApiClient.Core/Model/TitleDto.cs index 23e8643091e0ae62e46854399436e0d2fec11215..be9df4b1e502c2515a86e371c448fc2117afb5e5 100644 --- a/src/Coscine.ApiClient.Core/Model/TitleDto.cs +++ b/src/Coscine.ApiClient.Core/Model/TitleDto.cs @@ -35,11 +35,21 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="TitleDto" /> class. /// </summary> - /// <param name="id">The identifier for the title..</param> - /// <param name="displayName">The displayed name of the title..</param> + [JsonConstructorAttribute] + protected TitleDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="TitleDto" /> class. + /// </summary> + /// <param name="id">The identifier for the title. (required).</param> + /// <param name="displayName">The displayed name of the title. (required).</param> public TitleDto(Guid id = default(Guid), string displayName = default(string)) { this.Id = id; + // to ensure "displayName" is required (not null) + if (displayName == null) + { + throw new ArgumentNullException("displayName is a required property for TitleDto and cannot be null"); + } this.DisplayName = displayName; } @@ -47,14 +57,14 @@ namespace Coscine.ApiClient.Core.Model /// The identifier for the title. /// </summary> /// <value>The identifier for the title.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> /// The displayed name of the title. /// </summary> /// <value>The displayed name of the title.</value> - [DataMember(Name = "displayName", EmitDefaultValue = false)] + [DataMember(Name = "displayName", IsRequired = true, EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/UserDto.cs b/src/Coscine.ApiClient.Core/Model/UserDto.cs index 1ab89e4c981489b1237c379fc572dea4b631bebe..d5457c0b4a134a7609578c5009f38cf5e01e8e2c 100644 --- a/src/Coscine.ApiClient.Core/Model/UserDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserDto.cs @@ -35,69 +35,112 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="UserDto" /> class. /// </summary> - /// <param name="id">The unique identifier of the user..</param> - /// <param name="displayName">The display name of the user..</param> - /// <param name="givenName">The given name of the user..</param> - /// <param name="familyName">The family name of the user..</param> - /// <param name="emails">The email addresses associated with the user..</param> + [JsonConstructorAttribute] + protected UserDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="UserDto" /> class. + /// </summary> + /// <param name="id">The unique identifier of the user. (required).</param> + /// <param name="displayName">The display name of the user. (required).</param> + /// <param name="givenName">The given name of the user. (required).</param> + /// <param name="familyName">The family name of the user. (required).</param> + /// <param name="emails">The email addresses associated with the user. (required).</param> /// <param name="title">title.</param> - /// <param name="language">language.</param> - /// <param name="areToSAccepted">Indicates if the terms of service are accepted by the user..</param> + /// <param name="language">language (required).</param> + /// <param name="areToSAccepted">Indicates if the terms of service are accepted by the user. (required).</param> /// <param name="latestActivity">The date and time of the latest activity of the user..</param> - /// <param name="disciplines">The disciplines associated with the user..</param> - /// <param name="organizations">The organizations associated with the user..</param> - /// <param name="institutes">The institutes associated with the user..</param> - /// <param name="identities">The identity providers associated with the user..</param> - public UserDto(Guid id = default(Guid), string displayName = default(string), string givenName = default(string), string familyName = default(string), List<UserEmailDto> emails = default(List<UserEmailDto>), TitleDto title = default(TitleDto), LanguageDto language = default(LanguageDto), bool areToSAccepted = default(bool), DateTime? latestActivity = default(DateTime?), List<DisciplineDto> disciplines = default(List<DisciplineDto>), List<UserOrganizationDto> organizations = default(List<UserOrganizationDto>), List<UserInstituteDto> institutes = default(List<UserInstituteDto>), List<IdentityProviderDto> identities = default(List<IdentityProviderDto>)) + /// <param name="disciplines">The disciplines associated with the user. (required).</param> + /// <param name="organizations">The organizations associated with the user. (required).</param> + /// <param name="identities">The identity providers associated with the user. (required).</param> + public UserDto(Guid id = default(Guid), string displayName = default(string), string givenName = default(string), string familyName = default(string), List<UserEmailDto> emails = default(List<UserEmailDto>), TitleDto title = default(TitleDto), LanguageDto language = default(LanguageDto), bool areToSAccepted = default(bool), DateTime? latestActivity = default(DateTime?), List<DisciplineDto> disciplines = default(List<DisciplineDto>), List<UserOrganizationDto> organizations = default(List<UserOrganizationDto>), List<IdentityProviderDto> identities = default(List<IdentityProviderDto>)) { this.Id = id; + // to ensure "displayName" is required (not null) + if (displayName == null) + { + throw new ArgumentNullException("displayName is a required property for UserDto and cannot be null"); + } this.DisplayName = displayName; + // to ensure "givenName" is required (not null) + if (givenName == null) + { + throw new ArgumentNullException("givenName is a required property for UserDto and cannot be null"); + } this.GivenName = givenName; + // to ensure "familyName" is required (not null) + if (familyName == null) + { + throw new ArgumentNullException("familyName is a required property for UserDto and cannot be null"); + } this.FamilyName = familyName; + // to ensure "emails" is required (not null) + if (emails == null) + { + throw new ArgumentNullException("emails is a required property for UserDto and cannot be null"); + } this.Emails = emails; - this.Title = title; + // to ensure "language" is required (not null) + if (language == null) + { + throw new ArgumentNullException("language is a required property for UserDto and cannot be null"); + } this.Language = language; this.AreToSAccepted = areToSAccepted; - this.LatestActivity = latestActivity; + // to ensure "disciplines" is required (not null) + if (disciplines == null) + { + throw new ArgumentNullException("disciplines is a required property for UserDto and cannot be null"); + } this.Disciplines = disciplines; + // to ensure "organizations" is required (not null) + if (organizations == null) + { + throw new ArgumentNullException("organizations is a required property for UserDto and cannot be null"); + } this.Organizations = organizations; - this.Institutes = institutes; + // to ensure "identities" is required (not null) + if (identities == null) + { + throw new ArgumentNullException("identities is a required property for UserDto and cannot be null"); + } this.Identities = identities; + this.Title = title; + this.LatestActivity = latestActivity; } /// <summary> /// The unique identifier of the user. /// </summary> /// <value>The unique identifier of the user.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> /// The display name of the user. /// </summary> /// <value>The display name of the user.</value> - [DataMember(Name = "displayName", EmitDefaultValue = false)] + [DataMember(Name = "displayName", IsRequired = true, EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> /// The given name of the user. /// </summary> /// <value>The given name of the user.</value> - [DataMember(Name = "givenName", EmitDefaultValue = false)] + [DataMember(Name = "givenName", IsRequired = true, EmitDefaultValue = true)] public string GivenName { get; set; } /// <summary> /// The family name of the user. /// </summary> /// <value>The family name of the user.</value> - [DataMember(Name = "familyName", EmitDefaultValue = false)] + [DataMember(Name = "familyName", IsRequired = true, EmitDefaultValue = true)] public string FamilyName { get; set; } /// <summary> /// The email addresses associated with the user. /// </summary> /// <value>The email addresses associated with the user.</value> - [DataMember(Name = "emails", EmitDefaultValue = false)] + [DataMember(Name = "emails", IsRequired = true, EmitDefaultValue = true)] public List<UserEmailDto> Emails { get; set; } /// <summary> @@ -109,14 +152,14 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Gets or Sets Language /// </summary> - [DataMember(Name = "language", EmitDefaultValue = false)] + [DataMember(Name = "language", IsRequired = true, EmitDefaultValue = true)] public LanguageDto Language { get; set; } /// <summary> /// Indicates if the terms of service are accepted by the user. /// </summary> /// <value>Indicates if the terms of service are accepted by the user.</value> - [DataMember(Name = "areToSAccepted", EmitDefaultValue = true)] + [DataMember(Name = "areToSAccepted", IsRequired = true, EmitDefaultValue = true)] public bool AreToSAccepted { get; set; } /// <summary> @@ -130,28 +173,21 @@ namespace Coscine.ApiClient.Core.Model /// The disciplines associated with the user. /// </summary> /// <value>The disciplines associated with the user.</value> - [DataMember(Name = "disciplines", EmitDefaultValue = false)] + [DataMember(Name = "disciplines", IsRequired = true, EmitDefaultValue = true)] public List<DisciplineDto> Disciplines { get; set; } /// <summary> /// The organizations associated with the user. /// </summary> /// <value>The organizations associated with the user.</value> - [DataMember(Name = "organizations", EmitDefaultValue = false)] + [DataMember(Name = "organizations", IsRequired = true, EmitDefaultValue = true)] public List<UserOrganizationDto> Organizations { get; set; } - /// <summary> - /// The institutes associated with the user. - /// </summary> - /// <value>The institutes associated with the user.</value> - [DataMember(Name = "institutes", EmitDefaultValue = false)] - public List<UserInstituteDto> Institutes { get; set; } - /// <summary> /// The identity providers associated with the user. /// </summary> /// <value>The identity providers associated with the user.</value> - [DataMember(Name = "identities", EmitDefaultValue = false)] + [DataMember(Name = "identities", IsRequired = true, EmitDefaultValue = true)] public List<IdentityProviderDto> Identities { get; set; } /// <summary> @@ -173,7 +209,6 @@ namespace Coscine.ApiClient.Core.Model sb.Append(" LatestActivity: ").Append(LatestActivity).Append("\n"); sb.Append(" Disciplines: ").Append(Disciplines).Append("\n"); sb.Append(" Organizations: ").Append(Organizations).Append("\n"); - sb.Append(" Institutes: ").Append(Institutes).Append("\n"); sb.Append(" Identities: ").Append(Identities).Append("\n"); sb.Append("}\n"); return sb.ToString(); diff --git a/src/Coscine.ApiClient.Core/Model/UserForUpdateDto.cs b/src/Coscine.ApiClient.Core/Model/UserForUpdateDto.cs index d53853d12244eb9219905112fb8b70a6b10aeb3c..fda6b674810c33eeaeef7d4034220645f64d65ba 100644 --- a/src/Coscine.ApiClient.Core/Model/UserForUpdateDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserForUpdateDto.cs @@ -46,9 +46,8 @@ namespace Coscine.ApiClient.Core.Model /// <param name="title">title.</param> /// <param name="language">language (required).</param> /// <param name="organization">The user's organization..</param> - /// <param name="institute">The user's institute..</param> /// <param name="disciplines">The disciplines associated with the user for manipulation. (required).</param> - public UserForUpdateDto(string givenName = default(string), string familyName = default(string), string email = default(string), TitleForUserManipulationDto title = default(TitleForUserManipulationDto), LanguageForUserManipulationDto language = default(LanguageForUserManipulationDto), string organization = default(string), string institute = default(string), List<DisciplineForUserManipulationDto> disciplines = default(List<DisciplineForUserManipulationDto>)) + public UserForUpdateDto(string givenName = default(string), string familyName = default(string), string email = default(string), TitleForUserManipulationDto title = default(TitleForUserManipulationDto), LanguageForUserManipulationDto language = default(LanguageForUserManipulationDto), string organization = default(string), List<DisciplineForUserManipulationDto> disciplines = default(List<DisciplineForUserManipulationDto>)) { // to ensure "givenName" is required (not null) if (givenName == null) @@ -82,7 +81,6 @@ namespace Coscine.ApiClient.Core.Model this.Disciplines = disciplines; this.Title = title; this.Organization = organization; - this.Institute = institute; } /// <summary> @@ -125,13 +123,6 @@ namespace Coscine.ApiClient.Core.Model [DataMember(Name = "organization", EmitDefaultValue = true)] public string Organization { get; set; } - /// <summary> - /// The user's institute. - /// </summary> - /// <value>The user's institute.</value> - [DataMember(Name = "institute", EmitDefaultValue = true)] - public string Institute { get; set; } - /// <summary> /// The disciplines associated with the user for manipulation. /// </summary> @@ -153,7 +144,6 @@ namespace Coscine.ApiClient.Core.Model sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" Language: ").Append(Language).Append("\n"); sb.Append(" Organization: ").Append(Organization).Append("\n"); - sb.Append(" Institute: ").Append(Institute).Append("\n"); sb.Append(" Disciplines: ").Append(Disciplines).Append("\n"); sb.Append("}\n"); return sb.ToString(); diff --git a/src/Coscine.ApiClient.Core/Model/UserMergeDto.cs b/src/Coscine.ApiClient.Core/Model/UserMergeDto.cs index 1c84e77dc202c17eaa7fc62596055b28dcf59c08..0c3f828699b5ed40f20f24c4be48afa9943930d5 100644 --- a/src/Coscine.ApiClient.Core/Model/UserMergeDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserMergeDto.cs @@ -35,9 +35,19 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="UserMergeDto" /> class. /// </summary> - /// <param name="token">The token required for merging user accounts..</param> + [JsonConstructorAttribute] + protected UserMergeDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="UserMergeDto" /> class. + /// </summary> + /// <param name="token">The token required for merging user accounts. (required).</param> public UserMergeDto(string token = default(string)) { + // to ensure "token" is required (not null) + if (token == null) + { + throw new ArgumentNullException("token is a required property for UserMergeDto and cannot be null"); + } this.Token = token; } @@ -45,7 +55,7 @@ namespace Coscine.ApiClient.Core.Model /// The token required for merging user accounts. /// </summary> /// <value>The token required for merging user accounts.</value> - [DataMember(Name = "token", EmitDefaultValue = false)] + [DataMember(Name = "token", IsRequired = true, EmitDefaultValue = true)] public string Token { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/UserMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/UserMinimalDto.cs index bc1f02a8fad3efb21c1b1ac90b479b8b5bbdd057..67018f2779d7bdc91174850ece6dabcea613590f 100644 --- a/src/Coscine.ApiClient.Core/Model/UserMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserMinimalDto.cs @@ -35,7 +35,12 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="UserMinimalDto" /> class. /// </summary> - /// <param name="id">The unique identifier for the user..</param> + [JsonConstructorAttribute] + protected UserMinimalDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="UserMinimalDto" /> class. + /// </summary> + /// <param name="id">The unique identifier for the user. (required).</param> public UserMinimalDto(Guid id = default(Guid)) { this.Id = id; @@ -45,7 +50,7 @@ namespace Coscine.ApiClient.Core.Model /// The unique identifier for the user. /// </summary> /// <value>The unique identifier for the user.</value> - [DataMember(Name = "id", EmitDefaultValue = false)] + [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/UserOrganizationDto.cs b/src/Coscine.ApiClient.Core/Model/UserOrganizationDto.cs index 0e04c3fb83ab92f36193fd36d12c1d03c15f130e..93ab5f9293c752253421c8d56cfa29e6d849b12a 100644 --- a/src/Coscine.ApiClient.Core/Model/UserOrganizationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserOrganizationDto.cs @@ -35,32 +35,47 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="UserOrganizationDto" /> class. /// </summary> - /// <param name="uri">The ROR (Research Organization Registry) ID of the organization..</param> - /// <param name="displayName">The display name of the organization..</param> + [JsonConstructorAttribute] + protected UserOrganizationDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="UserOrganizationDto" /> class. + /// </summary> + /// <param name="uri">The ROR (Research Organization Registry) ID of the organization. (required).</param> + /// <param name="displayName">The display name of the organization. (required).</param> /// <param name="email">The email address of the organization..</param> /// <param name="publicationAdvisoryService">publicationAdvisoryService.</param> - /// <param name="readOnly">Determines if the organization's details can be modified..</param> + /// <param name="readOnly">Determines if the organization's details can be modified. (required).</param> public UserOrganizationDto(string uri = default(string), string displayName = default(string), string email = default(string), PublicationAdvisoryServiceDto publicationAdvisoryService = default(PublicationAdvisoryServiceDto), bool readOnly = default(bool)) { + // to ensure "uri" is required (not null) + if (uri == null) + { + throw new ArgumentNullException("uri is a required property for UserOrganizationDto and cannot be null"); + } this.Uri = uri; + // to ensure "displayName" is required (not null) + if (displayName == null) + { + throw new ArgumentNullException("displayName is a required property for UserOrganizationDto and cannot be null"); + } this.DisplayName = displayName; + this.ReadOnly = readOnly; this.Email = email; this.PublicationAdvisoryService = publicationAdvisoryService; - this.ReadOnly = readOnly; } /// <summary> /// The ROR (Research Organization Registry) ID of the organization. /// </summary> /// <value>The ROR (Research Organization Registry) ID of the organization.</value> - [DataMember(Name = "uri", EmitDefaultValue = false)] + [DataMember(Name = "uri", IsRequired = true, EmitDefaultValue = true)] public string Uri { get; set; } /// <summary> /// The display name of the organization. /// </summary> /// <value>The display name of the organization.</value> - [DataMember(Name = "displayName", EmitDefaultValue = false)] + [DataMember(Name = "displayName", IsRequired = true, EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> @@ -80,7 +95,7 @@ namespace Coscine.ApiClient.Core.Model /// Determines if the organization's details can be modified. /// </summary> /// <value>Determines if the organization's details can be modified.</value> - [DataMember(Name = "readOnly", EmitDefaultValue = true)] + [DataMember(Name = "readOnly", IsRequired = true, EmitDefaultValue = true)] public bool ReadOnly { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/VocabularyDto.cs b/src/Coscine.ApiClient.Core/Model/VocabularyDto.cs index 827477ed91c1bff4fddb96ce6e9185dcff34bbe3..82690fbbb5b9f3a034151c02c6d00286738c136a 100644 --- a/src/Coscine.ApiClient.Core/Model/VocabularyDto.cs +++ b/src/Coscine.ApiClient.Core/Model/VocabularyDto.cs @@ -35,13 +35,28 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="VocabularyDto" /> class. /// </summary> - /// <param name="graphUri">The URI of the graph containing the vocabulary..</param> - /// <param name="classUri">The URI of the top-level parent class in the vocabulary..</param> + [JsonConstructorAttribute] + protected VocabularyDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="VocabularyDto" /> class. + /// </summary> + /// <param name="graphUri">The URI of the graph containing the vocabulary. (required).</param> + /// <param name="classUri">The URI of the top-level parent class in the vocabulary. (required).</param> /// <param name="displayName">The display name of the vocabulary..</param> /// <param name="description">The description of the vocabulary..</param> public VocabularyDto(string graphUri = default(string), string classUri = default(string), string displayName = default(string), string description = default(string)) { + // to ensure "graphUri" is required (not null) + if (graphUri == null) + { + throw new ArgumentNullException("graphUri is a required property for VocabularyDto and cannot be null"); + } this.GraphUri = graphUri; + // to ensure "classUri" is required (not null) + if (classUri == null) + { + throw new ArgumentNullException("classUri is a required property for VocabularyDto and cannot be null"); + } this.ClassUri = classUri; this.DisplayName = displayName; this.Description = description; @@ -51,14 +66,14 @@ namespace Coscine.ApiClient.Core.Model /// The URI of the graph containing the vocabulary. /// </summary> /// <value>The URI of the graph containing the vocabulary.</value> - [DataMember(Name = "graphUri", EmitDefaultValue = false)] + [DataMember(Name = "graphUri", IsRequired = true, EmitDefaultValue = true)] public string GraphUri { get; set; } /// <summary> /// The URI of the top-level parent class in the vocabulary. /// </summary> /// <value>The URI of the top-level parent class in the vocabulary.</value> - [DataMember(Name = "classUri", EmitDefaultValue = false)] + [DataMember(Name = "classUri", IsRequired = true, EmitDefaultValue = true)] public string ClassUri { get; set; } /// <summary> diff --git a/src/Coscine.ApiClient.Core/Model/VocabularyInstanceDto.cs b/src/Coscine.ApiClient.Core/Model/VocabularyInstanceDto.cs index c0bba9ca14f45a9074d4710cf304c17164aadcc7..08f9b7242f876aad06618a11b456960d537a2feb 100644 --- a/src/Coscine.ApiClient.Core/Model/VocabularyInstanceDto.cs +++ b/src/Coscine.ApiClient.Core/Model/VocabularyInstanceDto.cs @@ -35,7 +35,12 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="VocabularyInstanceDto" /> class. /// </summary> - /// <param name="graphUri">The URI of the graph containing the vocabulary..</param> + [JsonConstructorAttribute] + protected VocabularyInstanceDto() { } + /// <summary> + /// Initializes a new instance of the <see cref="VocabularyInstanceDto" /> class. + /// </summary> + /// <param name="graphUri">The URI of the graph containing the vocabulary. (required).</param> /// <param name="instanceUri">The URI of the instance..</param> /// <param name="typeUri">The URI representing the type of the instance..</param> /// <param name="subClassOfUri">The URI of the direct parent class..</param> @@ -43,6 +48,11 @@ namespace Coscine.ApiClient.Core.Model /// <param name="description">The description of the vocabulary instance..</param> public VocabularyInstanceDto(string graphUri = default(string), string instanceUri = default(string), string typeUri = default(string), string subClassOfUri = default(string), string displayName = default(string), string description = default(string)) { + // to ensure "graphUri" is required (not null) + if (graphUri == null) + { + throw new ArgumentNullException("graphUri is a required property for VocabularyInstanceDto and cannot be null"); + } this.GraphUri = graphUri; this.InstanceUri = instanceUri; this.TypeUri = typeUri; @@ -55,7 +65,7 @@ namespace Coscine.ApiClient.Core.Model /// The URI of the graph containing the vocabulary. /// </summary> /// <value>The URI of the graph containing the vocabulary.</value> - [DataMember(Name = "graphUri", EmitDefaultValue = false)] + [DataMember(Name = "graphUri", IsRequired = true, EmitDefaultValue = true)] public string GraphUri { get; set; } /// <summary>