diff --git a/README.md b/README.md index b0a62a64319e7a5b1075aaea6c3ff4a208d16cf0..6831f586fdf625e9315ad6c3776438ad5878dc89 100644 --- a/README.md +++ b/README.md @@ -120,8 +120,9 @@ Class | Method | HTTP request | Description *AdminApi* | [**GetAllProjects**](docs/AdminApi.md#getallprojects) | **GET** /api/v2/admin/projects | Retrieves all projects. *AdminApi* | [**GetAllResources**](docs/AdminApi.md#getallresources) | **GET** /api/v2/admin/resources | Retrieves all resources. *AdminApi* | [**GetAllUsers**](docs/AdminApi.md#getallusers) | **GET** /api/v2/admin/users | Retrieves all users. -*AdminApi* | [**GetMetadataGraph**](docs/AdminApi.md#getmetadatagraph) | **GET** /api/v2/admin/metadata | Gets a metadata graph. -*AdminApi* | [**UpdateMetadataGraph**](docs/AdminApi.md#updatemetadatagraph) | **PUT** /api/v2/admin/metadata | Updates a metadata graph. +*AdminApi* | [**GetMetadataGraph**](docs/AdminApi.md#getmetadatagraph) | **GET** /api/v2/admin/metadata/{graph} | Gets a metadata graph. +*AdminApi* | [**PatchMetadata**](docs/AdminApi.md#patchmetadata) | **PATCH** /api/v2/admin/metadata/{graph} | Patches a metadata graph. +*AdminApi* | [**UpdateMetadataGraph**](docs/AdminApi.md#updatemetadatagraph) | **PUT** /api/v2/admin/metadata/{graph} | Updates a metadata graph. *ApplicationProfileApi* | [**ApiV2ApplicationProfilesOptions**](docs/ApplicationProfileApi.md#apiv2applicationprofilesoptions) | **OPTIONS** /api/v2/application-profiles | Responds with the HTTP methods allowed for the endpoint. *ApplicationProfileApi* | [**CreateApplicationProfileRequest**](docs/ApplicationProfileApi.md#createapplicationprofilerequest) | **POST** /api/v2/application-profiles/requests | Submits a request to create a new application profile. *ApplicationProfileApi* | [**GetApplicationProfile**](docs/ApplicationProfileApi.md#getapplicationprofile) | **GET** /api/v2/application-profiles/profiles/{profile} | Retrieves an application profile by its URI. @@ -247,6 +248,9 @@ Class | Method | HTTP request | Description - [Model.DisciplineForProjectManipulationDto](docs/DisciplineForProjectManipulationDto.md) - [Model.DisciplineForResourceManipulationDto](docs/DisciplineForResourceManipulationDto.md) - [Model.DisciplineForUserManipulationDto](docs/DisciplineForUserManipulationDto.md) + - [Model.FileActionDto](docs/FileActionDto.md) + - [Model.FileActionHttpMethod](docs/FileActionHttpMethod.md) + - [Model.FileActionsDto](docs/FileActionsDto.md) - [Model.FileTreeDto](docs/FileTreeDto.md) - [Model.FileTreeDtoPagedResponse](docs/FileTreeDtoPagedResponse.md) - [Model.FixedValueForResourceManipulationDto](docs/FixedValueForResourceManipulationDto.md) @@ -261,7 +265,7 @@ Class | Method | HTTP request | Description - [Model.IdentityProviderDto](docs/IdentityProviderDto.md) - [Model.IdentityProviders](docs/IdentityProviders.md) - [Model.LanguageDto](docs/LanguageDto.md) - - [Model.LanguageDtoPagedResponse](docs/LanguageDtoPagedResponse.md) + - [Model.LanguageDtoIEnumerableResponse](docs/LanguageDtoIEnumerableResponse.md) - [Model.LanguageDtoResponse](docs/LanguageDtoResponse.md) - [Model.LanguageForUserManipulationDto](docs/LanguageForUserManipulationDto.md) - [Model.LicenseDto](docs/LicenseDto.md) @@ -318,6 +322,9 @@ Class | Method | HTTP request | Description - [Model.RdfDefinitionDtoResponse](docs/RdfDefinitionDtoResponse.md) - [Model.RdfDefinitionForManipulationDto](docs/RdfDefinitionForManipulationDto.md) - [Model.RdfFormat](docs/RdfFormat.md) + - [Model.RdfPatchDocumentDto](docs/RdfPatchDocumentDto.md) + - [Model.RdfPatchOperationDto](docs/RdfPatchOperationDto.md) + - [Model.RdfPatchOperationType](docs/RdfPatchOperationType.md) - [Model.RdsOptionsDto](docs/RdsOptionsDto.md) - [Model.RdsResourceTypeOptionsForManipulationDto](docs/RdsResourceTypeOptionsForManipulationDto.md) - [Model.RdsS3OptionsDto](docs/RdsS3OptionsDto.md) @@ -359,7 +366,7 @@ Class | Method | HTTP request | Description - [Model.TermsOfServiceDto](docs/TermsOfServiceDto.md) - [Model.TermsOfServiceDtoResponse](docs/TermsOfServiceDtoResponse.md) - [Model.TitleDto](docs/TitleDto.md) - - [Model.TitleDtoPagedResponse](docs/TitleDtoPagedResponse.md) + - [Model.TitleDtoIEnumerableResponse](docs/TitleDtoIEnumerableResponse.md) - [Model.TitleDtoResponse](docs/TitleDtoResponse.md) - [Model.TitleForUserManipulationDto](docs/TitleForUserManipulationDto.md) - [Model.TreeDataType](docs/TreeDataType.md) diff --git a/generate-api-client.bat b/generate-api-client.bat deleted file mode 100644 index 9fb1d185b84904c3c49d541eace7046bfd1f99eb..0000000000000000000000000000000000000000 --- a/generate-api-client.bat +++ /dev/null @@ -1,31 +0,0 @@ -@echo off -SET GENERATOR_JAR=openapi-generator-cli.jar -SET API_SPEC_URL=C:\Users\hp-admin\repos\backend\apis\coscine\src\Coscine.Api\open-api-internal.yml -SET OUTPUT_DIR=temp -SET ARTIFACT_ID=Coscine.ApiClient.Core -SET PACKAGE_NAME=Coscine.ApiClient.Core - -:: Download the OpenAPI generator JAR file -powershell -Command "Invoke-WebRequest -OutFile %GENERATOR_JAR% https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.0.1/openapi-generator-cli-7.0.1.jar" - -:: Run the OpenAPI generator -java -jar %GENERATOR_JAR% generate -i %API_SPEC_URL% -g csharp -o %OUTPUT_DIR% --artifact-id %ARTIFACT_ID% --package-name %PACKAGE_NAME% --skip-validate-spec - -echo API client generation complete. - -:: Delete the current API client source -rd /s /q src\%PACKAGE_NAME% -rd /s /q src\%PACKAGE_NAME%.Test - -:: Copy the generated API client source to the src directory -xcopy /E /I temp\src\%PACKAGE_NAME% src\%PACKAGE_NAME% -xcopy /E /I temp\src\%PACKAGE_NAME%.Test src\%PACKAGE_NAME%.Test - -:: Replace the README.md file -copy /Y temp\README.md README.md - -:: Remove the temp directory and the generator JAR file -rd /s /q temp -del /f /q %GENERATOR_JAR% - -echo Cleanup complete. diff --git a/generate-api-client.sh b/generate-api-client.sh new file mode 100644 index 0000000000000000000000000000000000000000..50f5147b4620036fce0b1a5bc3f313bb198be8c0 --- /dev/null +++ b/generate-api-client.sh @@ -0,0 +1,60 @@ +#!/bin/bash + +# -------------------------------------------------------------------------------------------------------------------------------------------------------------------- +# Generate C# API Client using OpenAPI Generator: +# -------------------------------------------------------------------------------------------------------------------------------------------------------------------- +# This script generates a C# API client based on the OpenAPI specification. +# +# The actions performed are: +# - Downloading the OpenAPI generator CLI tool. +# - Generating the API client code. +# - Deleting existing API client source files. +# - Copying the newly generated API client source to the project directory. +# - Replacing the README.md file. +# - Cleaning up temporary files and the downloaded tool. +# +# Defined variables: +GENERATOR_URL="https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.0.1/openapi-generator-cli-7.0.1.jar" # URL to the OpenAPI generator JAR file +GENERATOR_JAR="openapi-generator-cli.jar" # The name of the OpenAPI generator JAR file +OUTPUT_DIR="temp" # The temporary directory for generated files +ARTIFACT_ID="Coscine.ApiClient.Core" # The artifact ID for the API client +PACKAGE_NAME="Coscine.ApiClient.Core" # The package name for the API client +API_SPEC_URL="../../apis/coscine/src/Coscine.Api/open-api-internal.yml" # URL to the OpenAPI spec file +# -------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +# ANSI color codes for styling +GREEN='\033[0;32m' +YELLOW='\033[0;33m' +CYAN='\033[0;36m' +NC='\033[0m' # No Color + +# Download the OpenAPI generator JAR file +echo -e "${CYAN}Downloading the OpenAPI generator JAR file...${NC}" +curl -o "$GENERATOR_JAR" "$GENERATOR_URL" + +# Run the OpenAPI generator +echo -e "${CYAN}Running the OpenAPI generator...${NC}" +java -jar "$GENERATOR_JAR" generate -i "$API_SPEC_URL" -g csharp -o "$OUTPUT_DIR" --artifact-id "$ARTIFACT_ID" --package-name "$PACKAGE_NAME" --skip-validate-spec --server-variables=host=localhost:7206,basePath=coscine + +echo -e "${GREEN}API client generation complete.${NC}" + +# Delete the current API client source +echo -e "${YELLOW}Deleting current API client source...${NC}" +rm -rf "src/$PACKAGE_NAME" +rm -rf "src/${PACKAGE_NAME}.Test" + +# Copy the generated API client source to the src directory +echo -e "${CYAN}Copying generated API client source to src directory...${NC}" +cp -R "$OUTPUT_DIR/src/$PACKAGE_NAME" "src/$PACKAGE_NAME" +cp -R "$OUTPUT_DIR/src/${PACKAGE_NAME}.Test" "src/${PACKAGE_NAME}.Test" + +# Replace the README.md file +echo -e "\n${CYAN}Replacing README.md file...${NC}" +cp "$OUTPUT_DIR/README.md" "README.md" + +# Remove the temp directory and the generator JAR file +echo -e "${YELLOW}Cleaning up...${NC}" +rm -rf "$OUTPUT_DIR" +rm -f "$GENERATOR_JAR" + +echo -e "${GREEN}Finished.${NC}" diff --git a/src/Coscine.ApiClient.Core.Test/Api/AdminApiTests.cs b/src/Coscine.ApiClient.Core.Test/Api/AdminApiTests.cs index 9d9fe39e18a8333e4cdb303f8fd44e00c43ddb3c..28aaad54953a2df621f9ccc73e5f2fbd3b02d665 100644 --- a/src/Coscine.ApiClient.Core.Test/Api/AdminApiTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Api/AdminApiTests.cs @@ -75,10 +75,10 @@ namespace Coscine.ApiClient.Core.Test.Api //bool? topLevel = null; //bool? includeDeleted = null; //bool? includeQuotas = null; - //int? pageNumber = null; //int? pageSize = null; + //int? pageNumber = null; //string? orderBy = null; - //var response = instance.GetAllProjects(topLevel, includeDeleted, includeQuotas, pageNumber, pageSize, orderBy); + //var response = instance.GetAllProjects(topLevel, includeDeleted, includeQuotas, pageSize, pageNumber, orderBy); //Assert.IsType<ProjectAdminDtoPagedResponse>(response); } @@ -90,10 +90,11 @@ namespace Coscine.ApiClient.Core.Test.Api { // TODO uncomment below to test the method and replace null with proper value //bool? includeDeleted = null; - //int? pageNumber = null; + //bool? includeQuotas = null; //int? pageSize = null; + //int? pageNumber = null; //string? orderBy = null; - //var response = instance.GetAllResources(includeDeleted, pageNumber, pageSize, orderBy); + //var response = instance.GetAllResources(includeDeleted, includeQuotas, pageSize, pageNumber, orderBy); //Assert.IsType<ResourceAdminDtoPagedResponse>(response); } @@ -104,11 +105,11 @@ namespace Coscine.ApiClient.Core.Test.Api public void GetAllUsersTest() { // TODO uncomment below to test the method and replace null with proper value - //string? orderBy = null; //bool? tosAccepted = null; - //int? pageNumber = null; //int? pageSize = null; - //var response = instance.GetAllUsers(orderBy, tosAccepted, pageNumber, pageSize); + //int? pageNumber = null; + //string? orderBy = null; + //var response = instance.GetAllUsers(tosAccepted, pageSize, pageNumber, orderBy); //Assert.IsType<UserDtoPagedResponse>(response); } @@ -119,12 +120,24 @@ namespace Coscine.ApiClient.Core.Test.Api public void GetMetadataGraphTest() { // TODO uncomment below to test the method and replace null with proper value - //string graphUri = null; + //string graph = null; //RdfFormat? format = null; - //var response = instance.GetMetadataGraph(graphUri, format); + //var response = instance.GetMetadataGraph(graph, format); //Assert.IsType<RdfDefinitionDtoResponse>(response); } + /// <summary> + /// Test PatchMetadata + /// </summary> + [Fact] + public void PatchMetadataTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string graph = null; + //RdfPatchDocumentDto? rdfPatchDocumentDto = null; + //instance.PatchMetadata(graph, rdfPatchDocumentDto); + } + /// <summary> /// Test UpdateMetadataGraph /// </summary> @@ -132,8 +145,9 @@ namespace Coscine.ApiClient.Core.Test.Api public void UpdateMetadataGraphTest() { // TODO uncomment below to test the method and replace null with proper value + //string graph = null; //MetadataUpdateAdminParameters? metadataUpdateAdminParameters = null; - //instance.UpdateMetadataGraph(metadataUpdateAdminParameters); + //instance.UpdateMetadataGraph(graph, metadataUpdateAdminParameters); } } } diff --git a/src/Coscine.ApiClient.Core.Test/Api/ApplicationProfileApiTests.cs b/src/Coscine.ApiClient.Core.Test/Api/ApplicationProfileApiTests.cs index ac6ce8c8e92745561ae57c33d3dfa3ec4580b352..724f3de9f7a3e7b7d1b21cbd8c30edf0d2e3f945 100644 --- a/src/Coscine.ApiClient.Core.Test/Api/ApplicationProfileApiTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Api/ApplicationProfileApiTests.cs @@ -100,10 +100,11 @@ namespace Coscine.ApiClient.Core.Test.Api // TODO uncomment below to test the method and replace null with proper value //string? searchTerm = null; //AcceptedLanguage? language = null; + //bool? modules = null; //int? pageNumber = null; //int? pageSize = null; //string? orderBy = null; - //var response = instance.GetApplicationProfiles(searchTerm, language, pageNumber, pageSize, orderBy); + //var response = instance.GetApplicationProfiles(searchTerm, language, modules, pageNumber, pageSize, orderBy); //Assert.IsType<ApplicationProfileDtoPagedResponse>(response); } diff --git a/src/Coscine.ApiClient.Core.Test/Api/LanguageApiTests.cs b/src/Coscine.ApiClient.Core.Test/Api/LanguageApiTests.cs index ed91475a927a495250ddec79fee040dda4abea2a..ad5a31f452417231c591086e3b272938e0669bed 100644 --- a/src/Coscine.ApiClient.Core.Test/Api/LanguageApiTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Api/LanguageApiTests.cs @@ -88,7 +88,7 @@ namespace Coscine.ApiClient.Core.Test.Api //int? pageSize = null; //string? orderBy = null; //var response = instance.GetLanguages(pageNumber, pageSize, orderBy); - //Assert.IsType<LanguageDtoPagedResponse>(response); + //Assert.IsType<LanguageDtoIEnumerableResponse>(response); } } } diff --git a/src/Coscine.ApiClient.Core.Test/Api/TitleApiTests.cs b/src/Coscine.ApiClient.Core.Test/Api/TitleApiTests.cs index d81e4574ee956bd0bc047ff95e2f342925444636..7740a283e31d6bc7a5b39035a611ca2fb07e53d1 100644 --- a/src/Coscine.ApiClient.Core.Test/Api/TitleApiTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Api/TitleApiTests.cs @@ -88,7 +88,7 @@ namespace Coscine.ApiClient.Core.Test.Api //int? pageSize = null; //string? orderBy = null; //var response = instance.GetTitles(pageNumber, pageSize, orderBy); - //Assert.IsType<TitleDtoPagedResponse>(response); + //Assert.IsType<TitleDtoIEnumerableResponse>(response); } } } diff --git a/src/Coscine.ApiClient.Core.Test/Api/VocabularyApiTests.cs b/src/Coscine.ApiClient.Core.Test/Api/VocabularyApiTests.cs index 0acfc422028e5eabb2860b4360d13a286a405005..c6bf79dce145eb656d427eee2bec05b743483d04 100644 --- a/src/Coscine.ApiClient.Core.Test/Api/VocabularyApiTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Api/VocabularyApiTests.cs @@ -104,10 +104,10 @@ namespace Coscine.ApiClient.Core.Test.Api //string varClass = null; //string? searchTerm = null; //AcceptedLanguage? language = null; - //int? pageNumber = null; //int? pageSize = null; + //int? pageNumber = null; //string? orderBy = null; - //var response = instance.GetVocabularyInstances(varClass, searchTerm, language, pageNumber, pageSize, orderBy); + //var response = instance.GetVocabularyInstances(varClass, searchTerm, language, pageSize, pageNumber, orderBy); //Assert.IsType<VocabularyInstanceDtoPagedResponse>(response); } } 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 7c80484be5e23566f4eb0aae8e9a1dcd188a6117..d3e4cae52fec45fa81432c7886c77d455cda9f50 100644 --- a/src/Coscine.ApiClient.Core.Test/Coscine.ApiClient.Core.Test.csproj +++ b/src/Coscine.ApiClient.Core.Test/Coscine.ApiClient.Core.Test.csproj @@ -1,21 +1,20 @@ <Project Sdk="Microsoft.NET.Sdk"> - <PropertyGroup> - <AssemblyName>Coscine.ApiClient.Core.Test</AssemblyName> - <RootNamespace>Coscine.ApiClient.Core.Test</RootNamespace> - <TargetFramework>net7.0</TargetFramework> - <IsPackable>false</IsPackable> - <Nullable>annotations</Nullable> - <Version>1.2.1</Version> - </PropertyGroup> + <PropertyGroup> + <AssemblyName>Coscine.ApiClient.Core.Test</AssemblyName> + <RootNamespace>Coscine.ApiClient.Core.Test</RootNamespace> + <TargetFramework>net7.0</TargetFramework> + <IsPackable>false</IsPackable> + <Nullable>annotations</Nullable> + </PropertyGroup> - <ItemGroup> - <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.3" /> - <PackageReference Include="xunit" Version="2.5.0" /> - <PackageReference Include="xunit.runner.visualstudio" Version="2.5.0" /> - </ItemGroup> + <ItemGroup> + <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.3" /> + <PackageReference Include="xunit" Version="2.5.0" /> + <PackageReference Include="xunit.runner.visualstudio" Version="2.5.0" /> + </ItemGroup> - <ItemGroup> - <ProjectReference Include="..\Coscine.ApiClient.Core\Coscine.ApiClient.Core.csproj" /> - </ItemGroup> + <ItemGroup> + <ProjectReference Include="..\Coscine.ApiClient.Core\Coscine.ApiClient.Core.csproj" /> + </ItemGroup> </Project> diff --git a/src/Coscine.ApiClient.Core.Test/Model/FileActionDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/FileActionDtoTests.cs new file mode 100644 index 0000000000000000000000000000000000000000..54ce8cfc07628660cebc03797765694c1a9197a1 --- /dev/null +++ b/src/Coscine.ApiClient.Core.Test/Model/FileActionDtoTests.cs @@ -0,0 +1,76 @@ +/* + * Coscine Web API (Internal Use Only) + * + * 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 Xunit; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Coscine.ApiClient.Core.Model; +using Coscine.ApiClient.Core.Client; +using System.Reflection; +using Newtonsoft.Json; + +namespace Coscine.ApiClient.Core.Test.Model +{ + /// <summary> + /// Class for testing FileActionDto + /// </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 FileActionDtoTests : IDisposable + { + // TODO uncomment below to declare an instance variable for FileActionDto + //private FileActionDto instance; + + public FileActionDtoTests() + { + // TODO uncomment below to create an instance of FileActionDto + //instance = new FileActionDto(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// <summary> + /// Test an instance of FileActionDto + /// </summary> + [Fact] + public void FileActionDtoInstanceTest() + { + // TODO uncomment below to test "IsType" FileActionDto + //Assert.IsType<FileActionDto>(instance); + } + + /// <summary> + /// Test the property 'Url' + /// </summary> + [Fact] + public void UrlTest() + { + // TODO unit test for the property 'Url' + } + + /// <summary> + /// Test the property 'Method' + /// </summary> + [Fact] + public void MethodTest() + { + // TODO unit test for the property 'Method' + } + } +} diff --git a/src/Coscine.ApiClient.Core.Test/Model/FileActionHttpMethodTests.cs b/src/Coscine.ApiClient.Core.Test/Model/FileActionHttpMethodTests.cs new file mode 100644 index 0000000000000000000000000000000000000000..3ac218bf3b9dec23858cdf94203f8f8922bdaa2c --- /dev/null +++ b/src/Coscine.ApiClient.Core.Test/Model/FileActionHttpMethodTests.cs @@ -0,0 +1,58 @@ +/* + * Coscine Web API (Internal Use Only) + * + * 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 Xunit; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Coscine.ApiClient.Core.Model; +using Coscine.ApiClient.Core.Client; +using System.Reflection; +using Newtonsoft.Json; + +namespace Coscine.ApiClient.Core.Test.Model +{ + /// <summary> + /// Class for testing FileActionHttpMethod + /// </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 FileActionHttpMethodTests : IDisposable + { + // TODO uncomment below to declare an instance variable for FileActionHttpMethod + //private FileActionHttpMethod instance; + + public FileActionHttpMethodTests() + { + // TODO uncomment below to create an instance of FileActionHttpMethod + //instance = new FileActionHttpMethod(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// <summary> + /// Test an instance of FileActionHttpMethod + /// </summary> + [Fact] + public void FileActionHttpMethodInstanceTest() + { + // TODO uncomment below to test "IsType" FileActionHttpMethod + //Assert.IsType<FileActionHttpMethod>(instance); + } + } +} diff --git a/src/Coscine.ApiClient.Core.Test/Model/FileActionsDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/FileActionsDtoTests.cs new file mode 100644 index 0000000000000000000000000000000000000000..ca0b83e8154e296ebc51c8bb226314d2455ddb2e --- /dev/null +++ b/src/Coscine.ApiClient.Core.Test/Model/FileActionsDtoTests.cs @@ -0,0 +1,67 @@ +/* + * Coscine Web API (Internal Use Only) + * + * 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 Xunit; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Coscine.ApiClient.Core.Model; +using Coscine.ApiClient.Core.Client; +using System.Reflection; +using Newtonsoft.Json; + +namespace Coscine.ApiClient.Core.Test.Model +{ + /// <summary> + /// Class for testing FileActionsDto + /// </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 FileActionsDtoTests : IDisposable + { + // TODO uncomment below to declare an instance variable for FileActionsDto + //private FileActionsDto instance; + + public FileActionsDtoTests() + { + // TODO uncomment below to create an instance of FileActionsDto + //instance = new FileActionsDto(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// <summary> + /// Test an instance of FileActionsDto + /// </summary> + [Fact] + public void FileActionsDtoInstanceTest() + { + // TODO uncomment below to test "IsType" FileActionsDto + //Assert.IsType<FileActionsDto>(instance); + } + + /// <summary> + /// Test the property 'Download' + /// </summary> + [Fact] + public void DownloadTest() + { + // TODO unit test for the property 'Download' + } + } +} diff --git a/src/Coscine.ApiClient.Core.Test/Model/FileTreeDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/FileTreeDtoTests.cs index 8215401448dd5eaf514639a9941f6cbe7b6074c4..cf31ca059c02894f52f88d7bdcf31dc323d20c3b 100644 --- a/src/Coscine.ApiClient.Core.Test/Model/FileTreeDtoTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Model/FileTreeDtoTests.cs @@ -126,5 +126,14 @@ namespace Coscine.ApiClient.Core.Test.Model { // TODO unit test for the property 'ChangeDate' } + + /// <summary> + /// Test the property 'Actions' + /// </summary> + [Fact] + public void ActionsTest() + { + // TODO unit test for the property 'Actions' + } } } diff --git a/src/Coscine.ApiClient.Core.Test/Model/FixedValueForResourceManipulationDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/FixedValueForResourceManipulationDtoTests.cs index 0f90a0ec3fb185740eb777efa66fdbfc7e7dbb75..59ce6e8a1780e795e5fdf0bb80fc239acc7748a4 100644 --- a/src/Coscine.ApiClient.Core.Test/Model/FixedValueForResourceManipulationDtoTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Model/FixedValueForResourceManipulationDtoTests.cs @@ -81,5 +81,14 @@ namespace Coscine.ApiClient.Core.Test.Model { // TODO unit test for the property 'Datatype' } + + /// <summary> + /// Test the property 'TargetClass' + /// </summary> + [Fact] + public void TargetClassTest() + { + // TODO unit test for the property 'TargetClass' + } } } diff --git a/src/Coscine.ApiClient.Core.Test/Model/LanguageDtoPagedResponseTests.cs b/src/Coscine.ApiClient.Core.Test/Model/LanguageDtoIEnumerableResponseTests.cs similarity index 74% rename from src/Coscine.ApiClient.Core.Test/Model/LanguageDtoPagedResponseTests.cs rename to src/Coscine.ApiClient.Core.Test/Model/LanguageDtoIEnumerableResponseTests.cs index 789420727b5f4c9bb757c09dd039aa0f81144a2c..00ccce1813e2b7ddc73fabb2da457d0c66e24786 100644 --- a/src/Coscine.ApiClient.Core.Test/Model/LanguageDtoPagedResponseTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Model/LanguageDtoIEnumerableResponseTests.cs @@ -23,21 +23,21 @@ using Newtonsoft.Json; namespace Coscine.ApiClient.Core.Test.Model { /// <summary> - /// Class for testing LanguageDtoPagedResponse + /// Class for testing LanguageDtoIEnumerableResponse /// </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 LanguageDtoPagedResponseTests : IDisposable + public class LanguageDtoIEnumerableResponseTests : IDisposable { - // TODO uncomment below to declare an instance variable for LanguageDtoPagedResponse - //private LanguageDtoPagedResponse instance; + // TODO uncomment below to declare an instance variable for LanguageDtoIEnumerableResponse + //private LanguageDtoIEnumerableResponse instance; - public LanguageDtoPagedResponseTests() + public LanguageDtoIEnumerableResponseTests() { - // TODO uncomment below to create an instance of LanguageDtoPagedResponse - //instance = new LanguageDtoPagedResponse(); + // TODO uncomment below to create an instance of LanguageDtoIEnumerableResponse + //instance = new LanguageDtoIEnumerableResponse(); } public void Dispose() @@ -46,13 +46,13 @@ namespace Coscine.ApiClient.Core.Test.Model } /// <summary> - /// Test an instance of LanguageDtoPagedResponse + /// Test an instance of LanguageDtoIEnumerableResponse /// </summary> [Fact] - public void LanguageDtoPagedResponseInstanceTest() + public void LanguageDtoIEnumerableResponseInstanceTest() { - // TODO uncomment below to test "IsType" LanguageDtoPagedResponse - //Assert.IsType<LanguageDtoPagedResponse>(instance); + // TODO uncomment below to test "IsType" LanguageDtoIEnumerableResponse + //Assert.IsType<LanguageDtoIEnumerableResponse>(instance); } /// <summary> @@ -90,14 +90,5 @@ namespace Coscine.ApiClient.Core.Test.Model { // TODO unit test for the property 'TraceId' } - - /// <summary> - /// Test the property 'Pagination' - /// </summary> - [Fact] - public void PaginationTest() - { - // TODO unit test for the property 'Pagination' - } } } diff --git a/src/Coscine.ApiClient.Core.Test/Model/MetadataUpdateAdminParametersTests.cs b/src/Coscine.ApiClient.Core.Test/Model/MetadataUpdateAdminParametersTests.cs index b247656c1893264fb3bc80335633a95b085aac07..01bebc28186edf9ce486e056fa2ea31079be8216 100644 --- a/src/Coscine.ApiClient.Core.Test/Model/MetadataUpdateAdminParametersTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Model/MetadataUpdateAdminParametersTests.cs @@ -55,15 +55,6 @@ namespace Coscine.ApiClient.Core.Test.Model //Assert.IsType<MetadataUpdateAdminParameters>(instance); } - /// <summary> - /// Test the property 'GraphUri' - /// </summary> - [Fact] - public void GraphUriTest() - { - // TODO unit test for the property 'GraphUri' - } - /// <summary> /// Test the property 'Definition' /// </summary> diff --git a/src/Coscine.ApiClient.Core.Test/Model/ProjectForCreationDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/ProjectForCreationDtoTests.cs index bffe05297f55e057c4adf684014e9570c1342eea..47fb0999f566f257ae92ddeef66d6823dc96a7f8 100644 --- a/src/Coscine.ApiClient.Core.Test/Model/ProjectForCreationDtoTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Model/ProjectForCreationDtoTests.cs @@ -162,5 +162,14 @@ namespace Coscine.ApiClient.Core.Test.Model { // TODO unit test for the property 'ParentId' } + + /// <summary> + /// Test the property 'CopyOwnersFromParent' + /// </summary> + [Fact] + public void CopyOwnersFromParentTest() + { + // TODO unit test for the property 'CopyOwnersFromParent' + } } } diff --git a/src/Coscine.ApiClient.Core.Test/Model/RdfPatchDocumentDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/RdfPatchDocumentDtoTests.cs new file mode 100644 index 0000000000000000000000000000000000000000..0cfc83eb81d50d1b72d0cdb7dc155e27d953bc4f --- /dev/null +++ b/src/Coscine.ApiClient.Core.Test/Model/RdfPatchDocumentDtoTests.cs @@ -0,0 +1,67 @@ +/* + * Coscine Web API (Internal Use Only) + * + * 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 Xunit; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Coscine.ApiClient.Core.Model; +using Coscine.ApiClient.Core.Client; +using System.Reflection; +using Newtonsoft.Json; + +namespace Coscine.ApiClient.Core.Test.Model +{ + /// <summary> + /// Class for testing RdfPatchDocumentDto + /// </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 RdfPatchDocumentDtoTests : IDisposable + { + // TODO uncomment below to declare an instance variable for RdfPatchDocumentDto + //private RdfPatchDocumentDto instance; + + public RdfPatchDocumentDtoTests() + { + // TODO uncomment below to create an instance of RdfPatchDocumentDto + //instance = new RdfPatchDocumentDto(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// <summary> + /// Test an instance of RdfPatchDocumentDto + /// </summary> + [Fact] + public void RdfPatchDocumentDtoInstanceTest() + { + // TODO uncomment below to test "IsType" RdfPatchDocumentDto + //Assert.IsType<RdfPatchDocumentDto>(instance); + } + + /// <summary> + /// Test the property 'Operations' + /// </summary> + [Fact] + public void OperationsTest() + { + // TODO unit test for the property 'Operations' + } + } +} diff --git a/src/Coscine.ApiClient.Core.Test/Model/RdfPatchOperationDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/RdfPatchOperationDtoTests.cs new file mode 100644 index 0000000000000000000000000000000000000000..47c75263637b9f6fd868d52c3423664edfcebc5c --- /dev/null +++ b/src/Coscine.ApiClient.Core.Test/Model/RdfPatchOperationDtoTests.cs @@ -0,0 +1,76 @@ +/* + * Coscine Web API (Internal Use Only) + * + * 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 Xunit; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Coscine.ApiClient.Core.Model; +using Coscine.ApiClient.Core.Client; +using System.Reflection; +using Newtonsoft.Json; + +namespace Coscine.ApiClient.Core.Test.Model +{ + /// <summary> + /// Class for testing RdfPatchOperationDto + /// </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 RdfPatchOperationDtoTests : IDisposable + { + // TODO uncomment below to declare an instance variable for RdfPatchOperationDto + //private RdfPatchOperationDto instance; + + public RdfPatchOperationDtoTests() + { + // TODO uncomment below to create an instance of RdfPatchOperationDto + //instance = new RdfPatchOperationDto(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// <summary> + /// Test an instance of RdfPatchOperationDto + /// </summary> + [Fact] + public void RdfPatchOperationDtoInstanceTest() + { + // TODO uncomment below to test "IsType" RdfPatchOperationDto + //Assert.IsType<RdfPatchOperationDto>(instance); + } + + /// <summary> + /// Test the property 'OperationType' + /// </summary> + [Fact] + public void OperationTypeTest() + { + // TODO unit test for the property 'OperationType' + } + + /// <summary> + /// Test the property 'Changes' + /// </summary> + [Fact] + public void ChangesTest() + { + // TODO unit test for the property 'Changes' + } + } +} diff --git a/src/Coscine.ApiClient.Core.Test/Model/RdfPatchOperationTypeTests.cs b/src/Coscine.ApiClient.Core.Test/Model/RdfPatchOperationTypeTests.cs new file mode 100644 index 0000000000000000000000000000000000000000..27f53d1ec723cdc1c18f199d65ebf19ec2262cd8 --- /dev/null +++ b/src/Coscine.ApiClient.Core.Test/Model/RdfPatchOperationTypeTests.cs @@ -0,0 +1,58 @@ +/* + * Coscine Web API (Internal Use Only) + * + * 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 Xunit; + +using System; +using System.Linq; +using System.IO; +using System.Collections.Generic; +using Coscine.ApiClient.Core.Model; +using Coscine.ApiClient.Core.Client; +using System.Reflection; +using Newtonsoft.Json; + +namespace Coscine.ApiClient.Core.Test.Model +{ + /// <summary> + /// Class for testing RdfPatchOperationType + /// </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 RdfPatchOperationTypeTests : IDisposable + { + // TODO uncomment below to declare an instance variable for RdfPatchOperationType + //private RdfPatchOperationType instance; + + public RdfPatchOperationTypeTests() + { + // TODO uncomment below to create an instance of RdfPatchOperationType + //instance = new RdfPatchOperationType(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// <summary> + /// Test an instance of RdfPatchOperationType + /// </summary> + [Fact] + public void RdfPatchOperationTypeInstanceTest() + { + // TODO uncomment below to test "IsType" RdfPatchOperationType + //Assert.IsType<RdfPatchOperationType>(instance); + } + } +} diff --git a/src/Coscine.ApiClient.Core.Test/Model/ResourceAdminDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/ResourceAdminDtoTests.cs index cdab8ede42aabf280f49e0d762e730adcbb3a837..ca708876b31da9a3bdf41d65177bb7d7569640ce 100644 --- a/src/Coscine.ApiClient.Core.Test/Model/ResourceAdminDtoTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Model/ResourceAdminDtoTests.cs @@ -216,5 +216,14 @@ namespace Coscine.ApiClient.Core.Test.Model { // TODO unit test for the property 'ProjectResources' } + + /// <summary> + /// Test the property 'ResourceQuota' + /// </summary> + [Fact] + public void ResourceQuotaTest() + { + // TODO unit test for the property 'ResourceQuota' + } } } diff --git a/src/Coscine.ApiClient.Core.Test/Model/TitleDtoPagedResponseTests.cs b/src/Coscine.ApiClient.Core.Test/Model/TitleDtoIEnumerableResponseTests.cs similarity index 73% rename from src/Coscine.ApiClient.Core.Test/Model/TitleDtoPagedResponseTests.cs rename to src/Coscine.ApiClient.Core.Test/Model/TitleDtoIEnumerableResponseTests.cs index d9c2b4bf5de15b301ee067feb72c1600e849523f..de3b7a53cb12cd3d5a1d3cabd718904309ccb003 100644 --- a/src/Coscine.ApiClient.Core.Test/Model/TitleDtoPagedResponseTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Model/TitleDtoIEnumerableResponseTests.cs @@ -23,21 +23,21 @@ using Newtonsoft.Json; namespace Coscine.ApiClient.Core.Test.Model { /// <summary> - /// Class for testing TitleDtoPagedResponse + /// Class for testing TitleDtoIEnumerableResponse /// </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 TitleDtoPagedResponseTests : IDisposable + public class TitleDtoIEnumerableResponseTests : IDisposable { - // TODO uncomment below to declare an instance variable for TitleDtoPagedResponse - //private TitleDtoPagedResponse instance; + // TODO uncomment below to declare an instance variable for TitleDtoIEnumerableResponse + //private TitleDtoIEnumerableResponse instance; - public TitleDtoPagedResponseTests() + public TitleDtoIEnumerableResponseTests() { - // TODO uncomment below to create an instance of TitleDtoPagedResponse - //instance = new TitleDtoPagedResponse(); + // TODO uncomment below to create an instance of TitleDtoIEnumerableResponse + //instance = new TitleDtoIEnumerableResponse(); } public void Dispose() @@ -46,13 +46,13 @@ namespace Coscine.ApiClient.Core.Test.Model } /// <summary> - /// Test an instance of TitleDtoPagedResponse + /// Test an instance of TitleDtoIEnumerableResponse /// </summary> [Fact] - public void TitleDtoPagedResponseInstanceTest() + public void TitleDtoIEnumerableResponseInstanceTest() { - // TODO uncomment below to test "IsType" TitleDtoPagedResponse - //Assert.IsType<TitleDtoPagedResponse>(instance); + // TODO uncomment below to test "IsType" TitleDtoIEnumerableResponse + //Assert.IsType<TitleDtoIEnumerableResponse>(instance); } /// <summary> @@ -90,14 +90,5 @@ namespace Coscine.ApiClient.Core.Test.Model { // TODO unit test for the property 'TraceId' } - - /// <summary> - /// Test the property 'Pagination' - /// </summary> - [Fact] - public void PaginationTest() - { - // TODO unit test for the property 'Pagination' - } } } diff --git a/src/Coscine.ApiClient.Core.Test/Model/UserDtoTests.cs b/src/Coscine.ApiClient.Core.Test/Model/UserDtoTests.cs index 6a4b843ce1f6e037bd416b73fb323a4b785ceba5..3bf1acc6e49ef0f06d11590704b266efdc2cfe2f 100644 --- a/src/Coscine.ApiClient.Core.Test/Model/UserDtoTests.cs +++ b/src/Coscine.ApiClient.Core.Test/Model/UserDtoTests.cs @@ -127,6 +127,15 @@ namespace Coscine.ApiClient.Core.Test.Model // TODO unit test for the property 'AreToSAccepted' } + /// <summary> + /// Test the property 'LatestActivity' + /// </summary> + [Fact] + public void LatestActivityTest() + { + // TODO unit test for the property 'LatestActivity' + } + /// <summary> /// Test the property 'Disciplines' /// </summary> diff --git a/src/Coscine.ApiClient.Core/Api/AdminApi.cs b/src/Coscine.ApiClient.Core/Api/AdminApi.cs index 88375b91033fc5bdb0e3abcd4d6ea10b79bb33b9..fa5fbef25720768e3cddafef1018c807c06c221f 100644 --- a/src/Coscine.ApiClient.Core/Api/AdminApi.cs +++ b/src/Coscine.ApiClient.Core/Api/AdminApi.cs @@ -49,15 +49,15 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all projects. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="includeQuotas"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to filter top-level projects. (optional)</param> + /// <param name="includeDeleted">Gets or sets a value indicating whether to include deleted projects in the results. (optional)</param> + /// <param name="includeQuotas">Gets or sets a value indicating whether to include quotas in the results. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ProjectAdminDtoPagedResponse</returns> - ProjectAdminDtoPagedResponse GetAllProjects(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); + ProjectAdminDtoPagedResponse GetAllProjects(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0); /// <summary> /// Retrieves all projects. @@ -66,26 +66,27 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="includeQuotas"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to filter top-level projects. (optional)</param> + /// <param name="includeDeleted">Gets or sets a value indicating whether to include deleted projects in the results. (optional)</param> + /// <param name="includeQuotas">Gets or sets a value indicating whether to include quotas in the results. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ProjectAdminDtoPagedResponse</returns> - ApiResponse<ProjectAdminDtoPagedResponse> GetAllProjectsWithHttpInfo(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); + ApiResponse<ProjectAdminDtoPagedResponse> GetAllProjectsWithHttpInfo(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0); /// <summary> /// Retrieves all resources. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="includeDeleted">Value indicating whether to include deleted resources. (optional)</param> + /// <param name="includeQuotas">Value indicating whether to include individual resource quotas. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ResourceAdminDtoPagedResponse</returns> - ResourceAdminDtoPagedResponse GetAllResources(bool? includeDeleted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); + ResourceAdminDtoPagedResponse GetAllResources(bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0); /// <summary> /// Retrieves all resources. @@ -94,24 +95,25 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="includeDeleted">Value indicating whether to include deleted resources. (optional)</param> + /// <param name="includeQuotas">Value indicating whether to include individual resource quotas. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ResourceAdminDtoPagedResponse</returns> - ApiResponse<ResourceAdminDtoPagedResponse> GetAllResourcesWithHttpInfo(bool? includeDeleted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); + ApiResponse<ResourceAdminDtoPagedResponse> GetAllResourcesWithHttpInfo(bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0); /// <summary> /// Retrieves all users. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="orderBy"> (optional)</param> - /// <param name="tosAccepted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> + /// <param name="tosAccepted">Gets or sets a value indicating whether the terms of service have been accepted by the user. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>UserDtoPagedResponse</returns> - UserDtoPagedResponse GetAllUsers(string? orderBy = default(string?), bool? tosAccepted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), int operationIndex = 0); + UserDtoPagedResponse GetAllUsers(bool? tosAccepted = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0); /// <summary> /// Retrieves all users. @@ -120,22 +122,22 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="orderBy"> (optional)</param> - /// <param name="tosAccepted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> + /// <param name="tosAccepted">Gets or sets a value indicating whether the terms of service have been accepted by the user. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of UserDtoPagedResponse</returns> - ApiResponse<UserDtoPagedResponse> GetAllUsersWithHttpInfo(string? orderBy = default(string?), bool? tosAccepted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), int operationIndex = 0); + ApiResponse<UserDtoPagedResponse> GetAllUsersWithHttpInfo(bool? tosAccepted = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0); /// <summary> /// Gets a metadata graph. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="graphUri"></param> - /// <param name="format"> (optional)</param> + /// <param name="graph">The absolute URI of the graph to get.</param> + /// <param name="format">Gets or sets the RDF format. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>RdfDefinitionDtoResponse</returns> - RdfDefinitionDtoResponse GetMetadataGraph(string graphUri, RdfFormat? format = default(RdfFormat?), int operationIndex = 0); + RdfDefinitionDtoResponse GetMetadataGraph(string graph, RdfFormat? format = default(RdfFormat?), int operationIndex = 0); /// <summary> /// Gets a metadata graph. @@ -144,19 +146,42 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="graphUri"></param> - /// <param name="format"> (optional)</param> + /// <param name="graph">The absolute URI of the graph to get.</param> + /// <param name="format">Gets or sets the RDF format. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of RdfDefinitionDtoResponse</returns> - ApiResponse<RdfDefinitionDtoResponse> GetMetadataGraphWithHttpInfo(string graphUri, RdfFormat? format = default(RdfFormat?), int operationIndex = 0); + ApiResponse<RdfDefinitionDtoResponse> GetMetadataGraphWithHttpInfo(string graph, RdfFormat? format = default(RdfFormat?), int operationIndex = 0); + /// <summary> + /// Patches a metadata graph. + /// </summary> + /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to patch.</param> + /// <param name="rdfPatchDocumentDto">The well-formed RDF patch document containing the changes as operations to be applied to the graph. (optional)</param> + /// <param name="operationIndex">Index associated with the operation.</param> + /// <returns></returns> + void PatchMetadata(string graph, RdfPatchDocumentDto? rdfPatchDocumentDto = default(RdfPatchDocumentDto?), int operationIndex = 0); + + /// <summary> + /// Patches a metadata graph. + /// </summary> + /// <remarks> + /// + /// </remarks> + /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to patch.</param> + /// <param name="rdfPatchDocumentDto">The well-formed RDF patch document containing the changes as operations to be applied to the graph. (optional)</param> + /// <param name="operationIndex">Index associated with the operation.</param> + /// <returns>ApiResponse of Object(void)</returns> + ApiResponse<Object> PatchMetadataWithHttpInfo(string graph, RdfPatchDocumentDto? rdfPatchDocumentDto = default(RdfPatchDocumentDto?), int operationIndex = 0); /// <summary> /// Updates a metadata graph. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to update.</param> /// <param name="metadataUpdateAdminParameters">The metadata update admin parameters. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns></returns> - void UpdateMetadataGraph(MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0); + void UpdateMetadataGraph(string graph, MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0); /// <summary> /// Updates a metadata graph. @@ -165,10 +190,11 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to update.</param> /// <param name="metadataUpdateAdminParameters">The metadata update admin parameters. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of Object(void)</returns> - ApiResponse<Object> UpdateMetadataGraphWithHttpInfo(MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0); + ApiResponse<Object> UpdateMetadataGraphWithHttpInfo(string graph, MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0); #endregion Synchronous Operations } @@ -208,16 +234,16 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="includeQuotas"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to filter top-level projects. (optional)</param> + /// <param name="includeDeleted">Gets or sets a value indicating whether to include deleted projects in the results. (optional)</param> + /// <param name="includeQuotas">Gets or sets a value indicating whether to include quotas in the results. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ProjectAdminDtoPagedResponse</returns> - System.Threading.Tasks.Task<ProjectAdminDtoPagedResponse> GetAllProjectsAsync(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<ProjectAdminDtoPagedResponse> GetAllProjectsAsync(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Retrieves all projects. @@ -226,16 +252,16 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="includeQuotas"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to filter top-level projects. (optional)</param> + /// <param name="includeDeleted">Gets or sets a value indicating whether to include deleted projects in the results. (optional)</param> + /// <param name="includeQuotas">Gets or sets a value indicating whether to include quotas in the results. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ProjectAdminDtoPagedResponse)</returns> - System.Threading.Tasks.Task<ApiResponse<ProjectAdminDtoPagedResponse>> GetAllProjectsWithHttpInfoAsync(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<ApiResponse<ProjectAdminDtoPagedResponse>> GetAllProjectsWithHttpInfoAsync(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Retrieves all resources. /// </summary> @@ -243,14 +269,15 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="includeDeleted">Value indicating whether to include deleted resources. (optional)</param> + /// <param name="includeQuotas">Value indicating whether to include individual resource quotas. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ResourceAdminDtoPagedResponse</returns> - System.Threading.Tasks.Task<ResourceAdminDtoPagedResponse> GetAllResourcesAsync(bool? includeDeleted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<ResourceAdminDtoPagedResponse> GetAllResourcesAsync(bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Retrieves all resources. @@ -259,14 +286,15 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="includeDeleted">Value indicating whether to include deleted resources. (optional)</param> + /// <param name="includeQuotas">Value indicating whether to include individual resource quotas. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ResourceAdminDtoPagedResponse)</returns> - System.Threading.Tasks.Task<ApiResponse<ResourceAdminDtoPagedResponse>> GetAllResourcesWithHttpInfoAsync(bool? includeDeleted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<ApiResponse<ResourceAdminDtoPagedResponse>> GetAllResourcesWithHttpInfoAsync(bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Retrieves all users. /// </summary> @@ -274,14 +302,14 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="orderBy"> (optional)</param> - /// <param name="tosAccepted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> + /// <param name="tosAccepted">Gets or sets a value indicating whether the terms of service have been accepted by the user. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of UserDtoPagedResponse</returns> - System.Threading.Tasks.Task<UserDtoPagedResponse> GetAllUsersAsync(string? orderBy = default(string?), bool? tosAccepted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<UserDtoPagedResponse> GetAllUsersAsync(bool? tosAccepted = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Retrieves all users. @@ -290,14 +318,14 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="orderBy"> (optional)</param> - /// <param name="tosAccepted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> + /// <param name="tosAccepted">Gets or sets a value indicating whether the terms of service have been accepted by the user. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (UserDtoPagedResponse)</returns> - System.Threading.Tasks.Task<ApiResponse<UserDtoPagedResponse>> GetAllUsersWithHttpInfoAsync(string? orderBy = default(string?), bool? tosAccepted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<ApiResponse<UserDtoPagedResponse>> GetAllUsersWithHttpInfoAsync(bool? tosAccepted = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Gets a metadata graph. /// </summary> @@ -305,12 +333,12 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="graphUri"></param> - /// <param name="format"> (optional)</param> + /// <param name="graph">The absolute URI of the graph to get.</param> + /// <param name="format">Gets or sets the RDF format. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of RdfDefinitionDtoResponse</returns> - System.Threading.Tasks.Task<RdfDefinitionDtoResponse> GetMetadataGraphAsync(string graphUri, RdfFormat? format = default(RdfFormat?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<RdfDefinitionDtoResponse> GetMetadataGraphAsync(string graph, RdfFormat? format = default(RdfFormat?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Gets a metadata graph. @@ -319,12 +347,39 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="graphUri"></param> - /// <param name="format"> (optional)</param> + /// <param name="graph">The absolute URI of the graph to get.</param> + /// <param name="format">Gets or sets the RDF format. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (RdfDefinitionDtoResponse)</returns> - System.Threading.Tasks.Task<ApiResponse<RdfDefinitionDtoResponse>> GetMetadataGraphWithHttpInfoAsync(string graphUri, RdfFormat? format = default(RdfFormat?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<ApiResponse<RdfDefinitionDtoResponse>> GetMetadataGraphWithHttpInfoAsync(string graph, RdfFormat? format = default(RdfFormat?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + /// <summary> + /// Patches a metadata graph. + /// </summary> + /// <remarks> + /// + /// </remarks> + /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to patch.</param> + /// <param name="rdfPatchDocumentDto">The well-formed RDF patch document containing the changes as operations to be applied to the graph. (optional)</param> + /// <param name="operationIndex">Index associated with the operation.</param> + /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> + /// <returns>Task of void</returns> + System.Threading.Tasks.Task PatchMetadataAsync(string graph, RdfPatchDocumentDto? rdfPatchDocumentDto = default(RdfPatchDocumentDto?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + + /// <summary> + /// Patches a metadata graph. + /// </summary> + /// <remarks> + /// + /// </remarks> + /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to patch.</param> + /// <param name="rdfPatchDocumentDto">The well-formed RDF patch document containing the changes as operations to be applied to the graph. (optional)</param> + /// <param name="operationIndex">Index associated with the operation.</param> + /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> + /// <returns>Task of ApiResponse</returns> + System.Threading.Tasks.Task<ApiResponse<Object>> PatchMetadataWithHttpInfoAsync(string graph, RdfPatchDocumentDto? rdfPatchDocumentDto = default(RdfPatchDocumentDto?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Updates a metadata graph. /// </summary> @@ -332,11 +387,12 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to update.</param> /// <param name="metadataUpdateAdminParameters">The metadata update admin parameters. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of void</returns> - System.Threading.Tasks.Task UpdateMetadataGraphAsync(MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task UpdateMetadataGraphAsync(string graph, MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Updates a metadata graph. @@ -345,11 +401,12 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to update.</param> /// <param name="metadataUpdateAdminParameters">The metadata update admin parameters. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse</returns> - System.Threading.Tasks.Task<ApiResponse<Object>> UpdateMetadataGraphWithHttpInfoAsync(MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<ApiResponse<Object>> UpdateMetadataGraphWithHttpInfoAsync(string graph, MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -606,17 +663,17 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all projects. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="includeQuotas"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to filter top-level projects. (optional)</param> + /// <param name="includeDeleted">Gets or sets a value indicating whether to include deleted projects in the results. (optional)</param> + /// <param name="includeQuotas">Gets or sets a value indicating whether to include quotas in the results. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ProjectAdminDtoPagedResponse</returns> - public ProjectAdminDtoPagedResponse GetAllProjects(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) + public ProjectAdminDtoPagedResponse GetAllProjects(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0) { - Coscine.ApiClient.Core.Client.ApiResponse<ProjectAdminDtoPagedResponse> localVarResponse = GetAllProjectsWithHttpInfo(topLevel, includeDeleted, includeQuotas, pageNumber, pageSize, orderBy); + Coscine.ApiClient.Core.Client.ApiResponse<ProjectAdminDtoPagedResponse> localVarResponse = GetAllProjectsWithHttpInfo(topLevel, includeDeleted, includeQuotas, pageSize, pageNumber, orderBy); return localVarResponse.Data; } @@ -624,15 +681,15 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all projects. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="includeQuotas"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to filter top-level projects. (optional)</param> + /// <param name="includeDeleted">Gets or sets a value indicating whether to include deleted projects in the results. (optional)</param> + /// <param name="includeQuotas">Gets or sets a value indicating whether to include quotas in the results. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ProjectAdminDtoPagedResponse</returns> - public Coscine.ApiClient.Core.Client.ApiResponse<ProjectAdminDtoPagedResponse> GetAllProjectsWithHttpInfo(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) + public Coscine.ApiClient.Core.Client.ApiResponse<ProjectAdminDtoPagedResponse> GetAllProjectsWithHttpInfo(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0) { Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -669,14 +726,14 @@ namespace Coscine.ApiClient.Core.Api { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "IncludeQuotas", includeQuotas)); } - if (pageNumber != null) - { - localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); - } if (pageSize != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageSize", pageSize)); } + if (pageNumber != null) + { + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); + } if (orderBy != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "OrderBy", orderBy)); @@ -709,18 +766,18 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all projects. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="includeQuotas"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to filter top-level projects. (optional)</param> + /// <param name="includeDeleted">Gets or sets a value indicating whether to include deleted projects in the results. (optional)</param> + /// <param name="includeQuotas">Gets or sets a value indicating whether to include quotas in the results. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ProjectAdminDtoPagedResponse</returns> - public async System.Threading.Tasks.Task<ProjectAdminDtoPagedResponse> GetAllProjectsAsync(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<ProjectAdminDtoPagedResponse> GetAllProjectsAsync(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Coscine.ApiClient.Core.Client.ApiResponse<ProjectAdminDtoPagedResponse> localVarResponse = await GetAllProjectsWithHttpInfoAsync(topLevel, includeDeleted, includeQuotas, pageNumber, pageSize, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); + Coscine.ApiClient.Core.Client.ApiResponse<ProjectAdminDtoPagedResponse> localVarResponse = await GetAllProjectsWithHttpInfoAsync(topLevel, includeDeleted, includeQuotas, pageSize, pageNumber, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -728,16 +785,16 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all projects. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="includeQuotas"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to filter top-level projects. (optional)</param> + /// <param name="includeDeleted">Gets or sets a value indicating whether to include deleted projects in the results. (optional)</param> + /// <param name="includeQuotas">Gets or sets a value indicating whether to include quotas in the results. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ProjectAdminDtoPagedResponse)</returns> - public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<ProjectAdminDtoPagedResponse>> GetAllProjectsWithHttpInfoAsync(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<ProjectAdminDtoPagedResponse>> GetAllProjectsWithHttpInfoAsync(bool? topLevel = default(bool?), bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -775,14 +832,14 @@ namespace Coscine.ApiClient.Core.Api { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "IncludeQuotas", includeQuotas)); } - if (pageNumber != null) - { - localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); - } if (pageSize != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageSize", pageSize)); } + if (pageNumber != null) + { + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); + } if (orderBy != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "OrderBy", orderBy)); @@ -816,15 +873,16 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all resources. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="includeDeleted">Value indicating whether to include deleted resources. (optional)</param> + /// <param name="includeQuotas">Value indicating whether to include individual resource quotas. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ResourceAdminDtoPagedResponse</returns> - public ResourceAdminDtoPagedResponse GetAllResources(bool? includeDeleted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) + public ResourceAdminDtoPagedResponse GetAllResources(bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0) { - Coscine.ApiClient.Core.Client.ApiResponse<ResourceAdminDtoPagedResponse> localVarResponse = GetAllResourcesWithHttpInfo(includeDeleted, pageNumber, pageSize, orderBy); + Coscine.ApiClient.Core.Client.ApiResponse<ResourceAdminDtoPagedResponse> localVarResponse = GetAllResourcesWithHttpInfo(includeDeleted, includeQuotas, pageSize, pageNumber, orderBy); return localVarResponse.Data; } @@ -832,13 +890,14 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all resources. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="includeDeleted">Value indicating whether to include deleted resources. (optional)</param> + /// <param name="includeQuotas">Value indicating whether to include individual resource quotas. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ResourceAdminDtoPagedResponse</returns> - public Coscine.ApiClient.Core.Client.ApiResponse<ResourceAdminDtoPagedResponse> GetAllResourcesWithHttpInfo(bool? includeDeleted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) + public Coscine.ApiClient.Core.Client.ApiResponse<ResourceAdminDtoPagedResponse> GetAllResourcesWithHttpInfo(bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0) { Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -867,14 +926,18 @@ namespace Coscine.ApiClient.Core.Api { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "IncludeDeleted", includeDeleted)); } - if (pageNumber != null) + if (includeQuotas != null) { - localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "IncludeQuotas", includeQuotas)); } if (pageSize != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageSize", pageSize)); } + if (pageNumber != null) + { + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); + } if (orderBy != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "OrderBy", orderBy)); @@ -907,16 +970,17 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all resources. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="includeDeleted">Value indicating whether to include deleted resources. (optional)</param> + /// <param name="includeQuotas">Value indicating whether to include individual resource quotas. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ResourceAdminDtoPagedResponse</returns> - public async System.Threading.Tasks.Task<ResourceAdminDtoPagedResponse> GetAllResourcesAsync(bool? includeDeleted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<ResourceAdminDtoPagedResponse> GetAllResourcesAsync(bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Coscine.ApiClient.Core.Client.ApiResponse<ResourceAdminDtoPagedResponse> localVarResponse = await GetAllResourcesWithHttpInfoAsync(includeDeleted, pageNumber, pageSize, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); + Coscine.ApiClient.Core.Client.ApiResponse<ResourceAdminDtoPagedResponse> localVarResponse = await GetAllResourcesWithHttpInfoAsync(includeDeleted, includeQuotas, pageSize, pageNumber, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -924,14 +988,15 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all resources. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="includeDeleted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="includeDeleted">Value indicating whether to include deleted resources. (optional)</param> + /// <param name="includeQuotas">Value indicating whether to include individual resource quotas. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ResourceAdminDtoPagedResponse)</returns> - public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<ResourceAdminDtoPagedResponse>> GetAllResourcesWithHttpInfoAsync(bool? includeDeleted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<ResourceAdminDtoPagedResponse>> GetAllResourcesWithHttpInfoAsync(bool? includeDeleted = default(bool?), bool? includeQuotas = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -961,14 +1026,18 @@ namespace Coscine.ApiClient.Core.Api { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "IncludeDeleted", includeDeleted)); } - if (pageNumber != null) + if (includeQuotas != null) { - localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "IncludeQuotas", includeQuotas)); } if (pageSize != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageSize", pageSize)); } + if (pageNumber != null) + { + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); + } if (orderBy != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "OrderBy", orderBy)); @@ -1002,15 +1071,15 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all users. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="orderBy"> (optional)</param> - /// <param name="tosAccepted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> + /// <param name="tosAccepted">Gets or sets a value indicating whether the terms of service have been accepted by the user. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>UserDtoPagedResponse</returns> - public UserDtoPagedResponse GetAllUsers(string? orderBy = default(string?), bool? tosAccepted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), int operationIndex = 0) + public UserDtoPagedResponse GetAllUsers(bool? tosAccepted = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0) { - Coscine.ApiClient.Core.Client.ApiResponse<UserDtoPagedResponse> localVarResponse = GetAllUsersWithHttpInfo(orderBy, tosAccepted, pageNumber, pageSize); + Coscine.ApiClient.Core.Client.ApiResponse<UserDtoPagedResponse> localVarResponse = GetAllUsersWithHttpInfo(tosAccepted, pageSize, pageNumber, orderBy); return localVarResponse.Data; } @@ -1018,13 +1087,13 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all users. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="orderBy"> (optional)</param> - /// <param name="tosAccepted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> + /// <param name="tosAccepted">Gets or sets a value indicating whether the terms of service have been accepted by the user. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of UserDtoPagedResponse</returns> - public Coscine.ApiClient.Core.Client.ApiResponse<UserDtoPagedResponse> GetAllUsersWithHttpInfo(string? orderBy = default(string?), bool? tosAccepted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), int operationIndex = 0) + public Coscine.ApiClient.Core.Client.ApiResponse<UserDtoPagedResponse> GetAllUsersWithHttpInfo(bool? tosAccepted = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0) { Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -1049,21 +1118,21 @@ namespace Coscine.ApiClient.Core.Api localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); } - if (orderBy != null) - { - localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "OrderBy", orderBy)); - } if (tosAccepted != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "TosAccepted", tosAccepted)); } + if (pageSize != null) + { + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageSize", pageSize)); + } if (pageNumber != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); } - if (pageSize != null) + if (orderBy != null) { - localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageSize", pageSize)); + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "OrderBy", orderBy)); } localVarRequestOptions.Operation = "AdminApi.GetAllUsers"; @@ -1093,16 +1162,16 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all users. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="orderBy"> (optional)</param> - /// <param name="tosAccepted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> + /// <param name="tosAccepted">Gets or sets a value indicating whether the terms of service have been accepted by the user. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of UserDtoPagedResponse</returns> - public async System.Threading.Tasks.Task<UserDtoPagedResponse> GetAllUsersAsync(string? orderBy = default(string?), bool? tosAccepted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<UserDtoPagedResponse> GetAllUsersAsync(bool? tosAccepted = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Coscine.ApiClient.Core.Client.ApiResponse<UserDtoPagedResponse> localVarResponse = await GetAllUsersWithHttpInfoAsync(orderBy, tosAccepted, pageNumber, pageSize, operationIndex, cancellationToken).ConfigureAwait(false); + Coscine.ApiClient.Core.Client.ApiResponse<UserDtoPagedResponse> localVarResponse = await GetAllUsersWithHttpInfoAsync(tosAccepted, pageSize, pageNumber, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1110,14 +1179,14 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all users. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="orderBy"> (optional)</param> - /// <param name="tosAccepted"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> + /// <param name="tosAccepted">Gets or sets a value indicating whether the terms of service have been accepted by the user. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `250`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (UserDtoPagedResponse)</returns> - public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<UserDtoPagedResponse>> GetAllUsersWithHttpInfoAsync(string? orderBy = default(string?), bool? tosAccepted = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<UserDtoPagedResponse>> GetAllUsersWithHttpInfoAsync(bool? tosAccepted = default(bool?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -1143,21 +1212,21 @@ namespace Coscine.ApiClient.Core.Api localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); } - if (orderBy != null) - { - localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "OrderBy", orderBy)); - } if (tosAccepted != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "TosAccepted", tosAccepted)); } + if (pageSize != null) + { + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageSize", pageSize)); + } if (pageNumber != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); } - if (pageSize != null) + if (orderBy != null) { - localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageSize", pageSize)); + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "OrderBy", orderBy)); } localVarRequestOptions.Operation = "AdminApi.GetAllUsers"; @@ -1188,13 +1257,13 @@ namespace Coscine.ApiClient.Core.Api /// Gets a metadata graph. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="graphUri"></param> - /// <param name="format"> (optional)</param> + /// <param name="graph">The absolute URI of the graph to get.</param> + /// <param name="format">Gets or sets the RDF format. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>RdfDefinitionDtoResponse</returns> - public RdfDefinitionDtoResponse GetMetadataGraph(string graphUri, RdfFormat? format = default(RdfFormat?), int operationIndex = 0) + public RdfDefinitionDtoResponse GetMetadataGraph(string graph, RdfFormat? format = default(RdfFormat?), int operationIndex = 0) { - Coscine.ApiClient.Core.Client.ApiResponse<RdfDefinitionDtoResponse> localVarResponse = GetMetadataGraphWithHttpInfo(graphUri, format); + Coscine.ApiClient.Core.Client.ApiResponse<RdfDefinitionDtoResponse> localVarResponse = GetMetadataGraphWithHttpInfo(graph, format); return localVarResponse.Data; } @@ -1202,16 +1271,16 @@ namespace Coscine.ApiClient.Core.Api /// Gets a metadata graph. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="graphUri"></param> - /// <param name="format"> (optional)</param> + /// <param name="graph">The absolute URI of the graph to get.</param> + /// <param name="format">Gets or sets the RDF format. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of RdfDefinitionDtoResponse</returns> - public Coscine.ApiClient.Core.Client.ApiResponse<RdfDefinitionDtoResponse> GetMetadataGraphWithHttpInfo(string graphUri, RdfFormat? format = default(RdfFormat?), int operationIndex = 0) + public Coscine.ApiClient.Core.Client.ApiResponse<RdfDefinitionDtoResponse> GetMetadataGraphWithHttpInfo(string graph, RdfFormat? format = default(RdfFormat?), int operationIndex = 0) { - // verify the required parameter 'graphUri' is set - if (graphUri == null) + // verify the required parameter 'graph' is set + if (graph == null) { - throw new Coscine.ApiClient.Core.Client.ApiException(400, "Missing required parameter 'graphUri' when calling AdminApi->GetMetadataGraph"); + throw new Coscine.ApiClient.Core.Client.ApiException(400, "Missing required parameter 'graph' when calling AdminApi->GetMetadataGraph"); } Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -1237,7 +1306,7 @@ namespace Coscine.ApiClient.Core.Api localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); } - localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "GraphUri", graphUri)); + localVarRequestOptions.PathParameters.Add("graph", Coscine.ApiClient.Core.Client.ClientUtils.ParameterToString(graph)); // path parameter if (format != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "Format", format)); @@ -1253,7 +1322,7 @@ namespace Coscine.ApiClient.Core.Api } // make the HTTP request - var localVarResponse = this.Client.Get<RdfDefinitionDtoResponse>("/api/v2/admin/metadata", localVarRequestOptions, this.Configuration); + var localVarResponse = this.Client.Get<RdfDefinitionDtoResponse>("/api/v2/admin/metadata/{graph}", localVarRequestOptions, this.Configuration); if (this.ExceptionFactory != null) { Exception _exception = this.ExceptionFactory("GetMetadataGraph", localVarResponse); @@ -1270,14 +1339,14 @@ namespace Coscine.ApiClient.Core.Api /// Gets a metadata graph. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="graphUri"></param> - /// <param name="format"> (optional)</param> + /// <param name="graph">The absolute URI of the graph to get.</param> + /// <param name="format">Gets or sets the RDF format. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of RdfDefinitionDtoResponse</returns> - public async System.Threading.Tasks.Task<RdfDefinitionDtoResponse> GetMetadataGraphAsync(string graphUri, RdfFormat? format = default(RdfFormat?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<RdfDefinitionDtoResponse> GetMetadataGraphAsync(string graph, RdfFormat? format = default(RdfFormat?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Coscine.ApiClient.Core.Client.ApiResponse<RdfDefinitionDtoResponse> localVarResponse = await GetMetadataGraphWithHttpInfoAsync(graphUri, format, operationIndex, cancellationToken).ConfigureAwait(false); + Coscine.ApiClient.Core.Client.ApiResponse<RdfDefinitionDtoResponse> localVarResponse = await GetMetadataGraphWithHttpInfoAsync(graph, format, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1285,17 +1354,17 @@ namespace Coscine.ApiClient.Core.Api /// Gets a metadata graph. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="graphUri"></param> - /// <param name="format"> (optional)</param> + /// <param name="graph">The absolute URI of the graph to get.</param> + /// <param name="format">Gets or sets the RDF format. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (RdfDefinitionDtoResponse)</returns> - public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<RdfDefinitionDtoResponse>> GetMetadataGraphWithHttpInfoAsync(string graphUri, RdfFormat? format = default(RdfFormat?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<RdfDefinitionDtoResponse>> GetMetadataGraphWithHttpInfoAsync(string graph, RdfFormat? format = default(RdfFormat?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - // verify the required parameter 'graphUri' is set - if (graphUri == null) + // verify the required parameter 'graph' is set + if (graph == null) { - throw new Coscine.ApiClient.Core.Client.ApiException(400, "Missing required parameter 'graphUri' when calling AdminApi->GetMetadataGraph"); + throw new Coscine.ApiClient.Core.Client.ApiException(400, "Missing required parameter 'graph' when calling AdminApi->GetMetadataGraph"); } @@ -1322,7 +1391,7 @@ namespace Coscine.ApiClient.Core.Api localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); } - localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "GraphUri", graphUri)); + localVarRequestOptions.PathParameters.Add("graph", Coscine.ApiClient.Core.Client.ClientUtils.ParameterToString(graph)); // path parameter if (format != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "Format", format)); @@ -1338,7 +1407,7 @@ namespace Coscine.ApiClient.Core.Api } // make the HTTP request - var localVarResponse = await this.AsynchronousClient.GetAsync<RdfDefinitionDtoResponse>("/api/v2/admin/metadata", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + var localVarResponse = await this.AsynchronousClient.GetAsync<RdfDefinitionDtoResponse>("/api/v2/admin/metadata/{graph}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); if (this.ExceptionFactory != null) { @@ -1352,27 +1421,197 @@ namespace Coscine.ApiClient.Core.Api return localVarResponse; } + /// <summary> + /// Patches a metadata graph. + /// </summary> + /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to patch.</param> + /// <param name="rdfPatchDocumentDto">The well-formed RDF patch document containing the changes as operations to be applied to the graph. (optional)</param> + /// <param name="operationIndex">Index associated with the operation.</param> + /// <returns></returns> + public void PatchMetadata(string graph, RdfPatchDocumentDto? rdfPatchDocumentDto = default(RdfPatchDocumentDto?), int operationIndex = 0) + { + PatchMetadataWithHttpInfo(graph, rdfPatchDocumentDto); + } + + /// <summary> + /// Patches a metadata graph. + /// </summary> + /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to patch.</param> + /// <param name="rdfPatchDocumentDto">The well-formed RDF patch document containing the changes as operations to be applied to the graph. (optional)</param> + /// <param name="operationIndex">Index associated with the operation.</param> + /// <returns>ApiResponse of Object(void)</returns> + public Coscine.ApiClient.Core.Client.ApiResponse<Object> PatchMetadataWithHttpInfo(string graph, RdfPatchDocumentDto? rdfPatchDocumentDto = default(RdfPatchDocumentDto?), int operationIndex = 0) + { + // verify the required parameter 'graph' is set + if (graph == null) + { + throw new Coscine.ApiClient.Core.Client.ApiException(400, "Missing required parameter 'graph' when calling AdminApi->PatchMetadata"); + } + + Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + "application/json", + "text/json", + "application/*+json" + }; + + // to determine the Accept header + string[] _accepts = new string[] { + }; + + var localVarContentType = Coscine.ApiClient.Core.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Coscine.ApiClient.Core.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("graph", Coscine.ApiClient.Core.Client.ClientUtils.ParameterToString(graph)); // path parameter + localVarRequestOptions.Data = rdfPatchDocumentDto; + + localVarRequestOptions.Operation = "AdminApi.PatchMetadata"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (Bearer) required + if (!string.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("Authorization"))) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", this.Configuration.GetApiKeyWithPrefix("Authorization")); + } + + // make the HTTP request + var localVarResponse = this.Client.Patch<Object>("/api/v2/admin/metadata/{graph}", localVarRequestOptions, this.Configuration); + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("PatchMetadata", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + + /// <summary> + /// Patches a metadata graph. + /// </summary> + /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to patch.</param> + /// <param name="rdfPatchDocumentDto">The well-formed RDF patch document containing the changes as operations to be applied to the graph. (optional)</param> + /// <param name="operationIndex">Index associated with the operation.</param> + /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> + /// <returns>Task of void</returns> + public async System.Threading.Tasks.Task PatchMetadataAsync(string graph, RdfPatchDocumentDto? rdfPatchDocumentDto = default(RdfPatchDocumentDto?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + await PatchMetadataWithHttpInfoAsync(graph, rdfPatchDocumentDto, operationIndex, cancellationToken).ConfigureAwait(false); + } + + /// <summary> + /// Patches a metadata graph. + /// </summary> + /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to patch.</param> + /// <param name="rdfPatchDocumentDto">The well-formed RDF patch document containing the changes as operations to be applied to the graph. (optional)</param> + /// <param name="operationIndex">Index associated with the operation.</param> + /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> + /// <returns>Task of ApiResponse</returns> + public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<Object>> PatchMetadataWithHttpInfoAsync(string graph, RdfPatchDocumentDto? rdfPatchDocumentDto = default(RdfPatchDocumentDto?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + { + // verify the required parameter 'graph' is set + if (graph == null) + { + throw new Coscine.ApiClient.Core.Client.ApiException(400, "Missing required parameter 'graph' when calling AdminApi->PatchMetadata"); + } + + + Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); + + string[] _contentTypes = new string[] { + "application/json", + "text/json", + "application/*+json" + }; + + // to determine the Accept header + string[] _accepts = new string[] { + }; + + var localVarContentType = Coscine.ApiClient.Core.Client.ClientUtils.SelectHeaderContentType(_contentTypes); + if (localVarContentType != null) + { + localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType); + } + + var localVarAccept = Coscine.ApiClient.Core.Client.ClientUtils.SelectHeaderAccept(_accepts); + if (localVarAccept != null) + { + localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); + } + + localVarRequestOptions.PathParameters.Add("graph", Coscine.ApiClient.Core.Client.ClientUtils.ParameterToString(graph)); // path parameter + localVarRequestOptions.Data = rdfPatchDocumentDto; + + localVarRequestOptions.Operation = "AdminApi.PatchMetadata"; + localVarRequestOptions.OperationIndex = operationIndex; + + // authentication (Bearer) required + if (!string.IsNullOrEmpty(this.Configuration.GetApiKeyWithPrefix("Authorization"))) + { + localVarRequestOptions.HeaderParameters.Add("Authorization", this.Configuration.GetApiKeyWithPrefix("Authorization")); + } + + // make the HTTP request + var localVarResponse = await this.AsynchronousClient.PatchAsync<Object>("/api/v2/admin/metadata/{graph}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + + if (this.ExceptionFactory != null) + { + Exception _exception = this.ExceptionFactory("PatchMetadata", localVarResponse); + if (_exception != null) + { + throw _exception; + } + } + + return localVarResponse; + } + /// <summary> /// Updates a metadata graph. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to update.</param> /// <param name="metadataUpdateAdminParameters">The metadata update admin parameters. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns></returns> - public void UpdateMetadataGraph(MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0) + public void UpdateMetadataGraph(string graph, MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0) { - UpdateMetadataGraphWithHttpInfo(metadataUpdateAdminParameters); + UpdateMetadataGraphWithHttpInfo(graph, metadataUpdateAdminParameters); } /// <summary> /// Updates a metadata graph. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to update.</param> /// <param name="metadataUpdateAdminParameters">The metadata update admin parameters. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of Object(void)</returns> - public Coscine.ApiClient.Core.Client.ApiResponse<Object> UpdateMetadataGraphWithHttpInfo(MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0) + public Coscine.ApiClient.Core.Client.ApiResponse<Object> UpdateMetadataGraphWithHttpInfo(string graph, MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0) { + // verify the required parameter 'graph' is set + if (graph == null) + { + throw new Coscine.ApiClient.Core.Client.ApiException(400, "Missing required parameter 'graph' when calling AdminApi->UpdateMetadataGraph"); + } + Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); string[] _contentTypes = new string[] { @@ -1397,6 +1636,7 @@ namespace Coscine.ApiClient.Core.Api localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); } + localVarRequestOptions.PathParameters.Add("graph", Coscine.ApiClient.Core.Client.ClientUtils.ParameterToString(graph)); // path parameter localVarRequestOptions.Data = metadataUpdateAdminParameters; localVarRequestOptions.Operation = "AdminApi.UpdateMetadataGraph"; @@ -1409,7 +1649,7 @@ namespace Coscine.ApiClient.Core.Api } // make the HTTP request - var localVarResponse = this.Client.Put<Object>("/api/v2/admin/metadata", localVarRequestOptions, this.Configuration); + var localVarResponse = this.Client.Put<Object>("/api/v2/admin/metadata/{graph}", localVarRequestOptions, this.Configuration); if (this.ExceptionFactory != null) { Exception _exception = this.ExceptionFactory("UpdateMetadataGraph", localVarResponse); @@ -1426,25 +1666,33 @@ namespace Coscine.ApiClient.Core.Api /// Updates a metadata graph. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to update.</param> /// <param name="metadataUpdateAdminParameters">The metadata update admin parameters. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of void</returns> - public async System.Threading.Tasks.Task UpdateMetadataGraphAsync(MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task UpdateMetadataGraphAsync(string graph, MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - await UpdateMetadataGraphWithHttpInfoAsync(metadataUpdateAdminParameters, operationIndex, cancellationToken).ConfigureAwait(false); + await UpdateMetadataGraphWithHttpInfoAsync(graph, metadataUpdateAdminParameters, operationIndex, cancellationToken).ConfigureAwait(false); } /// <summary> /// Updates a metadata graph. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> + /// <param name="graph">The absolute URI of the graph to update.</param> /// <param name="metadataUpdateAdminParameters">The metadata update admin parameters. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse</returns> - public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<Object>> UpdateMetadataGraphWithHttpInfoAsync(MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<Object>> UpdateMetadataGraphWithHttpInfoAsync(string graph, MetadataUpdateAdminParameters? metadataUpdateAdminParameters = default(MetadataUpdateAdminParameters?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { + // verify the required parameter 'graph' is set + if (graph == null) + { + throw new Coscine.ApiClient.Core.Client.ApiException(400, "Missing required parameter 'graph' when calling AdminApi->UpdateMetadataGraph"); + } + Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -1470,6 +1718,7 @@ namespace Coscine.ApiClient.Core.Api localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept); } + localVarRequestOptions.PathParameters.Add("graph", Coscine.ApiClient.Core.Client.ClientUtils.ParameterToString(graph)); // path parameter localVarRequestOptions.Data = metadataUpdateAdminParameters; localVarRequestOptions.Operation = "AdminApi.UpdateMetadataGraph"; @@ -1482,7 +1731,7 @@ namespace Coscine.ApiClient.Core.Api } // make the HTTP request - var localVarResponse = await this.AsynchronousClient.PutAsync<Object>("/api/v2/admin/metadata", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + var localVarResponse = await this.AsynchronousClient.PutAsync<Object>("/api/v2/admin/metadata/{graph}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); if (this.ExceptionFactory != null) { diff --git a/src/Coscine.ApiClient.Core/Api/ApplicationProfileApi.cs b/src/Coscine.ApiClient.Core/Api/ApplicationProfileApi.cs index 975a3f5b122d28fe52b3fae73b69ce2efcb4188e..268ed66f777e46813240a49bd2c22d9fa5cbbc24 100644 --- a/src/Coscine.ApiClient.Core/Api/ApplicationProfileApi.cs +++ b/src/Coscine.ApiClient.Core/Api/ApplicationProfileApi.cs @@ -93,14 +93,15 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all application profiles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter application profiles. (optional)</param> + /// <param name="language">Gets or sets the language for which the application profiles are requested. (optional)</param> + /// <param name="modules">Gets or sets a value indicating whether to include modules in the application profiles. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApplicationProfileDtoPagedResponse</returns> - ApplicationProfileDtoPagedResponse GetApplicationProfiles(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); + ApplicationProfileDtoPagedResponse GetApplicationProfiles(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), bool? modules = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); /// <summary> /// Retrieves all application profiles. @@ -109,14 +110,15 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter application profiles. (optional)</param> + /// <param name="language">Gets or sets the language for which the application profiles are requested. (optional)</param> + /// <param name="modules">Gets or sets a value indicating whether to include modules in the application profiles. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ApplicationProfileDtoPagedResponse</returns> - ApiResponse<ApplicationProfileDtoPagedResponse> GetApplicationProfilesWithHttpInfo(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); + ApiResponse<ApplicationProfileDtoPagedResponse> GetApplicationProfilesWithHttpInfo(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), bool? modules = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); /// <summary> /// Retrieves the `raw` application profile definition by its URI. /// </summary> @@ -230,15 +232,16 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter application profiles. (optional)</param> + /// <param name="language">Gets or sets the language for which the application profiles are requested. (optional)</param> + /// <param name="modules">Gets or sets a value indicating whether to include modules in the application profiles. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApplicationProfileDtoPagedResponse</returns> - System.Threading.Tasks.Task<ApplicationProfileDtoPagedResponse> GetApplicationProfilesAsync(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<ApplicationProfileDtoPagedResponse> GetApplicationProfilesAsync(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), bool? modules = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Retrieves all application profiles. @@ -247,15 +250,16 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter application profiles. (optional)</param> + /// <param name="language">Gets or sets the language for which the application profiles are requested. (optional)</param> + /// <param name="modules">Gets or sets a value indicating whether to include modules in the application profiles. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ApplicationProfileDtoPagedResponse)</returns> - System.Threading.Tasks.Task<ApiResponse<ApplicationProfileDtoPagedResponse>> GetApplicationProfilesWithHttpInfoAsync(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<ApiResponse<ApplicationProfileDtoPagedResponse>> GetApplicationProfilesWithHttpInfoAsync(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), bool? modules = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Retrieves the `raw` application profile definition by its URI. /// </summary> @@ -867,16 +871,17 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all application profiles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter application profiles. (optional)</param> + /// <param name="language">Gets or sets the language for which the application profiles are requested. (optional)</param> + /// <param name="modules">Gets or sets a value indicating whether to include modules in the application profiles. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApplicationProfileDtoPagedResponse</returns> - public ApplicationProfileDtoPagedResponse GetApplicationProfiles(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) + public ApplicationProfileDtoPagedResponse GetApplicationProfiles(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), bool? modules = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) { - Coscine.ApiClient.Core.Client.ApiResponse<ApplicationProfileDtoPagedResponse> localVarResponse = GetApplicationProfilesWithHttpInfo(searchTerm, language, pageNumber, pageSize, orderBy); + Coscine.ApiClient.Core.Client.ApiResponse<ApplicationProfileDtoPagedResponse> localVarResponse = GetApplicationProfilesWithHttpInfo(searchTerm, language, modules, pageNumber, pageSize, orderBy); return localVarResponse.Data; } @@ -884,14 +889,15 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all application profiles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter application profiles. (optional)</param> + /// <param name="language">Gets or sets the language for which the application profiles are requested. (optional)</param> + /// <param name="modules">Gets or sets a value indicating whether to include modules in the application profiles. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ApplicationProfileDtoPagedResponse</returns> - public Coscine.ApiClient.Core.Client.ApiResponse<ApplicationProfileDtoPagedResponse> GetApplicationProfilesWithHttpInfo(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) + public Coscine.ApiClient.Core.Client.ApiResponse<ApplicationProfileDtoPagedResponse> GetApplicationProfilesWithHttpInfo(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), bool? modules = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) { Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -924,6 +930,10 @@ namespace Coscine.ApiClient.Core.Api { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "Language", language)); } + if (modules != null) + { + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "Modules", modules)); + } if (pageNumber != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); @@ -964,17 +974,18 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all application profiles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter application profiles. (optional)</param> + /// <param name="language">Gets or sets the language for which the application profiles are requested. (optional)</param> + /// <param name="modules">Gets or sets a value indicating whether to include modules in the application profiles. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApplicationProfileDtoPagedResponse</returns> - public async System.Threading.Tasks.Task<ApplicationProfileDtoPagedResponse> GetApplicationProfilesAsync(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<ApplicationProfileDtoPagedResponse> GetApplicationProfilesAsync(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), bool? modules = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Coscine.ApiClient.Core.Client.ApiResponse<ApplicationProfileDtoPagedResponse> localVarResponse = await GetApplicationProfilesWithHttpInfoAsync(searchTerm, language, pageNumber, pageSize, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); + Coscine.ApiClient.Core.Client.ApiResponse<ApplicationProfileDtoPagedResponse> localVarResponse = await GetApplicationProfilesWithHttpInfoAsync(searchTerm, language, modules, pageNumber, pageSize, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -982,15 +993,16 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all application profiles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter application profiles. (optional)</param> + /// <param name="language">Gets or sets the language for which the application profiles are requested. (optional)</param> + /// <param name="modules">Gets or sets a value indicating whether to include modules in the application profiles. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ApplicationProfileDtoPagedResponse)</returns> - public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<ApplicationProfileDtoPagedResponse>> GetApplicationProfilesWithHttpInfoAsync(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<ApplicationProfileDtoPagedResponse>> GetApplicationProfilesWithHttpInfoAsync(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), bool? modules = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -1024,6 +1036,10 @@ namespace Coscine.ApiClient.Core.Api { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "Language", language)); } + if (modules != null) + { + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "Modules", modules)); + } if (pageNumber != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); diff --git a/src/Coscine.ApiClient.Core/Api/DisciplineApi.cs b/src/Coscine.ApiClient.Core/Api/DisciplineApi.cs index 87523dd17d09e4b15a65c8ada122f16792658925..bff0d6e02139e3fdafdf811bb75838e24d8bb27c 100644 --- a/src/Coscine.ApiClient.Core/Api/DisciplineApi.cs +++ b/src/Coscine.ApiClient.Core/Api/DisciplineApi.cs @@ -69,9 +69,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all disciplines. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>DisciplineDtoPagedResponse</returns> DisciplineDtoPagedResponse GetDisciplines(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -83,9 +83,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of DisciplineDtoPagedResponse</returns> ApiResponse<DisciplineDtoPagedResponse> GetDisciplinesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -153,9 +153,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of DisciplineDtoPagedResponse</returns> @@ -168,9 +168,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (DisciplineDtoPagedResponse)</returns> @@ -575,9 +575,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all disciplines. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>DisciplineDtoPagedResponse</returns> public DisciplineDtoPagedResponse GetDisciplines(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -590,9 +590,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all disciplines. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of DisciplineDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<DisciplineDtoPagedResponse> GetDisciplinesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -660,9 +660,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all disciplines. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of DisciplineDtoPagedResponse</returns> @@ -676,9 +676,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all disciplines. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (DisciplineDtoPagedResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/LanguageApi.cs b/src/Coscine.ApiClient.Core/Api/LanguageApi.cs index 3f2c59f5a110e5720f61f65ac477e6e161d3e04a..323febf11b421d9e6824c8ea1e8d3b860d014685 100644 --- a/src/Coscine.ApiClient.Core/Api/LanguageApi.cs +++ b/src/Coscine.ApiClient.Core/Api/LanguageApi.cs @@ -69,12 +69,12 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all languages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> - /// <returns>LanguageDtoPagedResponse</returns> - LanguageDtoPagedResponse GetLanguages(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); + /// <returns>LanguageDtoIEnumerableResponse</returns> + LanguageDtoIEnumerableResponse GetLanguages(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); /// <summary> /// Retrieves all languages. @@ -83,12 +83,12 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> - /// <returns>ApiResponse of LanguageDtoPagedResponse</returns> - ApiResponse<LanguageDtoPagedResponse> GetLanguagesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); + /// <returns>ApiResponse of LanguageDtoIEnumerableResponse</returns> + ApiResponse<LanguageDtoIEnumerableResponse> GetLanguagesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); #endregion Synchronous Operations } @@ -153,13 +153,13 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> - /// <returns>Task of LanguageDtoPagedResponse</returns> - System.Threading.Tasks.Task<LanguageDtoPagedResponse> GetLanguagesAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + /// <returns>Task of LanguageDtoIEnumerableResponse</returns> + System.Threading.Tasks.Task<LanguageDtoIEnumerableResponse> GetLanguagesAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Retrieves all languages. @@ -168,13 +168,13 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> - /// <returns>Task of ApiResponse (LanguageDtoPagedResponse)</returns> - System.Threading.Tasks.Task<ApiResponse<LanguageDtoPagedResponse>> GetLanguagesWithHttpInfoAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + /// <returns>Task of ApiResponse (LanguageDtoIEnumerableResponse)</returns> + System.Threading.Tasks.Task<ApiResponse<LanguageDtoIEnumerableResponse>> GetLanguagesWithHttpInfoAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -575,14 +575,14 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all languages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> - /// <returns>LanguageDtoPagedResponse</returns> - public LanguageDtoPagedResponse GetLanguages(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) + /// <returns>LanguageDtoIEnumerableResponse</returns> + public LanguageDtoIEnumerableResponse GetLanguages(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) { - Coscine.ApiClient.Core.Client.ApiResponse<LanguageDtoPagedResponse> localVarResponse = GetLanguagesWithHttpInfo(pageNumber, pageSize, orderBy); + Coscine.ApiClient.Core.Client.ApiResponse<LanguageDtoIEnumerableResponse> localVarResponse = GetLanguagesWithHttpInfo(pageNumber, pageSize, orderBy); return localVarResponse.Data; } @@ -590,12 +590,12 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all languages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> - /// <returns>ApiResponse of LanguageDtoPagedResponse</returns> - public Coscine.ApiClient.Core.Client.ApiResponse<LanguageDtoPagedResponse> GetLanguagesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) + /// <returns>ApiResponse of LanguageDtoIEnumerableResponse</returns> + public Coscine.ApiClient.Core.Client.ApiResponse<LanguageDtoIEnumerableResponse> GetLanguagesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) { Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -643,7 +643,7 @@ namespace Coscine.ApiClient.Core.Api } // make the HTTP request - var localVarResponse = this.Client.Get<LanguageDtoPagedResponse>("/api/v2/languages", localVarRequestOptions, this.Configuration); + var localVarResponse = this.Client.Get<LanguageDtoIEnumerableResponse>("/api/v2/languages", localVarRequestOptions, this.Configuration); if (this.ExceptionFactory != null) { Exception _exception = this.ExceptionFactory("GetLanguages", localVarResponse); @@ -660,15 +660,15 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all languages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> - /// <returns>Task of LanguageDtoPagedResponse</returns> - public async System.Threading.Tasks.Task<LanguageDtoPagedResponse> GetLanguagesAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + /// <returns>Task of LanguageDtoIEnumerableResponse</returns> + public async System.Threading.Tasks.Task<LanguageDtoIEnumerableResponse> GetLanguagesAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Coscine.ApiClient.Core.Client.ApiResponse<LanguageDtoPagedResponse> localVarResponse = await GetLanguagesWithHttpInfoAsync(pageNumber, pageSize, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); + Coscine.ApiClient.Core.Client.ApiResponse<LanguageDtoIEnumerableResponse> localVarResponse = await GetLanguagesWithHttpInfoAsync(pageNumber, pageSize, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -676,13 +676,13 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all languages. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> - /// <returns>Task of ApiResponse (LanguageDtoPagedResponse)</returns> - public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<LanguageDtoPagedResponse>> GetLanguagesWithHttpInfoAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + /// <returns>Task of ApiResponse (LanguageDtoIEnumerableResponse)</returns> + public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<LanguageDtoIEnumerableResponse>> GetLanguagesWithHttpInfoAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -731,7 +731,7 @@ namespace Coscine.ApiClient.Core.Api } // make the HTTP request - var localVarResponse = await this.AsynchronousClient.GetAsync<LanguageDtoPagedResponse>("/api/v2/languages", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + var localVarResponse = await this.AsynchronousClient.GetAsync<LanguageDtoIEnumerableResponse>("/api/v2/languages", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); if (this.ExceptionFactory != null) { diff --git a/src/Coscine.ApiClient.Core/Api/LicenseApi.cs b/src/Coscine.ApiClient.Core/Api/LicenseApi.cs index ea8f661689ec327630025e9e4fa3333131101b14..e366e34ae70af7986e514233da378271fcafe0ae 100644 --- a/src/Coscine.ApiClient.Core/Api/LicenseApi.cs +++ b/src/Coscine.ApiClient.Core/Api/LicenseApi.cs @@ -69,9 +69,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all licenses. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>LicenseDtoPagedResponse</returns> LicenseDtoPagedResponse GetLicenses(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -83,9 +83,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of LicenseDtoPagedResponse</returns> ApiResponse<LicenseDtoPagedResponse> GetLicensesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -153,9 +153,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of LicenseDtoPagedResponse</returns> @@ -168,9 +168,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (LicenseDtoPagedResponse)</returns> @@ -575,9 +575,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all licenses. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>LicenseDtoPagedResponse</returns> public LicenseDtoPagedResponse GetLicenses(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -590,9 +590,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all licenses. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of LicenseDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<LicenseDtoPagedResponse> GetLicensesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -660,9 +660,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all licenses. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of LicenseDtoPagedResponse</returns> @@ -676,9 +676,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all licenses. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (LicenseDtoPagedResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/OrganizationApi.cs b/src/Coscine.ApiClient.Core/Api/OrganizationApi.cs index 4c9ff4eba7203d24e633b15ecf8dbb2b9e7056fb..33e3e9915e4de824c847309f8b3d21e11da0d7b3 100644 --- a/src/Coscine.ApiClient.Core/Api/OrganizationApi.cs +++ b/src/Coscine.ApiClient.Core/Api/OrganizationApi.cs @@ -69,10 +69,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all organizations. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter organizations. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>OrganizationDtoPagedResponse</returns> OrganizationDtoPagedResponse GetOrganizations(string? searchTerm = default(string?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -84,10 +84,10 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter organizations. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of OrganizationDtoPagedResponse</returns> ApiResponse<OrganizationDtoPagedResponse> GetOrganizationsWithHttpInfo(string? searchTerm = default(string?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -155,10 +155,10 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter organizations. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of OrganizationDtoPagedResponse</returns> @@ -171,10 +171,10 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter organizations. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (OrganizationDtoPagedResponse)</returns> @@ -591,10 +591,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all organizations. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter organizations. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>OrganizationDtoPagedResponse</returns> public OrganizationDtoPagedResponse GetOrganizations(string? searchTerm = default(string?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -607,10 +607,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all organizations. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter organizations. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of OrganizationDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<OrganizationDtoPagedResponse> GetOrganizationsWithHttpInfo(string? searchTerm = default(string?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -682,10 +682,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all organizations. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter organizations. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of OrganizationDtoPagedResponse</returns> @@ -699,10 +699,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all organizations. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter organizations. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (OrganizationDtoPagedResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/ProjectApi.cs b/src/Coscine.ApiClient.Core/Api/ProjectApi.cs index 8da5cb0e19794ddf855ee84a21b3c15af85c7c70..3b8dbf00354de791fe04e978278f4560defbf1a0 100644 --- a/src/Coscine.ApiClient.Core/Api/ProjectApi.cs +++ b/src/Coscine.ApiClient.Core/Api/ProjectApi.cs @@ -90,7 +90,7 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The ID of the project.</param> - /// <param name="includeSubProjects"> (optional)</param> + /// <param name="includeSubProjects">Gets or sets a value indicating whether to include sub-projects in the retrieval. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ProjectDtoResponse</returns> ProjectDtoResponse GetProject(string projectId, bool? includeSubProjects = default(bool?), int operationIndex = 0); @@ -103,7 +103,7 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The ID of the project.</param> - /// <param name="includeSubProjects"> (optional)</param> + /// <param name="includeSubProjects">Gets or sets a value indicating whether to include sub-projects in the retrieval. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ProjectDtoResponse</returns> ApiResponse<ProjectDtoResponse> GetProjectWithHttpInfo(string projectId, bool? includeSubProjects = default(bool?), int operationIndex = 0); @@ -111,10 +111,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all projects. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to retrieve only top-level projects. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ProjectDtoPagedResponse</returns> ProjectDtoPagedResponse GetProjects(bool? topLevel = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -126,10 +126,10 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to retrieve only top-level projects. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ProjectDtoPagedResponse</returns> ApiResponse<ProjectDtoPagedResponse> GetProjectsWithHttpInfo(bool? topLevel = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -245,7 +245,7 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The ID of the project.</param> - /// <param name="includeSubProjects"> (optional)</param> + /// <param name="includeSubProjects">Gets or sets a value indicating whether to include sub-projects in the retrieval. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ProjectDtoResponse</returns> @@ -259,7 +259,7 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The ID of the project.</param> - /// <param name="includeSubProjects"> (optional)</param> + /// <param name="includeSubProjects">Gets or sets a value indicating whether to include sub-projects in the retrieval. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ProjectDtoResponse)</returns> @@ -271,10 +271,10 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to retrieve only top-level projects. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ProjectDtoPagedResponse</returns> @@ -287,10 +287,10 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to retrieve only top-level projects. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ProjectDtoPagedResponse)</returns> @@ -879,7 +879,7 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The ID of the project.</param> - /// <param name="includeSubProjects"> (optional)</param> + /// <param name="includeSubProjects">Gets or sets a value indicating whether to include sub-projects in the retrieval. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ProjectDtoResponse</returns> public ProjectDtoResponse GetProject(string projectId, bool? includeSubProjects = default(bool?), int operationIndex = 0) @@ -893,7 +893,7 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The ID of the project.</param> - /// <param name="includeSubProjects"> (optional)</param> + /// <param name="includeSubProjects">Gets or sets a value indicating whether to include sub-projects in the retrieval. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ProjectDtoResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<ProjectDtoResponse> GetProjectWithHttpInfo(string projectId, bool? includeSubProjects = default(bool?), int operationIndex = 0) @@ -961,7 +961,7 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The ID of the project.</param> - /// <param name="includeSubProjects"> (optional)</param> + /// <param name="includeSubProjects">Gets or sets a value indicating whether to include sub-projects in the retrieval. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ProjectDtoResponse</returns> @@ -976,7 +976,7 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The ID of the project.</param> - /// <param name="includeSubProjects"> (optional)</param> + /// <param name="includeSubProjects">Gets or sets a value indicating whether to include sub-projects in the retrieval. (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ProjectDtoResponse)</returns> @@ -1046,10 +1046,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all projects. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to retrieve only top-level projects. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ProjectDtoPagedResponse</returns> public ProjectDtoPagedResponse GetProjects(bool? topLevel = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -1062,10 +1062,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all projects. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to retrieve only top-level projects. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ProjectDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<ProjectDtoPagedResponse> GetProjectsWithHttpInfo(bool? topLevel = default(bool?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -1137,10 +1137,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all projects. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to retrieve only top-level projects. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ProjectDtoPagedResponse</returns> @@ -1154,10 +1154,10 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all projects. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="topLevel"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="topLevel">Gets or sets a value indicating whether to retrieve only top-level projects. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ProjectDtoPagedResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/ProjectInvitationApi.cs b/src/Coscine.ApiClient.Core/Api/ProjectInvitationApi.cs index 17093536883a76193ab0754a99251e75cbce2c5b..e5766e1129693f57cf0fea9d314991995e97e6e0 100644 --- a/src/Coscine.ApiClient.Core/Api/ProjectInvitationApi.cs +++ b/src/Coscine.ApiClient.Core/Api/ProjectInvitationApi.cs @@ -118,9 +118,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ProjectInvitationDtoPagedResponse</returns> ProjectInvitationDtoPagedResponse GetProjectInvitations(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -133,9 +133,9 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ProjectInvitationDtoPagedResponse</returns> ApiResponse<ProjectInvitationDtoPagedResponse> GetProjectInvitationsWithHttpInfo(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -262,9 +262,9 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ProjectInvitationDtoPagedResponse</returns> @@ -278,9 +278,9 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ProjectInvitationDtoPagedResponse)</returns> @@ -1046,9 +1046,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ProjectInvitationDtoPagedResponse</returns> public ProjectInvitationDtoPagedResponse GetProjectInvitations(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -1062,9 +1062,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ProjectInvitationDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<ProjectInvitationDtoPagedResponse> GetProjectInvitationsWithHttpInfo(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -1140,9 +1140,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ProjectInvitationDtoPagedResponse</returns> @@ -1157,9 +1157,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ProjectInvitationDtoPagedResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/ProjectMemberApi.cs b/src/Coscine.ApiClient.Core/Api/ProjectMemberApi.cs index 3f9007826ec046b74902ffd6e2a5469764a41d98..b2c18b225eda7e011ac1f1f479a4f83241e813fb 100644 --- a/src/Coscine.ApiClient.Core/Api/ProjectMemberApi.cs +++ b/src/Coscine.ApiClient.Core/Api/ProjectMemberApi.cs @@ -118,9 +118,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ProjectRoleDtoPagedResponse</returns> ProjectRoleDtoPagedResponse GetMemberships(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -133,9 +133,9 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ProjectRoleDtoPagedResponse</returns> ApiResponse<ProjectRoleDtoPagedResponse> GetMembershipsWithHttpInfo(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -286,9 +286,9 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ProjectRoleDtoPagedResponse</returns> @@ -302,9 +302,9 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ProjectRoleDtoPagedResponse)</returns> @@ -1099,9 +1099,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ProjectRoleDtoPagedResponse</returns> public ProjectRoleDtoPagedResponse GetMemberships(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -1115,9 +1115,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ProjectRoleDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<ProjectRoleDtoPagedResponse> GetMembershipsWithHttpInfo(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -1193,9 +1193,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ProjectRoleDtoPagedResponse</returns> @@ -1210,9 +1210,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ProjectRoleDtoPagedResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/ProjectQuotaApi.cs b/src/Coscine.ApiClient.Core/Api/ProjectQuotaApi.cs index afad6330a3f08cb68a1bc28410c36a768b8f53fb..8c647a2e697580c5854bd063ef7b25150aaacdd1 100644 --- a/src/Coscine.ApiClient.Core/Api/ProjectQuotaApi.cs +++ b/src/Coscine.ApiClient.Core/Api/ProjectQuotaApi.cs @@ -74,9 +74,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ProjectQuotaDtoPagedResponse</returns> ProjectQuotaDtoPagedResponse GetProjectQuotas(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -89,9 +89,9 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ProjectQuotaDtoPagedResponse</returns> ApiResponse<ProjectQuotaDtoPagedResponse> GetProjectQuotasWithHttpInfo(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -188,9 +188,9 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ProjectQuotaDtoPagedResponse</returns> @@ -204,9 +204,9 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ProjectQuotaDtoPagedResponse)</returns> @@ -677,9 +677,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ProjectQuotaDtoPagedResponse</returns> public ProjectQuotaDtoPagedResponse GetProjectQuotas(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -693,9 +693,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ProjectQuotaDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<ProjectQuotaDtoPagedResponse> GetProjectQuotasWithHttpInfo(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -771,9 +771,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ProjectQuotaDtoPagedResponse</returns> @@ -788,9 +788,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ProjectQuotaDtoPagedResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/ProjectResourceApi.cs b/src/Coscine.ApiClient.Core/Api/ProjectResourceApi.cs index 200017313efd789acfece60afeb939ca988d5f4d..947d89c634bbf9898a0dd6eeadf46473f0a45aa8 100644 --- a/src/Coscine.ApiClient.Core/Api/ProjectResourceApi.cs +++ b/src/Coscine.ApiClient.Core/Api/ProjectResourceApi.cs @@ -118,9 +118,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ResourceDtoPagedResponse</returns> ResourceDtoPagedResponse GetResourcesForProject(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -133,9 +133,9 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ResourceDtoPagedResponse</returns> ApiResponse<ResourceDtoPagedResponse> GetResourcesForProjectWithHttpInfo(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -286,9 +286,9 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ResourceDtoPagedResponse</returns> @@ -302,9 +302,9 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ResourceDtoPagedResponse)</returns> @@ -1099,9 +1099,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ResourceDtoPagedResponse</returns> public ResourceDtoPagedResponse GetResourcesForProject(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -1115,9 +1115,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ResourceDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<ResourceDtoPagedResponse> GetResourcesForProjectWithHttpInfo(string projectId, int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -1193,9 +1193,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ResourceDtoPagedResponse</returns> @@ -1210,9 +1210,9 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The Id or slug of the project.</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ResourceDtoPagedResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/ResourceTypeApi.cs b/src/Coscine.ApiClient.Core/Api/ResourceTypeApi.cs index 5a236224e00332e6413181a02d1817671b51b888..bd07d44c89c2e418a58bf6847567a6960b9f7df3 100644 --- a/src/Coscine.ApiClient.Core/Api/ResourceTypeApi.cs +++ b/src/Coscine.ApiClient.Core/Api/ResourceTypeApi.cs @@ -50,8 +50,8 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>GitlabBranchDtoIEnumerableResponse</returns> GitlabBranchDtoIEnumerableResponse GetAllGitlabBranchesForProject(int gitlabProjectId, string domain, string accessToken, int operationIndex = 0); @@ -64,8 +64,8 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of GitlabBranchDtoIEnumerableResponse</returns> ApiResponse<GitlabBranchDtoIEnumerableResponse> GetAllGitlabBranchesForProjectWithHttpInfo(int gitlabProjectId, string domain, string accessToken, int operationIndex = 0); @@ -73,8 +73,8 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>GitlabProjectDtoIEnumerableResponse</returns> GitlabProjectDtoIEnumerableResponse GetAllGitlabProjects(string domain, string accessToken, int operationIndex = 0); @@ -86,8 +86,8 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of GitlabProjectDtoIEnumerableResponse</returns> ApiResponse<GitlabProjectDtoIEnumerableResponse> GetAllGitlabProjectsWithHttpInfo(string domain, string accessToken, int operationIndex = 0); @@ -114,8 +114,8 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>GitlabProjectDtoResponse</returns> GitlabProjectDtoResponse GetGitlabProject(int gitlabProjectId, string domain, string accessToken, int operationIndex = 0); @@ -128,8 +128,8 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of GitlabProjectDtoResponse</returns> ApiResponse<GitlabProjectDtoResponse> GetGitlabProjectWithHttpInfo(int gitlabProjectId, string domain, string accessToken, int operationIndex = 0); @@ -193,8 +193,8 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of GitlabBranchDtoIEnumerableResponse</returns> @@ -208,8 +208,8 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (GitlabBranchDtoIEnumerableResponse)</returns> @@ -221,8 +221,8 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of GitlabProjectDtoIEnumerableResponse</returns> @@ -235,8 +235,8 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (GitlabProjectDtoIEnumerableResponse)</returns> @@ -272,8 +272,8 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of GitlabProjectDtoResponse</returns> @@ -287,8 +287,8 @@ namespace Coscine.ApiClient.Core.Api /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (GitlabProjectDtoResponse)</returns> @@ -575,8 +575,8 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>GitlabBranchDtoIEnumerableResponse</returns> public GitlabBranchDtoIEnumerableResponse GetAllGitlabBranchesForProject(int gitlabProjectId, string domain, string accessToken, int operationIndex = 0) @@ -590,8 +590,8 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of GitlabBranchDtoIEnumerableResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<GitlabBranchDtoIEnumerableResponse> GetAllGitlabBranchesForProjectWithHttpInfo(int gitlabProjectId, string domain, string accessToken, int operationIndex = 0) @@ -663,8 +663,8 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of GitlabBranchDtoIEnumerableResponse</returns> @@ -679,8 +679,8 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (GitlabBranchDtoIEnumerableResponse)</returns> @@ -754,8 +754,8 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>GitlabProjectDtoIEnumerableResponse</returns> public GitlabProjectDtoIEnumerableResponse GetAllGitlabProjects(string domain, string accessToken, int operationIndex = 0) @@ -768,8 +768,8 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of GitlabProjectDtoIEnumerableResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<GitlabProjectDtoIEnumerableResponse> GetAllGitlabProjectsWithHttpInfo(string domain, string accessToken, int operationIndex = 0) @@ -839,8 +839,8 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of GitlabProjectDtoIEnumerableResponse</returns> @@ -854,8 +854,8 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (GitlabProjectDtoIEnumerableResponse)</returns> @@ -1067,8 +1067,8 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>GitlabProjectDtoResponse</returns> public GitlabProjectDtoResponse GetGitlabProject(int gitlabProjectId, string domain, string accessToken, int operationIndex = 0) @@ -1082,8 +1082,8 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of GitlabProjectDtoResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<GitlabProjectDtoResponse> GetGitlabProjectWithHttpInfo(int gitlabProjectId, string domain, string accessToken, int operationIndex = 0) @@ -1155,8 +1155,8 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of GitlabProjectDtoResponse</returns> @@ -1171,8 +1171,8 @@ namespace Coscine.ApiClient.Core.Api /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="gitlabProjectId">The ID of the GitLab project.</param> - /// <param name="domain"></param> - /// <param name="accessToken"></param> + /// <param name="domain">Domain/Host of the GitLab Provider.</param> + /// <param name="accessToken">GitLab Project or Group Access Token.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (GitlabProjectDtoResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/RoleApi.cs b/src/Coscine.ApiClient.Core/Api/RoleApi.cs index 46e713309bb04a9b13ccf9f537439527a92faa32..3f4bfbb890d4aa9ac1763df3b821629f45382f84 100644 --- a/src/Coscine.ApiClient.Core/Api/RoleApi.cs +++ b/src/Coscine.ApiClient.Core/Api/RoleApi.cs @@ -69,9 +69,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all roles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>RoleDtoPagedResponse</returns> RoleDtoPagedResponse GetRoles(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -83,9 +83,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of RoleDtoPagedResponse</returns> ApiResponse<RoleDtoPagedResponse> GetRolesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -153,9 +153,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of RoleDtoPagedResponse</returns> @@ -168,9 +168,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (RoleDtoPagedResponse)</returns> @@ -575,9 +575,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all roles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>RoleDtoPagedResponse</returns> public RoleDtoPagedResponse GetRoles(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -590,9 +590,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all roles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of RoleDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<RoleDtoPagedResponse> GetRolesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -660,9 +660,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all roles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of RoleDtoPagedResponse</returns> @@ -676,9 +676,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all roles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (RoleDtoPagedResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/SearchApi.cs b/src/Coscine.ApiClient.Core/Api/SearchApi.cs index e411cd84d36bcb681fa3fc9ce3088c8139e157e3..297f1091c5ab800c8996b5412760e0285d27d3eb 100644 --- a/src/Coscine.ApiClient.Core/Api/SearchApi.cs +++ b/src/Coscine.ApiClient.Core/Api/SearchApi.cs @@ -49,13 +49,13 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves a search result by given search parameters. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="query"> (optional)</param> - /// <param name="useAdvancedSyntax"> (optional)</param> - /// <param name="languages"> (optional)</param> - /// <param name="category"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="query">The search query (optional)</param> + /// <param name="useAdvancedSyntax">Set true for advanced Elasticsearch search syntax (optional)</param> + /// <param name="languages">Set the used languages (optional)</param> + /// <param name="category">Set the category filter (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>SearchResultDtoPagedSearchResponse</returns> SearchResultDtoPagedSearchResponse GetSearchResults(string? query = default(string?), bool? useAdvancedSyntax = default(bool?), List<string>? languages = default(List<string>?), SearchCategoryType? category = default(SearchCategoryType?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -67,13 +67,13 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="query"> (optional)</param> - /// <param name="useAdvancedSyntax"> (optional)</param> - /// <param name="languages"> (optional)</param> - /// <param name="category"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="query">The search query (optional)</param> + /// <param name="useAdvancedSyntax">Set true for advanced Elasticsearch search syntax (optional)</param> + /// <param name="languages">Set the used languages (optional)</param> + /// <param name="category">Set the category filter (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of SearchResultDtoPagedSearchResponse</returns> ApiResponse<SearchResultDtoPagedSearchResponse> GetSearchResultsWithHttpInfo(string? query = default(string?), bool? useAdvancedSyntax = default(bool?), List<string>? languages = default(List<string>?), SearchCategoryType? category = default(SearchCategoryType?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -116,13 +116,13 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="query"> (optional)</param> - /// <param name="useAdvancedSyntax"> (optional)</param> - /// <param name="languages"> (optional)</param> - /// <param name="category"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="query">The search query (optional)</param> + /// <param name="useAdvancedSyntax">Set true for advanced Elasticsearch search syntax (optional)</param> + /// <param name="languages">Set the used languages (optional)</param> + /// <param name="category">Set the category filter (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of SearchResultDtoPagedSearchResponse</returns> @@ -135,13 +135,13 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="query"> (optional)</param> - /// <param name="useAdvancedSyntax"> (optional)</param> - /// <param name="languages"> (optional)</param> - /// <param name="category"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="query">The search query (optional)</param> + /// <param name="useAdvancedSyntax">Set true for advanced Elasticsearch search syntax (optional)</param> + /// <param name="languages">Set the used languages (optional)</param> + /// <param name="category">Set the category filter (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (SearchResultDtoPagedSearchResponse)</returns> @@ -402,13 +402,13 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves a search result by given search parameters. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="query"> (optional)</param> - /// <param name="useAdvancedSyntax"> (optional)</param> - /// <param name="languages"> (optional)</param> - /// <param name="category"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="query">The search query (optional)</param> + /// <param name="useAdvancedSyntax">Set true for advanced Elasticsearch search syntax (optional)</param> + /// <param name="languages">Set the used languages (optional)</param> + /// <param name="category">Set the category filter (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>SearchResultDtoPagedSearchResponse</returns> public SearchResultDtoPagedSearchResponse GetSearchResults(string? query = default(string?), bool? useAdvancedSyntax = default(bool?), List<string>? languages = default(List<string>?), SearchCategoryType? category = default(SearchCategoryType?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -421,13 +421,13 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves a search result by given search parameters. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="query"> (optional)</param> - /// <param name="useAdvancedSyntax"> (optional)</param> - /// <param name="languages"> (optional)</param> - /// <param name="category"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="query">The search query (optional)</param> + /// <param name="useAdvancedSyntax">Set true for advanced Elasticsearch search syntax (optional)</param> + /// <param name="languages">Set the used languages (optional)</param> + /// <param name="category">Set the category filter (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of SearchResultDtoPagedSearchResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<SearchResultDtoPagedSearchResponse> GetSearchResultsWithHttpInfo(string? query = default(string?), bool? useAdvancedSyntax = default(bool?), List<string>? languages = default(List<string>?), SearchCategoryType? category = default(SearchCategoryType?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -511,13 +511,13 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves a search result by given search parameters. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="query"> (optional)</param> - /// <param name="useAdvancedSyntax"> (optional)</param> - /// <param name="languages"> (optional)</param> - /// <param name="category"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="query">The search query (optional)</param> + /// <param name="useAdvancedSyntax">Set true for advanced Elasticsearch search syntax (optional)</param> + /// <param name="languages">Set the used languages (optional)</param> + /// <param name="category">Set the category filter (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of SearchResultDtoPagedSearchResponse</returns> @@ -531,13 +531,13 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves a search result by given search parameters. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="query"> (optional)</param> - /// <param name="useAdvancedSyntax"> (optional)</param> - /// <param name="languages"> (optional)</param> - /// <param name="category"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="query">The search query (optional)</param> + /// <param name="useAdvancedSyntax">Set true for advanced Elasticsearch search syntax (optional)</param> + /// <param name="languages">Set the used languages (optional)</param> + /// <param name="category">Set the category filter (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (SearchResultDtoPagedSearchResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/SelfApi.cs b/src/Coscine.ApiClient.Core/Api/SelfApi.cs index 99afc33158cfd397acf91b2c2ed0a12754a50091..177c78e72bf069466148d6638e744e90b1de26f8 100644 --- a/src/Coscine.ApiClient.Core/Api/SelfApi.cs +++ b/src/Coscine.ApiClient.Core/Api/SelfApi.cs @@ -69,7 +69,7 @@ namespace Coscine.ApiClient.Core.Api /// Confirms the email of a user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="confirmationToken"></param> + /// <param name="confirmationToken">Gets or initializes the confirmation token for user email confirmation.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns></returns> void ConfirmUserEmail(Guid confirmationToken, int operationIndex = 0); @@ -81,7 +81,7 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="confirmationToken"></param> + /// <param name="confirmationToken">Gets or initializes the confirmation token for user email confirmation.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of Object(void)</returns> ApiResponse<Object> ConfirmUserEmailWithHttpInfo(Guid confirmationToken, int operationIndex = 0); @@ -107,7 +107,7 @@ namespace Coscine.ApiClient.Core.Api /// Initiates user merging for the current user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="identityProvider"></param> + /// <param name="identityProvider">The identity provider from which user data is to be merged.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>UserMergeDtoResponse</returns> UserMergeDtoResponse InitiateUserMerge(IdentityProviders identityProvider, int operationIndex = 0); @@ -119,7 +119,7 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="identityProvider"></param> + /// <param name="identityProvider">The identity provider from which user data is to be merged.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of UserMergeDtoResponse</returns> ApiResponse<UserMergeDtoResponse> InitiateUserMergeWithHttpInfo(IdentityProviders identityProvider, int operationIndex = 0); @@ -227,7 +227,7 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="confirmationToken"></param> + /// <param name="confirmationToken">Gets or initializes the confirmation token for user email confirmation.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of void</returns> @@ -240,7 +240,7 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="confirmationToken"></param> + /// <param name="confirmationToken">Gets or initializes the confirmation token for user email confirmation.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse</returns> @@ -275,7 +275,7 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="identityProvider"></param> + /// <param name="identityProvider">The identity provider from which user data is to be merged.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of UserMergeDtoResponse</returns> @@ -288,7 +288,7 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="identityProvider"></param> + /// <param name="identityProvider">The identity provider from which user data is to be merged.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (UserMergeDtoResponse)</returns> @@ -743,7 +743,7 @@ namespace Coscine.ApiClient.Core.Api /// Confirms the email of a user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="confirmationToken"></param> + /// <param name="confirmationToken">Gets or initializes the confirmation token for user email confirmation.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns></returns> public void ConfirmUserEmail(Guid confirmationToken, int operationIndex = 0) @@ -755,7 +755,7 @@ namespace Coscine.ApiClient.Core.Api /// Confirms the email of a user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="confirmationToken"></param> + /// <param name="confirmationToken">Gets or initializes the confirmation token for user email confirmation.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of Object(void)</returns> public Coscine.ApiClient.Core.Client.ApiResponse<Object> ConfirmUserEmailWithHttpInfo(Guid confirmationToken, int operationIndex = 0) @@ -810,7 +810,7 @@ namespace Coscine.ApiClient.Core.Api /// Confirms the email of a user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="confirmationToken"></param> + /// <param name="confirmationToken">Gets or initializes the confirmation token for user email confirmation.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of void</returns> @@ -823,7 +823,7 @@ namespace Coscine.ApiClient.Core.Api /// Confirms the email of a user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="confirmationToken"></param> + /// <param name="confirmationToken">Gets or initializes the confirmation token for user email confirmation.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse</returns> @@ -1019,7 +1019,7 @@ namespace Coscine.ApiClient.Core.Api /// Initiates user merging for the current user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="identityProvider"></param> + /// <param name="identityProvider">The identity provider from which user data is to be merged.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>UserMergeDtoResponse</returns> public UserMergeDtoResponse InitiateUserMerge(IdentityProviders identityProvider, int operationIndex = 0) @@ -1032,7 +1032,7 @@ namespace Coscine.ApiClient.Core.Api /// Initiates user merging for the current user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="identityProvider"></param> + /// <param name="identityProvider">The identity provider from which user data is to be merged.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of UserMergeDtoResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<UserMergeDtoResponse> InitiateUserMergeWithHttpInfo(IdentityProviders identityProvider, int operationIndex = 0) @@ -1095,7 +1095,7 @@ namespace Coscine.ApiClient.Core.Api /// Initiates user merging for the current user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="identityProvider"></param> + /// <param name="identityProvider">The identity provider from which user data is to be merged.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of UserMergeDtoResponse</returns> @@ -1109,7 +1109,7 @@ namespace Coscine.ApiClient.Core.Api /// Initiates user merging for the current user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="identityProvider"></param> + /// <param name="identityProvider">The identity provider from which user data is to be merged.</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (UserMergeDtoResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/SelfApiTokenApi.cs b/src/Coscine.ApiClient.Core/Api/SelfApiTokenApi.cs index e3faba48b6936436c1d6a99db609470afac0d943..b9c9594f65fb9e696983009356c37a8323d06092 100644 --- a/src/Coscine.ApiClient.Core/Api/SelfApiTokenApi.cs +++ b/src/Coscine.ApiClient.Core/Api/SelfApiTokenApi.cs @@ -69,9 +69,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all API tokens for the current authenticated user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiTokenDtoPagedResponse</returns> ApiTokenDtoPagedResponse GetAllApiTokens(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -83,9 +83,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ApiTokenDtoPagedResponse</returns> ApiResponse<ApiTokenDtoPagedResponse> GetAllApiTokensWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -193,9 +193,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiTokenDtoPagedResponse</returns> @@ -208,9 +208,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ApiTokenDtoPagedResponse)</returns> @@ -671,9 +671,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all API tokens for the current authenticated user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiTokenDtoPagedResponse</returns> public ApiTokenDtoPagedResponse GetAllApiTokens(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -686,9 +686,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all API tokens for the current authenticated user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of ApiTokenDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<ApiTokenDtoPagedResponse> GetAllApiTokensWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -756,9 +756,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all API tokens for the current authenticated user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiTokenDtoPagedResponse</returns> @@ -772,9 +772,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all API tokens for the current authenticated user. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (ApiTokenDtoPagedResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/TitleApi.cs b/src/Coscine.ApiClient.Core/Api/TitleApi.cs index f4a08cd9c388556f3563a9abea8c33f0d201c314..385d3838e383f64649b010aa902e846e6e7a84d7 100644 --- a/src/Coscine.ApiClient.Core/Api/TitleApi.cs +++ b/src/Coscine.ApiClient.Core/Api/TitleApi.cs @@ -69,12 +69,12 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all titles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> - /// <returns>TitleDtoPagedResponse</returns> - TitleDtoPagedResponse GetTitles(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); + /// <returns>TitleDtoIEnumerableResponse</returns> + TitleDtoIEnumerableResponse GetTitles(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); /// <summary> /// Retrieves all titles. @@ -83,12 +83,12 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> - /// <returns>ApiResponse of TitleDtoPagedResponse</returns> - ApiResponse<TitleDtoPagedResponse> GetTitlesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); + /// <returns>ApiResponse of TitleDtoIEnumerableResponse</returns> + ApiResponse<TitleDtoIEnumerableResponse> GetTitlesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); #endregion Synchronous Operations } @@ -153,13 +153,13 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> - /// <returns>Task of TitleDtoPagedResponse</returns> - System.Threading.Tasks.Task<TitleDtoPagedResponse> GetTitlesAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + /// <returns>Task of TitleDtoIEnumerableResponse</returns> + System.Threading.Tasks.Task<TitleDtoIEnumerableResponse> GetTitlesAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Retrieves all titles. @@ -168,13 +168,13 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> - /// <returns>Task of ApiResponse (TitleDtoPagedResponse)</returns> - System.Threading.Tasks.Task<ApiResponse<TitleDtoPagedResponse>> GetTitlesWithHttpInfoAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + /// <returns>Task of ApiResponse (TitleDtoIEnumerableResponse)</returns> + System.Threading.Tasks.Task<ApiResponse<TitleDtoIEnumerableResponse>> GetTitlesWithHttpInfoAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -575,14 +575,14 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all titles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> - /// <returns>TitleDtoPagedResponse</returns> - public TitleDtoPagedResponse GetTitles(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) + /// <returns>TitleDtoIEnumerableResponse</returns> + public TitleDtoIEnumerableResponse GetTitles(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) { - Coscine.ApiClient.Core.Client.ApiResponse<TitleDtoPagedResponse> localVarResponse = GetTitlesWithHttpInfo(pageNumber, pageSize, orderBy); + Coscine.ApiClient.Core.Client.ApiResponse<TitleDtoIEnumerableResponse> localVarResponse = GetTitlesWithHttpInfo(pageNumber, pageSize, orderBy); return localVarResponse.Data; } @@ -590,12 +590,12 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all titles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> - /// <returns>ApiResponse of TitleDtoPagedResponse</returns> - public Coscine.ApiClient.Core.Client.ApiResponse<TitleDtoPagedResponse> GetTitlesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) + /// <returns>ApiResponse of TitleDtoIEnumerableResponse</returns> + public Coscine.ApiClient.Core.Client.ApiResponse<TitleDtoIEnumerableResponse> GetTitlesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) { Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -643,7 +643,7 @@ namespace Coscine.ApiClient.Core.Api } // make the HTTP request - var localVarResponse = this.Client.Get<TitleDtoPagedResponse>("/api/v2/titles", localVarRequestOptions, this.Configuration); + var localVarResponse = this.Client.Get<TitleDtoIEnumerableResponse>("/api/v2/titles", localVarRequestOptions, this.Configuration); if (this.ExceptionFactory != null) { Exception _exception = this.ExceptionFactory("GetTitles", localVarResponse); @@ -660,15 +660,15 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all titles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> - /// <returns>Task of TitleDtoPagedResponse</returns> - public async System.Threading.Tasks.Task<TitleDtoPagedResponse> GetTitlesAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + /// <returns>Task of TitleDtoIEnumerableResponse</returns> + public async System.Threading.Tasks.Task<TitleDtoIEnumerableResponse> GetTitlesAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Coscine.ApiClient.Core.Client.ApiResponse<TitleDtoPagedResponse> localVarResponse = await GetTitlesWithHttpInfoAsync(pageNumber, pageSize, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); + Coscine.ApiClient.Core.Client.ApiResponse<TitleDtoIEnumerableResponse> localVarResponse = await GetTitlesWithHttpInfoAsync(pageNumber, pageSize, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -676,13 +676,13 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all titles. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> - /// <returns>Task of ApiResponse (TitleDtoPagedResponse)</returns> - public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<TitleDtoPagedResponse>> GetTitlesWithHttpInfoAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + /// <returns>Task of ApiResponse (TitleDtoIEnumerableResponse)</returns> + public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<TitleDtoIEnumerableResponse>> GetTitlesWithHttpInfoAsync(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { Coscine.ApiClient.Core.Client.RequestOptions localVarRequestOptions = new Coscine.ApiClient.Core.Client.RequestOptions(); @@ -731,7 +731,7 @@ namespace Coscine.ApiClient.Core.Api } // make the HTTP request - var localVarResponse = await this.AsynchronousClient.GetAsync<TitleDtoPagedResponse>("/api/v2/titles", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); + var localVarResponse = await this.AsynchronousClient.GetAsync<TitleDtoIEnumerableResponse>("/api/v2/titles", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false); if (this.ExceptionFactory != null) { diff --git a/src/Coscine.ApiClient.Core/Api/TreeApi.cs b/src/Coscine.ApiClient.Core/Api/TreeApi.cs index 3730de7b36094a668a0496ce7f78b188d2ad3e96..03ab0f5d7229b4ecec0b9571c5f566cce17bddad 100644 --- a/src/Coscine.ApiClient.Core/Api/TreeApi.cs +++ b/src/Coscine.ApiClient.Core/Api/TreeApi.cs @@ -82,10 +82,10 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the file tree. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>FileTreeDtoPagedResponse</returns> FileTreeDtoPagedResponse GetFileTree(string projectId, Guid resourceId, string? path = default(string?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -99,10 +99,10 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the file tree. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of FileTreeDtoPagedResponse</returns> ApiResponse<FileTreeDtoPagedResponse> GetFileTreeWithHttpInfo(string projectId, Guid resourceId, string? path = default(string?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -112,11 +112,11 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="format"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the metadata tree. (optional)</param> + /// <param name="format">Gets or sets the format of the RDF data. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>MetadataTreeDtoPagedResponse</returns> MetadataTreeDtoPagedResponse GetMetadataTree(string projectId, Guid resourceId, string? path = default(string?), RdfFormat? format = default(RdfFormat?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -130,11 +130,11 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="format"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the metadata tree. (optional)</param> + /// <param name="format">Gets or sets the format of the RDF data. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of MetadataTreeDtoPagedResponse</returns> ApiResponse<MetadataTreeDtoPagedResponse> GetMetadataTreeWithHttpInfo(string projectId, Guid resourceId, string? path = default(string?), RdfFormat? format = default(RdfFormat?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -236,10 +236,10 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the file tree. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of FileTreeDtoPagedResponse</returns> @@ -254,10 +254,10 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the file tree. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (FileTreeDtoPagedResponse)</returns> @@ -271,11 +271,11 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="format"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the metadata tree. (optional)</param> + /// <param name="format">Gets or sets the format of the RDF data. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of MetadataTreeDtoPagedResponse</returns> @@ -290,11 +290,11 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="format"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the metadata tree. (optional)</param> + /// <param name="format">Gets or sets the format of the RDF data. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (MetadataTreeDtoPagedResponse)</returns> @@ -796,10 +796,10 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the file tree. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>FileTreeDtoPagedResponse</returns> public FileTreeDtoPagedResponse GetFileTree(string projectId, Guid resourceId, string? path = default(string?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -814,10 +814,10 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the file tree. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of FileTreeDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<FileTreeDtoPagedResponse> GetFileTreeWithHttpInfo(string projectId, Guid resourceId, string? path = default(string?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -899,10 +899,10 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the file tree. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of FileTreeDtoPagedResponse</returns> @@ -918,10 +918,10 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the file tree. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (FileTreeDtoPagedResponse)</returns> @@ -1006,11 +1006,11 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="format"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the metadata tree. (optional)</param> + /// <param name="format">Gets or sets the format of the RDF data. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>MetadataTreeDtoPagedResponse</returns> public MetadataTreeDtoPagedResponse GetMetadataTree(string projectId, Guid resourceId, string? path = default(string?), RdfFormat? format = default(RdfFormat?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -1025,11 +1025,11 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="format"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the metadata tree. (optional)</param> + /// <param name="format">Gets or sets the format of the RDF data. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of MetadataTreeDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<MetadataTreeDtoPagedResponse> GetMetadataTreeWithHttpInfo(string projectId, Guid resourceId, string? path = default(string?), RdfFormat? format = default(RdfFormat?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -1115,11 +1115,11 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="format"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the metadata tree. (optional)</param> + /// <param name="format">Gets or sets the format of the RDF data. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of MetadataTreeDtoPagedResponse</returns> @@ -1135,11 +1135,11 @@ namespace Coscine.ApiClient.Core.Api /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> /// <param name="projectId">The unique identifier or slug of the project.</param> /// <param name="resourceId">The unique identifier of the resource.</param> - /// <param name="path"> (optional)</param> - /// <param name="format"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="path">Gets or sets the path of the metadata tree. (optional)</param> + /// <param name="format">Gets or sets the format of the RDF data. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (MetadataTreeDtoPagedResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/UserApi.cs b/src/Coscine.ApiClient.Core/Api/UserApi.cs index b647d161b4f492ae1ec3d0c31d778ebfdd4fc63d..02d904fefb41eb473df41a1fb3942f5baf968556 100644 --- a/src/Coscine.ApiClient.Core/Api/UserApi.cs +++ b/src/Coscine.ApiClient.Core/Api/UserApi.cs @@ -49,8 +49,8 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all users. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"></param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term.</param> + /// <param name="orderBy">Gets or sets the field by which the search results are ordered. Defaults to \"firstName\". (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>PublicUserDtoIEnumerableResponse</returns> PublicUserDtoIEnumerableResponse GetUsers(string searchTerm, string? orderBy = default(string?), int operationIndex = 0); @@ -62,8 +62,8 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"></param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term.</param> + /// <param name="orderBy">Gets or sets the field by which the search results are ordered. Defaults to \"firstName\". (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of PublicUserDtoIEnumerableResponse</returns> ApiResponse<PublicUserDtoIEnumerableResponse> GetUsersWithHttpInfo(string searchTerm, string? orderBy = default(string?), int operationIndex = 0); @@ -106,8 +106,8 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"></param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term.</param> + /// <param name="orderBy">Gets or sets the field by which the search results are ordered. Defaults to \"firstName\". (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of PublicUserDtoIEnumerableResponse</returns> @@ -120,8 +120,8 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"></param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term.</param> + /// <param name="orderBy">Gets or sets the field by which the search results are ordered. Defaults to \"firstName\". (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (PublicUserDtoIEnumerableResponse)</returns> @@ -382,8 +382,8 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all users. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"></param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term.</param> + /// <param name="orderBy">Gets or sets the field by which the search results are ordered. Defaults to \"firstName\". (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>PublicUserDtoIEnumerableResponse</returns> public PublicUserDtoIEnumerableResponse GetUsers(string searchTerm, string? orderBy = default(string?), int operationIndex = 0) @@ -396,8 +396,8 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all users. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"></param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term.</param> + /// <param name="orderBy">Gets or sets the field by which the search results are ordered. Defaults to \"firstName\". (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of PublicUserDtoIEnumerableResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<PublicUserDtoIEnumerableResponse> GetUsersWithHttpInfo(string searchTerm, string? orderBy = default(string?), int operationIndex = 0) @@ -464,8 +464,8 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all users. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"></param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term.</param> + /// <param name="orderBy">Gets or sets the field by which the search results are ordered. Defaults to \"firstName\". (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of PublicUserDtoIEnumerableResponse</returns> @@ -479,8 +479,8 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all users. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"></param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term.</param> + /// <param name="orderBy">Gets or sets the field by which the search results are ordered. Defaults to \"firstName\". (optional)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (PublicUserDtoIEnumerableResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/VisibilityApi.cs b/src/Coscine.ApiClient.Core/Api/VisibilityApi.cs index 467cd9ab9829cb915cb2f00133108448832e9efc..6d3685b8d6305ff6748fe478f88e5d7cc05d0581 100644 --- a/src/Coscine.ApiClient.Core/Api/VisibilityApi.cs +++ b/src/Coscine.ApiClient.Core/Api/VisibilityApi.cs @@ -49,9 +49,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all visibilities. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>VisibilityDtoPagedResponse</returns> VisibilityDtoPagedResponse GetVisibilities(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -63,9 +63,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of VisibilityDtoPagedResponse</returns> ApiResponse<VisibilityDtoPagedResponse> GetVisibilitiesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -128,9 +128,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of VisibilityDtoPagedResponse</returns> @@ -143,9 +143,9 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (VisibilityDtoPagedResponse)</returns> @@ -431,9 +431,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all visibilities. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>VisibilityDtoPagedResponse</returns> public VisibilityDtoPagedResponse GetVisibilities(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -446,9 +446,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all visibilities. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of VisibilityDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<VisibilityDtoPagedResponse> GetVisibilitiesWithHttpInfo(int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -516,9 +516,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all visibilities. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of VisibilityDtoPagedResponse</returns> @@ -532,9 +532,9 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves all visibilities. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (VisibilityDtoPagedResponse)</returns> diff --git a/src/Coscine.ApiClient.Core/Api/VocabularyApi.cs b/src/Coscine.ApiClient.Core/Api/VocabularyApi.cs index 3090f0d5c44d87d3fe191ed7f0461115b177baa6..81bfaf8246801c210bd8b3c529029b1e7d2079cd 100644 --- a/src/Coscine.ApiClient.Core/Api/VocabularyApi.cs +++ b/src/Coscine.ApiClient.Core/Api/VocabularyApi.cs @@ -49,11 +49,11 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves top-level instances from vocabularies. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabularies. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabularies are requested. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>VocabularyDtoPagedResponse</returns> VocabularyDtoPagedResponse GetVocabularies(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -65,11 +65,11 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabularies. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabularies are requested. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of VocabularyDtoPagedResponse</returns> ApiResponse<VocabularyDtoPagedResponse> GetVocabulariesWithHttpInfo(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); @@ -102,15 +102,15 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves vocabulary instances. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="varClass"></param> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="varClass">Gets or sets the URI class, which is a required field.</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabulary instances. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabulary instances are requested. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `150`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>VocabularyInstanceDtoPagedResponse</returns> - VocabularyInstanceDtoPagedResponse GetVocabularyInstances(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); + VocabularyInstanceDtoPagedResponse GetVocabularyInstances(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0); /// <summary> /// Retrieves vocabulary instances. @@ -119,15 +119,15 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="varClass"></param> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="varClass">Gets or sets the URI class, which is a required field.</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabulary instances. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabulary instances are requested. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `150`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of VocabularyInstanceDtoPagedResponse</returns> - ApiResponse<VocabularyInstanceDtoPagedResponse> GetVocabularyInstancesWithHttpInfo(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0); + ApiResponse<VocabularyInstanceDtoPagedResponse> GetVocabularyInstancesWithHttpInfo(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0); #endregion Synchronous Operations } @@ -167,11 +167,11 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabularies. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabularies are requested. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of VocabularyDtoPagedResponse</returns> @@ -184,11 +184,11 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabularies. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabularies are requested. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (VocabularyDtoPagedResponse)</returns> @@ -227,16 +227,16 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="varClass"></param> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="varClass">Gets or sets the URI class, which is a required field.</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabulary instances. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabulary instances are requested. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `150`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of VocabularyInstanceDtoPagedResponse</returns> - System.Threading.Tasks.Task<VocabularyInstanceDtoPagedResponse> GetVocabularyInstancesAsync(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<VocabularyInstanceDtoPagedResponse> GetVocabularyInstancesAsync(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); /// <summary> /// Retrieves vocabulary instances. @@ -245,16 +245,16 @@ namespace Coscine.ApiClient.Core.Api /// /// </remarks> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="varClass"></param> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="varClass">Gets or sets the URI class, which is a required field.</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabulary instances. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabulary instances are requested. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `150`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (VocabularyInstanceDtoPagedResponse)</returns> - System.Threading.Tasks.Task<ApiResponse<VocabularyInstanceDtoPagedResponse>> GetVocabularyInstancesWithHttpInfoAsync(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); + System.Threading.Tasks.Task<ApiResponse<VocabularyInstanceDtoPagedResponse>> GetVocabularyInstancesWithHttpInfoAsync(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)); #endregion Asynchronous Operations } @@ -511,11 +511,11 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves top-level instances from vocabularies. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabularies. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabularies are requested. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>VocabularyDtoPagedResponse</returns> public VocabularyDtoPagedResponse GetVocabularies(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -528,11 +528,11 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves top-level instances from vocabularies. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabularies. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabularies are requested. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of VocabularyDtoPagedResponse</returns> public Coscine.ApiClient.Core.Client.ApiResponse<VocabularyDtoPagedResponse> GetVocabulariesWithHttpInfo(string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) @@ -608,11 +608,11 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves top-level instances from vocabularies. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabularies. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabularies are requested. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of VocabularyDtoPagedResponse</returns> @@ -626,11 +626,11 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves top-level instances from vocabularies. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabularies. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabularies are requested. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="pageSize">The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (VocabularyDtoPagedResponse)</returns> @@ -877,17 +877,17 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves vocabulary instances. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="varClass"></param> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="varClass">Gets or sets the URI class, which is a required field.</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabulary instances. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabulary instances are requested. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `150`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>VocabularyInstanceDtoPagedResponse</returns> - public VocabularyInstanceDtoPagedResponse GetVocabularyInstances(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) + public VocabularyInstanceDtoPagedResponse GetVocabularyInstances(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0) { - Coscine.ApiClient.Core.Client.ApiResponse<VocabularyInstanceDtoPagedResponse> localVarResponse = GetVocabularyInstancesWithHttpInfo(varClass, searchTerm, language, pageNumber, pageSize, orderBy); + Coscine.ApiClient.Core.Client.ApiResponse<VocabularyInstanceDtoPagedResponse> localVarResponse = GetVocabularyInstancesWithHttpInfo(varClass, searchTerm, language, pageSize, pageNumber, orderBy); return localVarResponse.Data; } @@ -895,15 +895,15 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves vocabulary instances. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="varClass"></param> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="varClass">Gets or sets the URI class, which is a required field.</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabulary instances. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabulary instances are requested. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `150`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <returns>ApiResponse of VocabularyInstanceDtoPagedResponse</returns> - public Coscine.ApiClient.Core.Client.ApiResponse<VocabularyInstanceDtoPagedResponse> GetVocabularyInstancesWithHttpInfo(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0) + public Coscine.ApiClient.Core.Client.ApiResponse<VocabularyInstanceDtoPagedResponse> GetVocabularyInstancesWithHttpInfo(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0) { // verify the required parameter 'varClass' is set if (varClass == null) @@ -943,14 +943,14 @@ namespace Coscine.ApiClient.Core.Api { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "Language", language)); } - if (pageNumber != null) - { - localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); - } if (pageSize != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageSize", pageSize)); } + if (pageNumber != null) + { + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); + } if (orderBy != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "OrderBy", orderBy)); @@ -983,18 +983,18 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves vocabulary instances. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="varClass"></param> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="varClass">Gets or sets the URI class, which is a required field.</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabulary instances. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabulary instances are requested. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `150`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of VocabularyInstanceDtoPagedResponse</returns> - public async System.Threading.Tasks.Task<VocabularyInstanceDtoPagedResponse> GetVocabularyInstancesAsync(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<VocabularyInstanceDtoPagedResponse> GetVocabularyInstancesAsync(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { - Coscine.ApiClient.Core.Client.ApiResponse<VocabularyInstanceDtoPagedResponse> localVarResponse = await GetVocabularyInstancesWithHttpInfoAsync(varClass, searchTerm, language, pageNumber, pageSize, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); + Coscine.ApiClient.Core.Client.ApiResponse<VocabularyInstanceDtoPagedResponse> localVarResponse = await GetVocabularyInstancesWithHttpInfoAsync(varClass, searchTerm, language, pageSize, pageNumber, orderBy, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -1002,16 +1002,16 @@ namespace Coscine.ApiClient.Core.Api /// Retrieves vocabulary instances. /// </summary> /// <exception cref="Coscine.ApiClient.Core.Client.ApiException">Thrown when fails to make API call</exception> - /// <param name="varClass"></param> - /// <param name="searchTerm"> (optional)</param> - /// <param name="language"> (optional)</param> - /// <param name="pageNumber"> (optional)</param> - /// <param name="pageSize"> (optional)</param> - /// <param name="orderBy"> (optional)</param> + /// <param name="varClass">Gets or sets the URI class, which is a required field.</param> + /// <param name="searchTerm">Gets or sets the search term used to filter vocabulary instances. (optional)</param> + /// <param name="language">Gets or sets the language for which the vocabulary instances are requested. (optional)</param> + /// <param name="pageSize">Number of items per page. The maximum number of items per page is `150`. (optional)</param> + /// <param name="pageNumber">The desired page number. Should be greater than or equal to 1. Default is 1. (optional)</param> + /// <param name="orderBy">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)</param> /// <param name="operationIndex">Index associated with the operation.</param> /// <param name="cancellationToken">Cancellation Token to cancel the request.</param> /// <returns>Task of ApiResponse (VocabularyInstanceDtoPagedResponse)</returns> - public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<VocabularyInstanceDtoPagedResponse>> GetVocabularyInstancesWithHttpInfoAsync(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageNumber = default(int?), int? pageSize = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task<Coscine.ApiClient.Core.Client.ApiResponse<VocabularyInstanceDtoPagedResponse>> GetVocabularyInstancesWithHttpInfoAsync(string varClass, string? searchTerm = default(string?), AcceptedLanguage? language = default(AcceptedLanguage?), int? pageSize = default(int?), int? pageNumber = default(int?), string? orderBy = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { // verify the required parameter 'varClass' is set if (varClass == null) @@ -1052,14 +1052,14 @@ namespace Coscine.ApiClient.Core.Api { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "Language", language)); } - if (pageNumber != null) - { - localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); - } if (pageSize != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageSize", pageSize)); } + if (pageNumber != null) + { + localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "PageNumber", pageNumber)); + } if (orderBy != null) { localVarRequestOptions.QueryParameters.Add(Coscine.ApiClient.Core.Client.ClientUtils.ParameterToMultiMap("", "OrderBy", orderBy)); diff --git a/src/Coscine.ApiClient.Core/Coscine.ApiClient.Core.csproj b/src/Coscine.ApiClient.Core/Coscine.ApiClient.Core.csproj index e6fbdbc1b4eb179a10ddb2c9d93b1bd96110ff0d..221fa5d3f4664458b82e3031568b3817b994ac62 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.2.1</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/AcceptedLanguage.cs b/src/Coscine.ApiClient.Core/Model/AcceptedLanguage.cs index af1a5346cc6888da45dfbf72bda7afcf91b25e47..03ad559ecac8ea859ee28aa00b0aab7c9ffdf863 100644 --- a/src/Coscine.ApiClient.Core/Model/AcceptedLanguage.cs +++ b/src/Coscine.ApiClient.Core/Model/AcceptedLanguage.cs @@ -27,8 +27,9 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// Defines AcceptedLanguage + /// Accepted languages by the API. /// </summary> + /// <value>Accepted languages by the API.</value> [JsonConverter(typeof(StringEnumConverter))] public enum AcceptedLanguage { diff --git a/src/Coscine.ApiClient.Core/Model/ApiTokenDto.cs b/src/Coscine.ApiClient.Core/Model/ApiTokenDto.cs index b07bcfa90c5b796ed65e65a9a19d25830b5bb9c0..fe8a6c224b8ba8599908e3227c420763adec6590 100644 --- a/src/Coscine.ApiClient.Core/Model/ApiTokenDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ApiTokenDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ApiTokenDto + /// Represents an API token used for authentication. /// </summary> [DataContract(Name = "ApiTokenDto")] public partial class ApiTokenDto : IEquatable<ApiTokenDto>, IValidatableObject @@ -35,11 +35,11 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ApiTokenDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="name">name.</param> - /// <param name="creationDate">creationDate.</param> - /// <param name="expiryDate">expiryDate.</param> - /// <param name="token">token.</param> + /// <param name="id">The unique identifier of the API token..</param> + /// <param name="name">The name associated with the API token..</param> + /// <param name="creationDate">The date when the API token was created..</param> + /// <param name="expiryDate">The expiry date of the API token..</param> + /// <param name="token">The actual token used for authentication..</param> /// <param name="owner">owner.</param> public ApiTokenDto(Guid id = default(Guid), string name = default(string), DateTime creationDate = default(DateTime), DateTime expiryDate = default(DateTime), string token = default(string), UserMinimalDto owner = default(UserMinimalDto)) { @@ -52,32 +52,37 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// The unique identifier of the API token. /// </summary> + /// <value>The unique identifier of the API token.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets Name + /// The name associated with the API token. /// </summary> + /// <value>The name associated with the API token.</value> [DataMember(Name = "name", EmitDefaultValue = false)] public string Name { get; set; } /// <summary> - /// Gets or Sets CreationDate + /// The date when the API token was created. /// </summary> + /// <value>The date when the API token was created.</value> [DataMember(Name = "creationDate", EmitDefaultValue = false)] public DateTime CreationDate { get; set; } /// <summary> - /// Gets or Sets ExpiryDate + /// The expiry date of the API token. /// </summary> + /// <value>The expiry date of the API token.</value> [DataMember(Name = "expiryDate", EmitDefaultValue = false)] public DateTime ExpiryDate { get; set; } /// <summary> - /// Gets or Sets Token + /// The actual token used for authentication. /// </summary> + /// <value>The actual token used for authentication.</value> [DataMember(Name = "token", EmitDefaultValue = true)] public string Token { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ApiTokenForCreationDto.cs b/src/Coscine.ApiClient.Core/Model/ApiTokenForCreationDto.cs index 054920dfc776f8d6b4b97a52b79bb373091c91ec..6f1da95549f393ce0d93645a0909db498d0bf3f5 100644 --- a/src/Coscine.ApiClient.Core/Model/ApiTokenForCreationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ApiTokenForCreationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ApiTokenForCreationDto + /// Data transfer object (DTO) representing the creation of an API token. /// </summary> [DataContract(Name = "ApiTokenForCreationDto")] public partial class ApiTokenForCreationDto : IEquatable<ApiTokenForCreationDto>, IValidatableObject @@ -40,8 +40,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ApiTokenForCreationDto" /> class. /// </summary> - /// <param name="name">name (required).</param> - /// <param name="expiresInDays">expiresInDays (required).</param> + /// <param name="name">Gets or sets the name of the API token. (required).</param> + /// <param name="expiresInDays">Gets or sets the expiration duration of the token in days. (required).</param> public ApiTokenForCreationDto(string name = default(string), int expiresInDays = default(int)) { // to ensure "name" is required (not null) @@ -54,14 +54,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Name + /// Gets or sets the name of the API token. /// </summary> + /// <value>Gets or sets the name of the API token.</value> [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> - /// Gets or Sets ExpiresInDays + /// Gets or sets the expiration duration of the token in days. /// </summary> + /// <value>Gets or sets the expiration duration of the token in days.</value> [DataMember(Name = "expiresInDays", IsRequired = true, EmitDefaultValue = true)] public int ExpiresInDays { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ApplicationProfileDto.cs b/src/Coscine.ApiClient.Core/Model/ApplicationProfileDto.cs index 4f208400c4cc1f1ef18afd31ed0b55670e0c7f0e..04bdb34487f546cc6b7d8f0941738be61962fabf 100644 --- a/src/Coscine.ApiClient.Core/Model/ApplicationProfileDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ApplicationProfileDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ApplicationProfileDto + /// Represents an application profile data transfer object. /// </summary> [DataContract(Name = "ApplicationProfileDto")] public partial class ApplicationProfileDto : IEquatable<ApplicationProfileDto>, IValidatableObject @@ -35,9 +35,9 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ApplicationProfileDto" /> class. /// </summary> - /// <param name="uri">uri.</param> - /// <param name="displayName">displayName.</param> - /// <param name="description">description.</param> + /// <param name="uri">The URI associated with the application profile..</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)) { @@ -48,20 +48,23 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Uri + /// The URI associated with the application profile. /// </summary> + /// <value>The URI associated with the application profile.</value> [DataMember(Name = "uri", EmitDefaultValue = false)] public string Uri { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// The display name for the application profile. /// </summary> + /// <value>The display name for the application profile.</value> [DataMember(Name = "displayName", EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Description + /// The description of the application profile. /// </summary> + /// <value>The description of the application profile.</value> [DataMember(Name = "description", EmitDefaultValue = true)] public string Description { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ApplicationProfileForCreationDto.cs b/src/Coscine.ApiClient.Core/Model/ApplicationProfileForCreationDto.cs index 4ce652ee3441c1843058fa858daad4f8a58c62c1..e599b6a29051cee09a336e0dd6b2ab914847080b 100644 --- a/src/Coscine.ApiClient.Core/Model/ApplicationProfileForCreationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ApplicationProfileForCreationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ApplicationProfileForCreationDto + /// Data transfer object (DTO) representing the creation of an application profile. /// </summary> [DataContract(Name = "ApplicationProfileForCreationDto")] public partial class ApplicationProfileForCreationDto : IEquatable<ApplicationProfileForCreationDto>, IValidatableObject @@ -40,8 +40,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ApplicationProfileForCreationDto" /> class. /// </summary> - /// <param name="name">name (required).</param> - /// <param name="uri">uri (required).</param> + /// <param name="name">Gets or initializes the name of the application profile. (required).</param> + /// <param name="uri">Gets or initializes the URI of the application profile. (required).</param> /// <param name="definition">definition (required).</param> public ApplicationProfileForCreationDto(string name = default(string), string uri = default(string), RdfDefinitionForManipulationDto definition = default(RdfDefinitionForManipulationDto)) { @@ -66,14 +66,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Name + /// Gets or initializes the name of the application profile. /// </summary> + /// <value>Gets or initializes the name of the application profile.</value> [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> - /// Gets or Sets Uri + /// Gets or initializes the URI of the application profile. /// </summary> + /// <value>Gets or initializes the URI of the application profile.</value> [DataMember(Name = "uri", IsRequired = true, EmitDefaultValue = true)] public string Uri { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ApplicationProfileForResourceCreationDto.cs b/src/Coscine.ApiClient.Core/Model/ApplicationProfileForResourceCreationDto.cs index 2ba695c477fb64a5651ec26ec58dd9bcdafe401f..e9a8b1f4099c05f22d21c026f76fc7bf6a111fe7 100644 --- a/src/Coscine.ApiClient.Core/Model/ApplicationProfileForResourceCreationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ApplicationProfileForResourceCreationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ApplicationProfileForResourceCreationDto + /// Data transfer object (DTO) representing the creation of an application profile for a resource. /// </summary> [DataContract(Name = "ApplicationProfileForResourceCreationDto")] public partial class ApplicationProfileForResourceCreationDto : IEquatable<ApplicationProfileForResourceCreationDto>, IValidatableObject @@ -40,7 +40,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ApplicationProfileForResourceCreationDto" /> class. /// </summary> - /// <param name="uri">uri (required).</param> + /// <param name="uri">Gets or initializes the URI of the resource for the application profile. (required).</param> public ApplicationProfileForResourceCreationDto(string uri = default(string)) { // to ensure "uri" is required (not null) @@ -52,8 +52,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Uri + /// Gets or initializes the URI of the resource for the application profile. /// </summary> + /// <value>Gets or initializes the URI of the resource for the application profile.</value> [DataMember(Name = "uri", IsRequired = true, EmitDefaultValue = true)] public string Uri { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ApplicationProfileMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/ApplicationProfileMinimalDto.cs index 992b63cdad5ab7841f319c547a8221de2933f1d4..cf10f7710ba13e03b05048ceb1eec82b1215e773 100644 --- a/src/Coscine.ApiClient.Core/Model/ApplicationProfileMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ApplicationProfileMinimalDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ApplicationProfileMinimalDto + /// Represents a minimalistic application profile data transfer object. /// </summary> [DataContract(Name = "ApplicationProfileMinimalDto")] public partial class ApplicationProfileMinimalDto : IEquatable<ApplicationProfileMinimalDto>, IValidatableObject @@ -35,15 +35,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ApplicationProfileMinimalDto" /> class. /// </summary> - /// <param name="uri">uri.</param> + /// <param name="uri">The URI associated with the application profile..</param> public ApplicationProfileMinimalDto(string uri = default(string)) { this.Uri = uri; } /// <summary> - /// Gets or Sets Uri + /// The URI associated with the application profile. /// </summary> + /// <value>The URI associated with the application profile.</value> [DataMember(Name = "uri", EmitDefaultValue = false)] public string Uri { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/DisciplineDto.cs b/src/Coscine.ApiClient.Core/Model/DisciplineDto.cs index b69eb8ae9388841dfc20c0022648be03bb8667fd..afe6f02387ab81e2aac77c970fe627ba5e97a8ea 100644 --- a/src/Coscine.ApiClient.Core/Model/DisciplineDto.cs +++ b/src/Coscine.ApiClient.Core/Model/DisciplineDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// DisciplineDto + /// Represents the data transfer object for a discipline. /// </summary> [DataContract(Name = "DisciplineDto")] public partial class DisciplineDto : IEquatable<DisciplineDto>, IValidatableObject @@ -35,10 +35,10 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="DisciplineDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="uri">uri.</param> - /// <param name="displayNameDe">displayNameDe.</param> - /// <param name="displayNameEn">displayNameEn.</param> + /// <param name="id">The unique identifier for the discipline..</param> + /// <param name="uri">The URI associated with the discipline..</param> + /// <param name="displayNameDe">The display name of the discipline in German..</param> + /// <param name="displayNameEn">The display name of the discipline in English..</param> public DisciplineDto(Guid id = default(Guid), string uri = default(string), string displayNameDe = default(string), string displayNameEn = default(string)) { this.Id = id; @@ -48,26 +48,30 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// The unique identifier for the discipline. /// </summary> + /// <value>The unique identifier for the discipline.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets Uri + /// The URI associated with the discipline. /// </summary> + /// <value>The URI associated with the discipline.</value> [DataMember(Name = "uri", EmitDefaultValue = false)] public string Uri { get; set; } /// <summary> - /// Gets or Sets DisplayNameDe + /// The display name of the discipline in German. /// </summary> + /// <value>The display name of the discipline in German.</value> [DataMember(Name = "displayNameDe", EmitDefaultValue = false)] public string DisplayNameDe { get; set; } /// <summary> - /// Gets or Sets DisplayNameEn + /// The display name of the discipline in English. /// </summary> + /// <value>The display name of the discipline in English.</value> [DataMember(Name = "displayNameEn", EmitDefaultValue = false)] public string DisplayNameEn { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/DisciplineForProjectManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/DisciplineForProjectManipulationDto.cs index 3ed20fcb9014b87936051fa6bcd4a1c37fea62a2..c753c7c734a16c835e9cbc8db114cbb933e6adf9 100644 --- a/src/Coscine.ApiClient.Core/Model/DisciplineForProjectManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/DisciplineForProjectManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// DisciplineForProjectManipulationDto + /// Data transfer object (DTO) representing a discipline for project manipulation. /// </summary> [DataContract(Name = "DisciplineForProjectManipulationDto")] public partial class DisciplineForProjectManipulationDto : IEquatable<DisciplineForProjectManipulationDto>, IValidatableObject @@ -40,15 +40,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="DisciplineForProjectManipulationDto" /> class. /// </summary> - /// <param name="id">id (required).</param> + /// <param name="id">Gets or initializes the identifier of the discipline. (required).</param> public DisciplineForProjectManipulationDto(Guid id = default(Guid)) { this.Id = id; } /// <summary> - /// Gets or Sets Id + /// Gets or initializes the identifier of the discipline. /// </summary> + /// <value>Gets or initializes the identifier of the discipline.</value> [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/DisciplineForResourceManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/DisciplineForResourceManipulationDto.cs index 8637516c89535bb75ef2256806e2cc38eaaf089f..0046e7c6f386f8eafd4ca77ef9356be84ad5b2a4 100644 --- a/src/Coscine.ApiClient.Core/Model/DisciplineForResourceManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/DisciplineForResourceManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// DisciplineForResourceManipulationDto + /// Data transfer object (DTO) representing a discipline for resource manipulation. /// </summary> [DataContract(Name = "DisciplineForResourceManipulationDto")] public partial class DisciplineForResourceManipulationDto : IEquatable<DisciplineForResourceManipulationDto>, IValidatableObject @@ -40,15 +40,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="DisciplineForResourceManipulationDto" /> class. /// </summary> - /// <param name="id">id (required).</param> + /// <param name="id">Gets or initializes the identifier of the discipline. (required).</param> public DisciplineForResourceManipulationDto(Guid id = default(Guid)) { this.Id = id; } /// <summary> - /// Gets or Sets Id + /// Gets or initializes the identifier of the discipline. /// </summary> + /// <value>Gets or initializes the identifier of the discipline.</value> [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/DisciplineForUserManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/DisciplineForUserManipulationDto.cs index 824ed188658c1e9dfcf78b8aa839cfcefa52d464..aaf5c6e07163d96fc21e82a97e7512eb4120acc6 100644 --- a/src/Coscine.ApiClient.Core/Model/DisciplineForUserManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/DisciplineForUserManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// DisciplineForUserManipulationDto + /// Data transfer object (DTO) representing a discipline for user manipulation. /// </summary> [DataContract(Name = "DisciplineForUserManipulationDto")] public partial class DisciplineForUserManipulationDto : IEquatable<DisciplineForUserManipulationDto>, IValidatableObject @@ -40,15 +40,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="DisciplineForUserManipulationDto" /> class. /// </summary> - /// <param name="id">id (required).</param> + /// <param name="id">Gets or initializes the identifier of the discipline. (required).</param> public DisciplineForUserManipulationDto(Guid id = default(Guid)) { this.Id = id; } /// <summary> - /// Gets or Sets Id + /// Gets or initializes the identifier of the discipline. /// </summary> + /// <value>Gets or initializes the identifier of the discipline.</value> [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/FileActionDto.cs b/src/Coscine.ApiClient.Core/Model/FileActionDto.cs new file mode 100644 index 0000000000000000000000000000000000000000..89ce072ab36e6d64f62253178a0fcf16b43bac25 --- /dev/null +++ b/src/Coscine.ApiClient.Core/Model/FileActionDto.cs @@ -0,0 +1,144 @@ +/* + * Coscine Web API (Internal Use Only) + * + * 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> + /// Represents a Data Transfer Object (DTO) for file actions, including the URL and HTTP method. + /// </summary> + [DataContract(Name = "FileActionDto")] + public partial class FileActionDto : IEquatable<FileActionDto>, IValidatableObject + { + + /// <summary> + /// Gets or Sets Method + /// </summary> + [DataMember(Name = "method", EmitDefaultValue = false)] + public FileActionHttpMethod? Method { get; set; } + /// <summary> + /// Initializes a new instance of the <see cref="FileActionDto" /> class. + /// </summary> + /// <param name="url">Gets or sets the presigned URL associated with the file action..</param> + /// <param name="method">method.</param> + public FileActionDto(string url = default(string), FileActionHttpMethod? method = default(FileActionHttpMethod?)) + { + this.Url = url; + this.Method = method; + } + + /// <summary> + /// Gets or sets the presigned URL associated with the file action. + /// </summary> + /// <value>Gets or sets the presigned URL associated with the file action.</value> + [DataMember(Name = "url", EmitDefaultValue = false)] + public string Url { 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 FileActionDto {\n"); + sb.Append(" Url: ").Append(Url).Append("\n"); + sb.Append(" Method: ").Append(Method).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> + /// Returns true if objects are equal + /// </summary> + /// <param name="input">Object to be compared</param> + /// <returns>Boolean</returns> + public override bool Equals(object input) + { + return this.Equals(input as FileActionDto); + } + + /// <summary> + /// Returns true if FileActionDto instances are equal + /// </summary> + /// <param name="input">Instance of FileActionDto to be compared</param> + /// <returns>Boolean</returns> + public bool Equals(FileActionDto input) + { + if (input == null) + { + return false; + } + return + ( + this.Url == input.Url || + (this.Url != null && + this.Url.Equals(input.Url)) + ) && + ( + this.Method == input.Method || + this.Method.Equals(input.Method) + ); + } + + /// <summary> + /// Gets the hash code + /// </summary> + /// <returns>Hash code</returns> + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Url != null) + { + hashCode = (hashCode * 59) + this.Url.GetHashCode(); + } + hashCode = (hashCode * 59) + this.Method.GetHashCode(); + return hashCode; + } + } + + /// <summary> + /// To validate all properties of the instance + /// </summary> + /// <param name="validationContext">Validation context</param> + /// <returns>Validation Result</returns> + IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/src/Coscine.ApiClient.Core/Model/FileActionHttpMethod.cs b/src/Coscine.ApiClient.Core/Model/FileActionHttpMethod.cs new file mode 100644 index 0000000000000000000000000000000000000000..ddbda041372193250af8d65f00eb64ac0231bfef --- /dev/null +++ b/src/Coscine.ApiClient.Core/Model/FileActionHttpMethod.cs @@ -0,0 +1,61 @@ +/* + * Coscine Web API (Internal Use Only) + * + * 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> + /// Represents the possible HTTP methods associated with file actions. + /// </summary> + /// <value>Represents the possible HTTP methods associated with file actions.</value> + [JsonConverter(typeof(StringEnumConverter))] + public enum FileActionHttpMethod + { + /// <summary> + /// Enum GET for value: GET + /// </summary> + [EnumMember(Value = "GET")] + GET = 1, + + /// <summary> + /// Enum POST for value: POST + /// </summary> + [EnumMember(Value = "POST")] + POST = 2, + + /// <summary> + /// Enum PUT for value: PUT + /// </summary> + [EnumMember(Value = "PUT")] + PUT = 3, + + /// <summary> + /// Enum DELETE for value: DELETE + /// </summary> + [EnumMember(Value = "DELETE")] + DELETE = 4 + } + +} diff --git a/src/Coscine.ApiClient.Core/Model/FileActionsDto.cs b/src/Coscine.ApiClient.Core/Model/FileActionsDto.cs new file mode 100644 index 0000000000000000000000000000000000000000..70dca56134eb841b7102bd1679b3789bdc57e344 --- /dev/null +++ b/src/Coscine.ApiClient.Core/Model/FileActionsDto.cs @@ -0,0 +1,129 @@ +/* + * Coscine Web API (Internal Use Only) + * + * 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> + /// Represents a Data Transfer Object (DTO) for a collection of file actions, including download action details. + /// </summary> + [DataContract(Name = "FileActionsDto")] + public partial class FileActionsDto : IEquatable<FileActionsDto>, IValidatableObject + { + /// <summary> + /// Initializes a new instance of the <see cref="FileActionsDto" /> class. + /// </summary> + /// <param name="download">download.</param> + public FileActionsDto(FileActionDto download = default(FileActionDto)) + { + this.Download = download; + } + + /// <summary> + /// Gets or Sets Download + /// </summary> + [DataMember(Name = "download", EmitDefaultValue = false)] + public FileActionDto Download { 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 FileActionsDto {\n"); + sb.Append(" Download: ").Append(Download).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> + /// Returns true if objects are equal + /// </summary> + /// <param name="input">Object to be compared</param> + /// <returns>Boolean</returns> + public override bool Equals(object input) + { + return this.Equals(input as FileActionsDto); + } + + /// <summary> + /// Returns true if FileActionsDto instances are equal + /// </summary> + /// <param name="input">Instance of FileActionsDto to be compared</param> + /// <returns>Boolean</returns> + public bool Equals(FileActionsDto input) + { + if (input == null) + { + return false; + } + return + ( + this.Download == input.Download || + (this.Download != null && + this.Download.Equals(input.Download)) + ); + } + + /// <summary> + /// Gets the hash code + /// </summary> + /// <returns>Hash code</returns> + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Download != null) + { + hashCode = (hashCode * 59) + this.Download.GetHashCode(); + } + return hashCode; + } + } + + /// <summary> + /// To validate all properties of the instance + /// </summary> + /// <param name="validationContext">Validation context</param> + /// <returns>Validation Result</returns> + IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/src/Coscine.ApiClient.Core/Model/FileTreeDto.cs b/src/Coscine.ApiClient.Core/Model/FileTreeDto.cs index b8fac23d00b15ec491e3bc6bda35301690f2d03c..a117b8cbef027087af8d11f090cb088edaedb8a1 100644 --- a/src/Coscine.ApiClient.Core/Model/FileTreeDto.cs +++ b/src/Coscine.ApiClient.Core/Model/FileTreeDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// FileTreeDto + /// Represents a Data Transfer Object (DTO) for a file within a tree structure, extending the base TreeDto. /// </summary> [DataContract(Name = "FileTreeDto")] public partial class FileTreeDto : IEquatable<FileTreeDto>, IValidatableObject @@ -41,15 +41,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="FileTreeDto" /> class. /// </summary> - /// <param name="path">path.</param> + /// <param name="path">The path of the tree item..</param> /// <param name="type">type.</param> - /// <param name="directory">directory.</param> - /// <param name="name">name.</param> - /// <param name="extension">extension.</param> - /// <param name="size">size.</param> - /// <param name="creationDate">creationDate.</param> - /// <param name="changeDate">changeDate.</param> - public FileTreeDto(string path = default(string), TreeDataType? type = default(TreeDataType?), string directory = default(string), string name = default(string), string extension = default(string), long size = default(long), DateTime? creationDate = default(DateTime?), DateTime? changeDate = default(DateTime?)) + /// <param name="directory">Gets or sets the directory of the file..</param> + /// <param name="name">Gets or sets the name of the file..</param> + /// <param name="extension">Gets or sets the extension of the file..</param> + /// <param name="size">Gets or sets the size of the file in bytes..</param> + /// <param name="creationDate">Gets or sets the creation date of the file..</param> + /// <param name="changeDate">Gets or sets the last change date of the file..</param> + /// <param name="actions">actions.</param> + public FileTreeDto(string path = default(string), TreeDataType? type = default(TreeDataType?), string directory = default(string), string name = default(string), string extension = default(string), long size = default(long), DateTime? creationDate = default(DateTime?), DateTime? changeDate = default(DateTime?), FileActionsDto actions = default(FileActionsDto)) { this.Path = path; this.Type = type; @@ -59,50 +60,64 @@ namespace Coscine.ApiClient.Core.Model this.Size = size; this.CreationDate = creationDate; this.ChangeDate = changeDate; + this.Actions = actions; } /// <summary> - /// Gets or Sets Path + /// The path of the tree item. /// </summary> + /// <value>The path of the tree item.</value> [DataMember(Name = "path", EmitDefaultValue = false)] public string Path { get; set; } /// <summary> - /// Gets or Sets Directory + /// Gets or sets the directory of the file. /// </summary> + /// <value>Gets or sets the directory of the file.</value> [DataMember(Name = "directory", EmitDefaultValue = false)] public string Directory { get; set; } /// <summary> - /// Gets or Sets Name + /// Gets or sets the name of the file. /// </summary> + /// <value>Gets or sets the name of the file.</value> [DataMember(Name = "name", EmitDefaultValue = false)] public string Name { get; set; } /// <summary> - /// Gets or Sets Extension + /// Gets or sets the extension of the file. /// </summary> + /// <value>Gets or sets the extension of the file.</value> [DataMember(Name = "extension", EmitDefaultValue = false)] public string Extension { get; set; } /// <summary> - /// Gets or Sets Size + /// Gets or sets the size of the file in bytes. /// </summary> + /// <value>Gets or sets the size of the file in bytes.</value> [DataMember(Name = "size", EmitDefaultValue = false)] public long Size { get; set; } /// <summary> - /// Gets or Sets CreationDate + /// Gets or sets the creation date of the file. /// </summary> + /// <value>Gets or sets the creation date of the file.</value> [DataMember(Name = "creationDate", EmitDefaultValue = true)] public DateTime? CreationDate { get; set; } /// <summary> - /// Gets or Sets ChangeDate + /// Gets or sets the last change date of the file. /// </summary> + /// <value>Gets or sets the last change date of the file.</value> [DataMember(Name = "changeDate", EmitDefaultValue = true)] public DateTime? ChangeDate { get; set; } + /// <summary> + /// Gets or Sets Actions + /// </summary> + [DataMember(Name = "actions", EmitDefaultValue = false)] + public FileActionsDto Actions { get; set; } + /// <summary> /// Returns the string presentation of the object /// </summary> @@ -119,6 +134,7 @@ namespace Coscine.ApiClient.Core.Model sb.Append(" Size: ").Append(Size).Append("\n"); sb.Append(" CreationDate: ").Append(CreationDate).Append("\n"); sb.Append(" ChangeDate: ").Append(ChangeDate).Append("\n"); + sb.Append(" Actions: ").Append(Actions).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -191,6 +207,11 @@ namespace Coscine.ApiClient.Core.Model this.ChangeDate == input.ChangeDate || (this.ChangeDate != null && this.ChangeDate.Equals(input.ChangeDate)) + ) && + ( + this.Actions == input.Actions || + (this.Actions != null && + this.Actions.Equals(input.Actions)) ); } @@ -229,6 +250,10 @@ namespace Coscine.ApiClient.Core.Model { hashCode = (hashCode * 59) + this.ChangeDate.GetHashCode(); } + if (this.Actions != null) + { + hashCode = (hashCode * 59) + this.Actions.GetHashCode(); + } return hashCode; } } diff --git a/src/Coscine.ApiClient.Core/Model/FixedValueForResourceManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/FixedValueForResourceManipulationDto.cs index 59a85ab1dff7eca2b813dacf8f5a5c1fa2017d68..35a3d0331750281c744d254718b240a8730c262f 100644 --- a/src/Coscine.ApiClient.Core/Model/FixedValueForResourceManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/FixedValueForResourceManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// FixedValueForResourceManipulationDto + /// Data transfer object (DTO) representing the manipulation of a fixed value associated with a resource. /// </summary> [DataContract(Name = "FixedValueForResourceManipulationDto")] public partial class FixedValueForResourceManipulationDto : IEquatable<FixedValueForResourceManipulationDto>, IValidatableObject @@ -35,34 +35,46 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="FixedValueForResourceManipulationDto" /> class. /// </summary> - /// <param name="value">value.</param> - /// <param name="type">type.</param> - /// <param name="datatype">datatype.</param> - public FixedValueForResourceManipulationDto(string value = default(string), string type = default(string), string datatype = default(string)) + /// <param name="value">Gets or initializes the value of the fixed resource value..</param> + /// <param name="type">Gets or initializes the type of the fixed resource value..</param> + /// <param name="datatype">Gets or initializes the data type URI of the fixed resource value..</param> + /// <param name="targetClass">The target class of the provided value (e.g., \"https://purl.org/coscine/ap/base/\").</param> + public FixedValueForResourceManipulationDto(string value = default(string), string type = default(string), string datatype = default(string), string targetClass = default(string)) { this.Value = value; this.Type = type; this.Datatype = datatype; + this.TargetClass = targetClass; } /// <summary> - /// Gets or Sets Value + /// Gets or initializes the value of the fixed resource value. /// </summary> + /// <value>Gets or initializes the value of the fixed resource value.</value> [DataMember(Name = "value", EmitDefaultValue = true)] public string Value { get; set; } /// <summary> - /// Gets or Sets Type + /// Gets or initializes the type of the fixed resource value. /// </summary> + /// <value>Gets or initializes the type of the fixed resource value.</value> [DataMember(Name = "type", EmitDefaultValue = true)] public string Type { get; set; } /// <summary> - /// Gets or Sets Datatype + /// Gets or initializes the data type URI of the fixed resource value. /// </summary> + /// <value>Gets or initializes the data type URI of the fixed resource value.</value> [DataMember(Name = "datatype", EmitDefaultValue = true)] public string Datatype { get; set; } + /// <summary> + /// The target class of the provided value (e.g., \"https://purl.org/coscine/ap/base/\") + /// </summary> + /// <value>The target class of the provided value (e.g., \"https://purl.org/coscine/ap/base/\")</value> + [DataMember(Name = "targetClass", EmitDefaultValue = true)] + public string TargetClass { get; set; } + /// <summary> /// Returns the string presentation of the object /// </summary> @@ -74,6 +86,7 @@ namespace Coscine.ApiClient.Core.Model sb.Append(" Value: ").Append(Value).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Datatype: ").Append(Datatype).Append("\n"); + sb.Append(" TargetClass: ").Append(TargetClass).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -123,6 +136,11 @@ namespace Coscine.ApiClient.Core.Model this.Datatype == input.Datatype || (this.Datatype != null && this.Datatype.Equals(input.Datatype)) + ) && + ( + this.TargetClass == input.TargetClass || + (this.TargetClass != null && + this.TargetClass.Equals(input.TargetClass)) ); } @@ -147,6 +165,10 @@ namespace Coscine.ApiClient.Core.Model { hashCode = (hashCode * 59) + this.Datatype.GetHashCode(); } + if (this.TargetClass != null) + { + hashCode = (hashCode * 59) + this.TargetClass.GetHashCode(); + } return hashCode; } } diff --git a/src/Coscine.ApiClient.Core/Model/GitLabOptionsDto.cs b/src/Coscine.ApiClient.Core/Model/GitLabOptionsDto.cs index df68ab29ac745cb842eb502fedf6c80a854dc09f..880c6db084cc28bed15390621cdbc8fccef66e46 100644 --- a/src/Coscine.ApiClient.Core/Model/GitLabOptionsDto.cs +++ b/src/Coscine.ApiClient.Core/Model/GitLabOptionsDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// GitLabOptionsDto + /// Represents the data transfer object (DTO) for GitLab options. /// </summary> [DataContract(Name = "GitLabOptionsDto")] public partial class GitLabOptionsDto : IEquatable<GitLabOptionsDto>, IValidatableObject @@ -35,10 +35,10 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="GitLabOptionsDto" /> class. /// </summary> - /// <param name="projectId">projectId.</param> - /// <param name="repoUrl">repoUrl.</param> - /// <param name="accessToken">accessToken.</param> - /// <param name="branch">branch.</param> + /// <param name="projectId">The project ID associated with GitLab..</param> + /// <param name="repoUrl">The repository URL for GitLab..</param> + /// <param name="accessToken">The access token for GitLab..</param> + /// <param name="branch">The branch for GitLab..</param> public GitLabOptionsDto(int projectId = default(int), string repoUrl = default(string), string accessToken = default(string), string branch = default(string)) { this.ProjectId = projectId; @@ -48,26 +48,30 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets ProjectId + /// The project ID associated with GitLab. /// </summary> + /// <value>The project ID associated with GitLab.</value> [DataMember(Name = "projectId", EmitDefaultValue = false)] public int ProjectId { get; set; } /// <summary> - /// Gets or Sets RepoUrl + /// The repository URL for GitLab. /// </summary> + /// <value>The repository URL for GitLab.</value> [DataMember(Name = "repoUrl", EmitDefaultValue = true)] public string RepoUrl { get; set; } /// <summary> - /// Gets or Sets AccessToken + /// The access token for GitLab. /// </summary> + /// <value>The access token for GitLab.</value> [DataMember(Name = "accessToken", EmitDefaultValue = true)] public string AccessToken { get; set; } /// <summary> - /// Gets or Sets Branch + /// The branch for GitLab. /// </summary> + /// <value>The branch for GitLab.</value> [DataMember(Name = "branch", EmitDefaultValue = true)] public string Branch { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/GitlabBranchDto.cs b/src/Coscine.ApiClient.Core/Model/GitlabBranchDto.cs index c05cc8ae6a9dcec02b151b023d6feaeddd57befd..46924c36fee9d4f8aeff2669270f21348853243a 100644 --- a/src/Coscine.ApiClient.Core/Model/GitlabBranchDto.cs +++ b/src/Coscine.ApiClient.Core/Model/GitlabBranchDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// GitlabBranchDto + /// Represents a GitLab branch data transfer object (DTO). /// </summary> [DataContract(Name = "GitlabBranchDto")] public partial class GitlabBranchDto : IEquatable<GitlabBranchDto>, IValidatableObject @@ -35,13 +35,13 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="GitlabBranchDto" /> class. /// </summary> - /// <param name="name">name.</param> - /// <param name="merged">merged.</param> - /// <param name="varProtected">varProtected.</param> - /// <param name="varDefault">varDefault.</param> - /// <param name="developersCanPush">developersCanPush.</param> - /// <param name="developersCanMerge">developersCanMerge.</param> - /// <param name="canPush">canPush.</param> + /// <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> 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)) { this.Name = name; @@ -54,44 +54,51 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Name + /// The name of the GitLab branch. /// </summary> + /// <value>The name of the GitLab branch.</value> [DataMember(Name = "name", EmitDefaultValue = false)] public string Name { get; set; } /// <summary> - /// Gets or Sets Merged + /// Indicates if the branch is merged. /// </summary> + /// <value>Indicates if the branch is merged.</value> [DataMember(Name = "merged", EmitDefaultValue = true)] public bool Merged { get; set; } /// <summary> - /// Gets or Sets VarProtected + /// Indicates if the branch is protected. /// </summary> + /// <value>Indicates if the branch is protected.</value> [DataMember(Name = "protected", EmitDefaultValue = true)] public bool VarProtected { get; set; } /// <summary> - /// Gets or Sets VarDefault + /// Indicates if the branch is set as default. /// </summary> + /// <value>Indicates if the branch is set as default.</value> [DataMember(Name = "default", EmitDefaultValue = true)] public bool VarDefault { get; set; } /// <summary> - /// Gets or Sets DevelopersCanPush + /// 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)] public bool DevelopersCanPush { get; set; } /// <summary> - /// Gets or Sets DevelopersCanMerge + /// 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)] public bool DevelopersCanMerge { get; set; } /// <summary> - /// Gets or Sets CanPush + /// 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)] public bool CanPush { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/GitlabProjectDto.cs b/src/Coscine.ApiClient.Core/Model/GitlabProjectDto.cs index 1c7d09062095a2bf756b7f1488ea2c6fa451f8ff..12e6aac5a8044a2ed518c11c2f30e033389d1bd7 100644 --- a/src/Coscine.ApiClient.Core/Model/GitlabProjectDto.cs +++ b/src/Coscine.ApiClient.Core/Model/GitlabProjectDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// GitlabProjectDto + /// Represents a GitLab project data transfer object (DTO). /// </summary> [DataContract(Name = "GitlabProjectDto")] public partial class GitlabProjectDto : IEquatable<GitlabProjectDto>, IValidatableObject @@ -35,19 +35,19 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="GitlabProjectDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="archived">archived.</param> - /// <param name="name">name.</param> - /// <param name="nameWithNamespace">nameWithNamespace.</param> - /// <param name="description">description.</param> - /// <param name="defaultBranch">defaultBranch.</param> - /// <param name="path">path.</param> - /// <param name="pathWithNamespace">pathWithNamespace.</param> - /// <param name="lastActivityAt">lastActivityAt.</param> - /// <param name="createdAt">createdAt.</param> - /// <param name="webUrl">webUrl.</param> - /// <param name="httpUrlToRepo">httpUrlToRepo.</param> - /// <param name="sshUrlToRepo">sshUrlToRepo.</param> + /// <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> 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; @@ -66,80 +66,93 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// The unique identifier for the GitLab project. /// </summary> + /// <value>The unique identifier for the GitLab project.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public int Id { get; set; } /// <summary> - /// Gets or Sets Archived + /// Indicates if the GitLab project is archived. /// </summary> + /// <value>Indicates if the GitLab project is archived.</value> [DataMember(Name = "archived", EmitDefaultValue = true)] public bool Archived { get; set; } /// <summary> - /// Gets or Sets Name + /// The name of the GitLab project. /// </summary> + /// <value>The name of the GitLab project.</value> [DataMember(Name = "name", EmitDefaultValue = false)] public string Name { get; set; } /// <summary> - /// Gets or Sets NameWithNamespace + /// 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)] public string NameWithNamespace { get; set; } /// <summary> - /// Gets or Sets Description + /// A brief description of the GitLab project. /// </summary> + /// <value>A brief description of the GitLab project.</value> [DataMember(Name = "description", EmitDefaultValue = false)] public string Description { get; set; } /// <summary> - /// Gets or Sets DefaultBranch + /// The default branch of the GitLab project. /// </summary> + /// <value>The default branch of the GitLab project.</value> [DataMember(Name = "defaultBranch", EmitDefaultValue = false)] public string DefaultBranch { get; set; } /// <summary> - /// Gets or Sets Path + /// The path of the GitLab project. /// </summary> + /// <value>The path of the GitLab project.</value> [DataMember(Name = "path", EmitDefaultValue = false)] public string Path { get; set; } /// <summary> - /// Gets or Sets PathWithNamespace + /// The path of the GitLab project including namespace. /// </summary> + /// <value>The path of the GitLab project including namespace.</value> [DataMember(Name = "pathWithNamespace", EmitDefaultValue = false)] public string PathWithNamespace { get; set; } /// <summary> - /// Gets or Sets LastActivityAt + /// 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)] public string LastActivityAt { get; set; } /// <summary> - /// Gets or Sets CreatedAt + /// The creation timestamp of the GitLab project. /// </summary> + /// <value>The creation timestamp of the GitLab project.</value> [DataMember(Name = "createdAt", EmitDefaultValue = false)] public string CreatedAt { get; set; } /// <summary> - /// Gets or Sets WebUrl + /// 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)] public string WebUrl { get; set; } /// <summary> - /// Gets or Sets HttpUrlToRepo + /// 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)] public string HttpUrlToRepo { get; set; } /// <summary> - /// Gets or Sets SshUrlToRepo + /// 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)] public string SshUrlToRepo { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/GitlabResourceTypeOptionsForCreationDto.cs b/src/Coscine.ApiClient.Core/Model/GitlabResourceTypeOptionsForCreationDto.cs index ef14beb00cab7077fd7e648b2fd2fac89745c76e..15a36a0b1711614aca1c11e1d94a43097be9ad01 100644 --- a/src/Coscine.ApiClient.Core/Model/GitlabResourceTypeOptionsForCreationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/GitlabResourceTypeOptionsForCreationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// GitlabResourceTypeOptionsForCreationDto + /// Represents the data transfer object (DTO) for creating GitLab resource type options. /// </summary> [DataContract(Name = "GitlabResourceTypeOptionsForCreationDto")] public partial class GitlabResourceTypeOptionsForCreationDto : IEquatable<GitlabResourceTypeOptionsForCreationDto>, IValidatableObject @@ -40,11 +40,11 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="GitlabResourceTypeOptionsForCreationDto" /> class. /// </summary> - /// <param name="branch">branch (required).</param> - /// <param name="accessToken">accessToken (required).</param> - /// <param name="repoUrl">repoUrl (required).</param> - /// <param name="projectId">projectId (required).</param> - /// <param name="tosAccepted">tosAccepted (required).</param> + /// <param name="branch">The branch associated with the GitLab resource. (required).</param> + /// <param name="accessToken">The access token for authentication with GitLab. (required).</param> + /// <param name="repoUrl">The repository URL for the GitLab resource. (required).</param> + /// <param name="projectId">The project ID associated with the GitLab resource. (required).</param> + /// <param name="tosAccepted">Indicates whether the terms of service for the GitLab resource are accepted. (required).</param> public GitlabResourceTypeOptionsForCreationDto(string branch = default(string), string accessToken = default(string), string repoUrl = default(string), int projectId = default(int), bool tosAccepted = default(bool)) { // to ensure "branch" is required (not null) @@ -70,32 +70,37 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Branch + /// The branch associated with the GitLab resource. /// </summary> + /// <value>The branch associated with the GitLab resource.</value> [DataMember(Name = "branch", IsRequired = true, EmitDefaultValue = true)] public string Branch { get; set; } /// <summary> - /// Gets or Sets AccessToken + /// The access token for authentication with GitLab. /// </summary> + /// <value>The access token for authentication with GitLab.</value> [DataMember(Name = "accessToken", IsRequired = true, EmitDefaultValue = true)] public string AccessToken { get; set; } /// <summary> - /// Gets or Sets RepoUrl + /// The repository URL for the GitLab resource. /// </summary> + /// <value>The repository URL for the GitLab resource.</value> [DataMember(Name = "repoUrl", IsRequired = true, EmitDefaultValue = true)] public string RepoUrl { get; set; } /// <summary> - /// Gets or Sets ProjectId + /// The project ID associated with the GitLab resource. /// </summary> + /// <value>The project ID associated with the GitLab resource.</value> [DataMember(Name = "projectId", IsRequired = true, EmitDefaultValue = true)] public int ProjectId { get; set; } /// <summary> - /// Gets or Sets TosAccepted + /// Indicates whether the terms of service for the GitLab resource are accepted. /// </summary> + /// <value>Indicates whether the terms of service for the GitLab resource are accepted.</value> [DataMember(Name = "tosAccepted", IsRequired = true, EmitDefaultValue = true)] public bool TosAccepted { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/GitlabResourceTypeOptionsForUpdateDto.cs b/src/Coscine.ApiClient.Core/Model/GitlabResourceTypeOptionsForUpdateDto.cs index 1c7683061aba6beb62b8a86660044636f84561fa..13376577f51e624968dd7dada8f311851e8b8fa0 100644 --- a/src/Coscine.ApiClient.Core/Model/GitlabResourceTypeOptionsForUpdateDto.cs +++ b/src/Coscine.ApiClient.Core/Model/GitlabResourceTypeOptionsForUpdateDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// GitlabResourceTypeOptionsForUpdateDto + /// Represents the data transfer object (DTO) for updating GitLab resource type options. /// </summary> [DataContract(Name = "GitlabResourceTypeOptionsForUpdateDto")] public partial class GitlabResourceTypeOptionsForUpdateDto : IEquatable<GitlabResourceTypeOptionsForUpdateDto>, IValidatableObject @@ -40,8 +40,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="GitlabResourceTypeOptionsForUpdateDto" /> class. /// </summary> - /// <param name="branch">branch (required).</param> - /// <param name="accessToken">accessToken (required).</param> + /// <param name="branch">The branch associated with the GitLab resource. (required).</param> + /// <param name="accessToken">The access token for authentication with GitLab. (required).</param> public GitlabResourceTypeOptionsForUpdateDto(string branch = default(string), string accessToken = default(string)) { // to ensure "branch" is required (not null) @@ -59,14 +59,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Branch + /// The branch associated with the GitLab resource. /// </summary> + /// <value>The branch associated with the GitLab resource.</value> [DataMember(Name = "branch", IsRequired = true, EmitDefaultValue = true)] public string Branch { get; set; } /// <summary> - /// Gets or Sets AccessToken + /// The access token for authentication with GitLab. /// </summary> + /// <value>The access token for authentication with GitLab.</value> [DataMember(Name = "accessToken", IsRequired = true, EmitDefaultValue = true)] public string AccessToken { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/IdentityProviderDto.cs b/src/Coscine.ApiClient.Core/Model/IdentityProviderDto.cs index 10482b0edff602a841866482d389f905c7a42b4a..907a5ac06a9fede3e33aab20326df476fbf99ec9 100644 --- a/src/Coscine.ApiClient.Core/Model/IdentityProviderDto.cs +++ b/src/Coscine.ApiClient.Core/Model/IdentityProviderDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// IdentityProviderDto + /// Represents a Data Transfer Object (DTO) for an identity provider. /// </summary> [DataContract(Name = "IdentityProviderDto")] public partial class IdentityProviderDto : IEquatable<IdentityProviderDto>, IValidatableObject @@ -35,8 +35,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="IdentityProviderDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="displayName">displayName.</param> + /// <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> public IdentityProviderDto(Guid id = default(Guid), string displayName = default(string)) { this.Id = id; @@ -44,14 +44,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// 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)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// 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)] public string DisplayName { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/IdentityProviders.cs b/src/Coscine.ApiClient.Core/Model/IdentityProviders.cs index b008aca05075e2e5ce00a143428d90d092c6e344..223441cdb580319f40e4540146f580b50b1fa175 100644 --- a/src/Coscine.ApiClient.Core/Model/IdentityProviders.cs +++ b/src/Coscine.ApiClient.Core/Model/IdentityProviders.cs @@ -27,8 +27,9 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// Defines IdentityProviders + /// Specifies the supported external authentication services. /// </summary> + /// <value>Specifies the supported external authentication services.</value> [JsonConverter(typeof(StringEnumConverter))] public enum IdentityProviders { diff --git a/src/Coscine.ApiClient.Core/Model/LanguageDto.cs b/src/Coscine.ApiClient.Core/Model/LanguageDto.cs index 1ac6b80cbda0221abd30f6afdf53030d4a23b10a..2f556b6ccd1869d4640b00cf325f7e668d858a02 100644 --- a/src/Coscine.ApiClient.Core/Model/LanguageDto.cs +++ b/src/Coscine.ApiClient.Core/Model/LanguageDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// LanguageDto + /// Represents a Data Transfer Object (DTO) for language details. /// </summary> [DataContract(Name = "LanguageDto")] public partial class LanguageDto : IEquatable<LanguageDto>, IValidatableObject @@ -35,9 +35,9 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="LanguageDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="displayName">displayName.</param> - /// <param name="abbreviation">abbreviation.</param> + /// <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> public LanguageDto(Guid id = default(Guid), string displayName = default(string), string abbreviation = default(string)) { this.Id = id; @@ -46,20 +46,23 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// 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)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// 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)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Abbreviation + /// Gets or sets the abbreviation for the language. /// </summary> + /// <value>Gets or sets the abbreviation for the language.</value> [DataMember(Name = "abbreviation", EmitDefaultValue = false)] public string Abbreviation { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/LanguageDtoPagedResponse.cs b/src/Coscine.ApiClient.Core/Model/LanguageDtoIEnumerableResponse.cs similarity index 79% rename from src/Coscine.ApiClient.Core/Model/LanguageDtoPagedResponse.cs rename to src/Coscine.ApiClient.Core/Model/LanguageDtoIEnumerableResponse.cs index b538eb9c9fbae2c673ffd70288f648fb102be476..6935123994ff5b11bf98361f2d6d9b5d084fcdbd 100644 --- a/src/Coscine.ApiClient.Core/Model/LanguageDtoPagedResponse.cs +++ b/src/Coscine.ApiClient.Core/Model/LanguageDtoIEnumerableResponse.cs @@ -27,24 +27,22 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// LanguageDtoPagedResponse + /// LanguageDtoIEnumerableResponse /// </summary> - [DataContract(Name = "LanguageDtoPagedResponse")] - public partial class LanguageDtoPagedResponse : IEquatable<LanguageDtoPagedResponse>, IValidatableObject + [DataContract(Name = "LanguageDtoIEnumerableResponse")] + public partial class LanguageDtoIEnumerableResponse : IEquatable<LanguageDtoIEnumerableResponse>, IValidatableObject { /// <summary> - /// Initializes a new instance of the <see cref="LanguageDtoPagedResponse" /> class. + /// Initializes a new instance of the <see cref="LanguageDtoIEnumerableResponse" /> class. /// </summary> /// <param name="data">data.</param> /// <param name="statusCode">statusCode.</param> /// <param name="traceId">traceId.</param> - /// <param name="pagination">pagination.</param> - public LanguageDtoPagedResponse(List<LanguageDto> data = default(List<LanguageDto>), int? statusCode = default(int?), string traceId = default(string), Pagination pagination = default(Pagination)) + public LanguageDtoIEnumerableResponse(List<LanguageDto> data = default(List<LanguageDto>), int? statusCode = default(int?), string traceId = default(string)) { this.Data = data; this.StatusCode = statusCode; this.TraceId = traceId; - this.Pagination = pagination; } /// <summary> @@ -79,12 +77,6 @@ namespace Coscine.ApiClient.Core.Model [DataMember(Name = "traceId", EmitDefaultValue = true)] public string TraceId { get; set; } - /// <summary> - /// Gets or Sets Pagination - /// </summary> - [DataMember(Name = "pagination", EmitDefaultValue = false)] - public Pagination Pagination { get; set; } - /// <summary> /// Returns the string presentation of the object /// </summary> @@ -92,12 +84,11 @@ namespace Coscine.ApiClient.Core.Model public override string ToString() { StringBuilder sb = new StringBuilder(); - sb.Append("class LanguageDtoPagedResponse {\n"); + sb.Append("class LanguageDtoIEnumerableResponse {\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(" Pagination: ").Append(Pagination).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -118,15 +109,15 @@ namespace Coscine.ApiClient.Core.Model /// <returns>Boolean</returns> public override bool Equals(object input) { - return this.Equals(input as LanguageDtoPagedResponse); + return this.Equals(input as LanguageDtoIEnumerableResponse); } /// <summary> - /// Returns true if LanguageDtoPagedResponse instances are equal + /// Returns true if LanguageDtoIEnumerableResponse instances are equal /// </summary> - /// <param name="input">Instance of LanguageDtoPagedResponse to be compared</param> + /// <param name="input">Instance of LanguageDtoIEnumerableResponse to be compared</param> /// <returns>Boolean</returns> - public bool Equals(LanguageDtoPagedResponse input) + public bool Equals(LanguageDtoIEnumerableResponse input) { if (input == null) { @@ -152,11 +143,6 @@ namespace Coscine.ApiClient.Core.Model this.TraceId == input.TraceId || (this.TraceId != null && this.TraceId.Equals(input.TraceId)) - ) && - ( - this.Pagination == input.Pagination || - (this.Pagination != null && - this.Pagination.Equals(input.Pagination)) ); } @@ -182,10 +168,6 @@ namespace Coscine.ApiClient.Core.Model { hashCode = (hashCode * 59) + this.TraceId.GetHashCode(); } - if (this.Pagination != null) - { - hashCode = (hashCode * 59) + this.Pagination.GetHashCode(); - } return hashCode; } } diff --git a/src/Coscine.ApiClient.Core/Model/LanguageForUserManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/LanguageForUserManipulationDto.cs index 3820f6ea6d93d7df7f00182ace86c42dbf567f14..c97073983f71ff07e72015d374ecd9f9516e7e4e 100644 --- a/src/Coscine.ApiClient.Core/Model/LanguageForUserManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/LanguageForUserManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// LanguageForUserManipulationDto + /// Data transfer object (DTO) representing a language for user manipulation. /// </summary> [DataContract(Name = "LanguageForUserManipulationDto")] public partial class LanguageForUserManipulationDto : IEquatable<LanguageForUserManipulationDto>, IValidatableObject @@ -40,15 +40,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="LanguageForUserManipulationDto" /> class. /// </summary> - /// <param name="id">id (required).</param> + /// <param name="id">Gets or initializes the identifier of the language. (required).</param> public LanguageForUserManipulationDto(Guid id = default(Guid)) { this.Id = id; } /// <summary> - /// Gets or Sets Id + /// Gets or initializes the identifier of the language. /// </summary> + /// <value>Gets or initializes the identifier of the language.</value> [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/LicenseDto.cs b/src/Coscine.ApiClient.Core/Model/LicenseDto.cs index 82a9a3f504f7b5d01f6ec589e8f3937ccc91e9fc..5d9491629e9b096052e05cdc651bc94b08e3e432 100644 --- a/src/Coscine.ApiClient.Core/Model/LicenseDto.cs +++ b/src/Coscine.ApiClient.Core/Model/LicenseDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// LicenseDto + /// Represents a Data Transfer Object (DTO) for license details. /// </summary> [DataContract(Name = "LicenseDto")] public partial class LicenseDto : IEquatable<LicenseDto>, IValidatableObject @@ -35,8 +35,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="LicenseDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="displayName">displayName.</param> + /// <param name="id">Gets or sets the unique identifier for the license..</param> + /// <param name="displayName">Gets or sets the display name of the license..</param> public LicenseDto(Guid id = default(Guid), string displayName = default(string)) { this.Id = id; @@ -44,14 +44,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// Gets or sets the unique identifier for the license. /// </summary> + /// <value>Gets or sets the unique identifier for the license.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// Gets or sets the display name of the license. /// </summary> + /// <value>Gets or sets the display name of the license.</value> [DataMember(Name = "displayName", EmitDefaultValue = false)] public string DisplayName { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/LicenseForResourceManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/LicenseForResourceManipulationDto.cs index 6b37e8bf61d480bc85a3d700d36734d8ed3feabd..ec790d9341ffa637e1a5026c0334f64d94196f58 100644 --- a/src/Coscine.ApiClient.Core/Model/LicenseForResourceManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/LicenseForResourceManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// LicenseForResourceManipulationDto + /// Data transfer object (DTO) representing a license for resource manipulation. /// </summary> [DataContract(Name = "LicenseForResourceManipulationDto")] public partial class LicenseForResourceManipulationDto : IEquatable<LicenseForResourceManipulationDto>, IValidatableObject @@ -40,15 +40,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="LicenseForResourceManipulationDto" /> class. /// </summary> - /// <param name="id">id (required).</param> + /// <param name="id">Gets or initializes the identifier of the license. (required).</param> public LicenseForResourceManipulationDto(Guid id = default(Guid)) { this.Id = id; } /// <summary> - /// Gets or Sets Id + /// Gets or initializes the identifier of the license. /// </summary> + /// <value>Gets or initializes the identifier of the license.</value> [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/MaintenanceDto.cs b/src/Coscine.ApiClient.Core/Model/MaintenanceDto.cs index 46ac5957a897dba27bca466a572010791740a357..b551e6eb49630cdaee90d5c2e758549878baff6e 100644 --- a/src/Coscine.ApiClient.Core/Model/MaintenanceDto.cs +++ b/src/Coscine.ApiClient.Core/Model/MaintenanceDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// MaintenanceDto + /// This class represents a maintenance with its significant properties, which is returned from the API. /// </summary> [DataContract(Name = "MaintenanceDto")] public partial class MaintenanceDto : IEquatable<MaintenanceDto>, IValidatableObject @@ -35,12 +35,12 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="MaintenanceDto" /> class. /// </summary> - /// <param name="displayName">displayName.</param> - /// <param name="href">href.</param> - /// <param name="type">type.</param> - /// <param name="body">body.</param> - /// <param name="startsDate">startsDate.</param> - /// <param name="endsDate">endsDate.</param> + /// <param name="displayName">Gets or sets the maintenance title..</param> + /// <param name="href">Gets or sets the URL related to the maintenance..</param> + /// <param name="type">Gets or sets the type of maintenance..</param> + /// <param name="body">Gets or sets the description of the maintenance..</param> + /// <param name="startsDate">Gets or sets the start date of the maintenance, if available..</param> + /// <param name="endsDate">Gets or sets the end date of the maintenance, if available..</param> public MaintenanceDto(string displayName = default(string), string href = default(string), string type = default(string), string body = default(string), DateTime? startsDate = default(DateTime?), DateTime? endsDate = default(DateTime?)) { this.DisplayName = displayName; @@ -52,38 +52,44 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets DisplayName + /// Gets or sets the maintenance title. /// </summary> + /// <value>Gets or sets the maintenance title.</value> [DataMember(Name = "displayName", EmitDefaultValue = false)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Href + /// Gets or sets the URL related to the maintenance. /// </summary> + /// <value>Gets or sets the URL related to the maintenance.</value> [DataMember(Name = "href", EmitDefaultValue = false)] public string Href { get; set; } /// <summary> - /// Gets or Sets Type + /// Gets or sets the type of maintenance. /// </summary> + /// <value>Gets or sets the type of maintenance.</value> [DataMember(Name = "type", EmitDefaultValue = false)] public string Type { get; set; } /// <summary> - /// Gets or Sets Body + /// Gets or sets the description of the maintenance. /// </summary> + /// <value>Gets or sets the description of the maintenance.</value> [DataMember(Name = "body", EmitDefaultValue = false)] public string Body { get; set; } /// <summary> - /// Gets or Sets StartsDate + /// Gets or sets the start date of the maintenance, if available. /// </summary> + /// <value>Gets or sets the start date of the maintenance, if available.</value> [DataMember(Name = "startsDate", EmitDefaultValue = true)] public DateTime? StartsDate { get; set; } /// <summary> - /// Gets or Sets EndsDate + /// Gets or sets the end date of the maintenance, if available. /// </summary> + /// <value>Gets or sets the end date of the maintenance, if available.</value> [DataMember(Name = "endsDate", EmitDefaultValue = true)] public DateTime? EndsDate { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/MetadataTreeDto.cs b/src/Coscine.ApiClient.Core/Model/MetadataTreeDto.cs index 8c5349b600584f1cd288c4e1f99231349087d85b..36384282592c1e0e0e19d283f043966c58f35881 100644 --- a/src/Coscine.ApiClient.Core/Model/MetadataTreeDto.cs +++ b/src/Coscine.ApiClient.Core/Model/MetadataTreeDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// MetadataTreeDto + /// Represents a data transfer object (DTO) for metadata within a tree structure, extending the base TreeDto. /// </summary> [DataContract(Name = "MetadataTreeDto")] public partial class MetadataTreeDto : IEquatable<MetadataTreeDto>, IValidatableObject @@ -41,10 +41,10 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="MetadataTreeDto" /> class. /// </summary> - /// <param name="path">path.</param> + /// <param name="path">The path of the tree item..</param> /// <param name="type">type.</param> - /// <param name="varVersion">varVersion.</param> - /// <param name="availableVersions">availableVersions.</param> + /// <param name="varVersion">Gets or sets the version associated with the metadata..</param> + /// <param name="availableVersions">Gets or sets the collection of available versions related to the metadata..</param> /// <param name="definition">definition.</param> public MetadataTreeDto(string path = default(string), TreeDataType? type = default(TreeDataType?), string varVersion = default(string), List<string> availableVersions = default(List<string>), RdfDefinitionDto definition = default(RdfDefinitionDto)) { @@ -56,20 +56,23 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Path + /// The path of the tree item. /// </summary> + /// <value>The path of the tree item.</value> [DataMember(Name = "path", EmitDefaultValue = false)] public string Path { get; set; } /// <summary> - /// Gets or Sets VarVersion + /// Gets or sets the version associated with the metadata. /// </summary> + /// <value>Gets or sets the version associated with the metadata.</value> [DataMember(Name = "version", EmitDefaultValue = false)] public string VarVersion { get; set; } /// <summary> - /// Gets or Sets AvailableVersions + /// Gets or sets the collection of available versions related to the metadata. /// </summary> + /// <value>Gets or sets the collection of available versions related to the metadata.</value> [DataMember(Name = "availableVersions", EmitDefaultValue = false)] public List<string> AvailableVersions { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/MetadataTreeForCreationDto.cs b/src/Coscine.ApiClient.Core/Model/MetadataTreeForCreationDto.cs index 09e578ae7346544c75446b61be86d1c92fe68119..a8fd71ea3845b9c2d558721d23499f741cc84fa3 100644 --- a/src/Coscine.ApiClient.Core/Model/MetadataTreeForCreationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/MetadataTreeForCreationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// MetadataTreeForCreationDto + /// Data transfer object (DTO) representing the creation of a metadata tree. Extends the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.MetadataTreeForManipulationDto. /// </summary> [DataContract(Name = "MetadataTreeForCreationDto")] public partial class MetadataTreeForCreationDto : IEquatable<MetadataTreeForCreationDto>, IValidatableObject @@ -40,7 +40,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="MetadataTreeForCreationDto" /> class. /// </summary> - /// <param name="path">path (required).</param> + /// <param name="path">Gets or initializes the path of the metadata tree. (required).</param> /// <param name="definition">definition (required).</param> public MetadataTreeForCreationDto(string path = default(string), RdfDefinitionForManipulationDto definition = default(RdfDefinitionForManipulationDto)) { @@ -59,8 +59,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Path + /// Gets or initializes the path of the metadata tree. /// </summary> + /// <value>Gets or initializes the path of the metadata tree.</value> [DataMember(Name = "path", IsRequired = true, EmitDefaultValue = true)] public string Path { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/MetadataTreeForUpdateDto.cs b/src/Coscine.ApiClient.Core/Model/MetadataTreeForUpdateDto.cs index c03e9419eb6634bd184674cb3951819948b719aa..643ea93ec00f42d7dbed510f5afad5112e08f85c 100644 --- a/src/Coscine.ApiClient.Core/Model/MetadataTreeForUpdateDto.cs +++ b/src/Coscine.ApiClient.Core/Model/MetadataTreeForUpdateDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// MetadataTreeForUpdateDto + /// Data transfer object (DTO) representing the update of a metadata tree. Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.MetadataTreeForManipulationDto. /// </summary> [DataContract(Name = "MetadataTreeForUpdateDto")] public partial class MetadataTreeForUpdateDto : IEquatable<MetadataTreeForUpdateDto>, IValidatableObject @@ -40,7 +40,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="MetadataTreeForUpdateDto" /> class. /// </summary> - /// <param name="path">path (required).</param> + /// <param name="path">Gets or initializes the path of the metadata tree. (required).</param> /// <param name="definition">definition (required).</param> public MetadataTreeForUpdateDto(string path = default(string), RdfDefinitionForManipulationDto definition = default(RdfDefinitionForManipulationDto)) { @@ -59,8 +59,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Path + /// Gets or initializes the path of the metadata tree. /// </summary> + /// <value>Gets or initializes the path of the metadata tree.</value> [DataMember(Name = "path", IsRequired = true, EmitDefaultValue = true)] public string Path { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/MetadataUpdateAdminParameters.cs b/src/Coscine.ApiClient.Core/Model/MetadataUpdateAdminParameters.cs index e9f5db8e2e9006e9e5a2b70399dd1ab7c1d13124..ea8603f30588984ff3ed57997f9d3da87f1fad3f 100644 --- a/src/Coscine.ApiClient.Core/Model/MetadataUpdateAdminParameters.cs +++ b/src/Coscine.ApiClient.Core/Model/MetadataUpdateAdminParameters.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// MetadataUpdateAdminParameters + /// Represents parameters for updating metadata in an administrative context. /// </summary> [DataContract(Name = "MetadataUpdateAdminParameters")] public partial class MetadataUpdateAdminParameters : IEquatable<MetadataUpdateAdminParameters>, IValidatableObject @@ -40,16 +40,9 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="MetadataUpdateAdminParameters" /> class. /// </summary> - /// <param name="graphUri">graphUri (required).</param> /// <param name="definition">definition (required).</param> - public MetadataUpdateAdminParameters(string graphUri = default(string), RdfDefinitionForManipulationDto definition = default(RdfDefinitionForManipulationDto)) + public MetadataUpdateAdminParameters(RdfDefinitionForManipulationDto definition = default(RdfDefinitionForManipulationDto)) { - // to ensure "graphUri" is required (not null) - if (graphUri == null) - { - throw new ArgumentNullException("graphUri is a required property for MetadataUpdateAdminParameters and cannot be null"); - } - this.GraphUri = graphUri; // to ensure "definition" is required (not null) if (definition == null) { @@ -58,12 +51,6 @@ namespace Coscine.ApiClient.Core.Model this.Definition = definition; } - /// <summary> - /// Gets or Sets GraphUri - /// </summary> - [DataMember(Name = "graphUri", IsRequired = true, EmitDefaultValue = true)] - public string GraphUri { get; set; } - /// <summary> /// Gets or Sets Definition /// </summary> @@ -78,7 +65,6 @@ namespace Coscine.ApiClient.Core.Model { StringBuilder sb = new StringBuilder(); sb.Append("class MetadataUpdateAdminParameters {\n"); - sb.Append(" GraphUri: ").Append(GraphUri).Append("\n"); sb.Append(" Definition: ").Append(Definition).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -115,11 +101,6 @@ namespace Coscine.ApiClient.Core.Model return false; } return - ( - this.GraphUri == input.GraphUri || - (this.GraphUri != null && - this.GraphUri.Equals(input.GraphUri)) - ) && ( this.Definition == input.Definition || (this.Definition != null && @@ -136,10 +117,6 @@ namespace Coscine.ApiClient.Core.Model unchecked // Overflow is fine, just wrap { int hashCode = 41; - if (this.GraphUri != null) - { - hashCode = (hashCode * 59) + this.GraphUri.GetHashCode(); - } if (this.Definition != null) { hashCode = (hashCode * 59) + this.Definition.GetHashCode(); diff --git a/src/Coscine.ApiClient.Core/Model/OrganizationDto.cs b/src/Coscine.ApiClient.Core/Model/OrganizationDto.cs index fd82ae3b13aca417530f1151cc8d08d88516b785..88396f95cc83db6c47f157cc142e0b65058cedd7 100644 --- a/src/Coscine.ApiClient.Core/Model/OrganizationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/OrganizationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// OrganizationDto + /// Represents a data transfer object (DTO) for an organization, including its ROR (Research Organization Registry) ID, display name, and email address. /// </summary> [DataContract(Name = "OrganizationDto")] public partial class OrganizationDto : IEquatable<OrganizationDto>, IValidatableObject @@ -35,9 +35,9 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="OrganizationDto" /> class. /// </summary> - /// <param name="uri">uri.</param> - /// <param name="displayName">displayName.</param> - /// <param name="email">email.</param> + /// <param name="uri">The ROR (Research Organization Registry) ID of the organization..</param> + /// <param name="displayName">The display name of the organization..</param> + /// <param name="email">The email address of the organization..</param> public OrganizationDto(string uri = default(string), string displayName = default(string), string email = default(string)) { this.Uri = uri; @@ -46,20 +46,23 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Uri + /// 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)] public string Uri { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// The display name of the organization. /// </summary> + /// <value>The display name of the organization.</value> [DataMember(Name = "displayName", EmitDefaultValue = false)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Email + /// The email address of the organization. /// </summary> + /// <value>The email address of the organization.</value> [DataMember(Name = "email", EmitDefaultValue = true)] public string Email { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/OrganizationForProjectManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/OrganizationForProjectManipulationDto.cs index c021fed6b4e3a4b1c3916f6c1cbe336f85a01a73..34ee0808720a20738fcdba784d6e47a43fe00041 100644 --- a/src/Coscine.ApiClient.Core/Model/OrganizationForProjectManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/OrganizationForProjectManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// OrganizationForProjectManipulationDto + /// Data transfer object (DTO) representing an organization for project manipulation. /// </summary> [DataContract(Name = "OrganizationForProjectManipulationDto")] public partial class OrganizationForProjectManipulationDto : IEquatable<OrganizationForProjectManipulationDto>, IValidatableObject @@ -40,7 +40,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="OrganizationForProjectManipulationDto" /> class. /// </summary> - /// <param name="uri">uri (required).</param> + /// <param name="uri">Gets or initializes the URI of the organization. (required).</param> public OrganizationForProjectManipulationDto(string uri = default(string)) { // to ensure "uri" is required (not null) @@ -52,8 +52,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Uri + /// Gets or initializes the URI of the organization. /// </summary> + /// <value>Gets or initializes the URI of the organization.</value> [DataMember(Name = "uri", IsRequired = true, EmitDefaultValue = true)] public string Uri { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/Pagination.cs b/src/Coscine.ApiClient.Core/Model/Pagination.cs index fc85d0a5cfb1dc4292311fe0b4c7bd0e53e54f2d..3ed88132f0b3b84f34c0b10fdc85e50dc643ca19 100644 --- a/src/Coscine.ApiClient.Core/Model/Pagination.cs +++ b/src/Coscine.ApiClient.Core/Model/Pagination.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// Pagination + /// Represents pagination information for a collection of items. /// </summary> [DataContract(Name = "Pagination")] public partial class Pagination : IEquatable<Pagination>, IValidatableObject @@ -35,10 +35,10 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="Pagination" /> class. /// </summary> - /// <param name="currentPage">currentPage.</param> - /// <param name="totalPages">totalPages.</param> - /// <param name="pageSize">pageSize.</param> - /// <param name="totalCount">totalCount.</param> + /// <param name="currentPage">Gets or sets the current page number..</param> + /// <param name="totalPages">Gets or sets the total number of pages..</param> + /// <param name="pageSize">Gets or sets the number of items per page..</param> + /// <param name="totalCount">Gets or sets the total count of items across all pages..</param> public Pagination(int currentPage = default(int), int totalPages = default(int), int pageSize = default(int), long totalCount = default(long)) { this.CurrentPage = currentPage; @@ -48,32 +48,37 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets CurrentPage + /// Gets or sets the current page number. /// </summary> + /// <value>Gets or sets the current page number.</value> [DataMember(Name = "currentPage", EmitDefaultValue = false)] public int CurrentPage { get; set; } /// <summary> - /// Gets or Sets TotalPages + /// Gets or sets the total number of pages. /// </summary> + /// <value>Gets or sets the total number of pages.</value> [DataMember(Name = "totalPages", EmitDefaultValue = false)] public int TotalPages { get; set; } /// <summary> - /// Gets or Sets PageSize + /// Gets or sets the number of items per page. /// </summary> + /// <value>Gets or sets the number of items per page.</value> [DataMember(Name = "pageSize", EmitDefaultValue = false)] public int PageSize { get; set; } /// <summary> - /// Gets or Sets TotalCount + /// Gets or sets the total count of items across all pages. /// </summary> + /// <value>Gets or sets the total count of items across all pages.</value> [DataMember(Name = "totalCount", EmitDefaultValue = false)] public long TotalCount { get; set; } /// <summary> - /// Gets or Sets HasPrevious + /// Gets a value indicating whether there is a previous page. /// </summary> + /// <value>Gets a value indicating whether there is a previous page.</value> [DataMember(Name = "hasPrevious", EmitDefaultValue = true)] public bool HasPrevious { get; private set; } @@ -86,8 +91,9 @@ namespace Coscine.ApiClient.Core.Model return false; } /// <summary> - /// Gets or Sets HasNext + /// Gets a value indicating whether there is a next page. /// </summary> + /// <value>Gets a value indicating whether there is a next page.</value> [DataMember(Name = "hasNext", EmitDefaultValue = true)] public bool HasNext { get; private set; } diff --git a/src/Coscine.ApiClient.Core/Model/PidRequestDto.cs b/src/Coscine.ApiClient.Core/Model/PidRequestDto.cs index 7560707bfa64a08c0040779cfeda145acc8941d1..3f9d1afb17d2243be0524d4e62b4e818ae39e618 100644 --- a/src/Coscine.ApiClient.Core/Model/PidRequestDto.cs +++ b/src/Coscine.ApiClient.Core/Model/PidRequestDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// PidRequestDto + /// Data transfer object (DTO) representing a PID request. /// </summary> [DataContract(Name = "PidRequestDto")] public partial class PidRequestDto : IEquatable<PidRequestDto>, IValidatableObject @@ -40,10 +40,10 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="PidRequestDto" /> class. /// </summary> - /// <param name="name">name (required).</param> - /// <param name="email">email (required).</param> - /// <param name="message">message (required).</param> - /// <param name="sendConfirmationEmail">sendConfirmationEmail.</param> + /// <param name="name">Gets or initializes the name associated with the PID request. (required).</param> + /// <param name="email">Gets or initializes the email associated with the PID request. (required).</param> + /// <param name="message">Gets or initializes the message for the PID request. (required).</param> + /// <param name="sendConfirmationEmail">Gets or initializes whether to send a confirmation email for the PID request..</param> public PidRequestDto(string name = default(string), string email = default(string), string message = default(string), bool sendConfirmationEmail = default(bool)) { // to ensure "name" is required (not null) @@ -68,26 +68,30 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Name + /// Gets or initializes the name associated with the PID request. /// </summary> + /// <value>Gets or initializes the name associated with the PID request.</value> [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> - /// Gets or Sets Email + /// Gets or initializes the email associated with the PID request. /// </summary> + /// <value>Gets or initializes the email associated with the PID request.</value> [DataMember(Name = "email", IsRequired = true, EmitDefaultValue = true)] public string Email { get; set; } /// <summary> - /// Gets or Sets Message + /// Gets or initializes the message for the PID request. /// </summary> + /// <value>Gets or initializes the message for the PID request.</value> [DataMember(Name = "message", IsRequired = true, EmitDefaultValue = true)] public string Message { get; set; } /// <summary> - /// Gets or Sets SendConfirmationEmail + /// Gets or initializes whether to send a confirmation email for the PID request. /// </summary> + /// <value>Gets or initializes whether to send a confirmation email for the PID request.</value> [DataMember(Name = "sendConfirmationEmail", EmitDefaultValue = true)] public bool SendConfirmationEmail { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/PidType.cs b/src/Coscine.ApiClient.Core/Model/PidType.cs index 4262e88f15f90e40db9d003378c65ea35ddc4fcb..39f5e094d7efe372a901436c98a394c310941a01 100644 --- a/src/Coscine.ApiClient.Core/Model/PidType.cs +++ b/src/Coscine.ApiClient.Core/Model/PidType.cs @@ -27,8 +27,9 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// Defines PidType + /// Specifies the type of PID. /// </summary> + /// <value>Specifies the type of PID.</value> [JsonConverter(typeof(StringEnumConverter))] public enum PidType { diff --git a/src/Coscine.ApiClient.Core/Model/PidValidationDto.cs b/src/Coscine.ApiClient.Core/Model/PidValidationDto.cs index 16eaf1225f63be9b90940ab4fff7d3d6d34a98a8..23e4776efe186971f2b61cf8df30fad95dfad6f1 100644 --- a/src/Coscine.ApiClient.Core/Model/PidValidationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/PidValidationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// PidValidationDto + /// Represents a data transfer object (DTO) for validating a PID (Persistent Identifier). /// </summary> [DataContract(Name = "PidValidationDto")] public partial class PidValidationDto : IEquatable<PidValidationDto>, IValidatableObject @@ -41,7 +41,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="PidValidationDto" /> class. /// </summary> - /// <param name="isValid">isValid.</param> + /// <param name="isValid">Indicates whether the provided PID is valid..</param> /// <param name="type">type.</param> public PidValidationDto(bool isValid = default(bool), PidType? type = default(PidType?)) { @@ -50,8 +50,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets IsValid + /// Indicates whether the provided PID is valid. /// </summary> + /// <value>Indicates whether the provided PID is valid.</value> [DataMember(Name = "isValid", EmitDefaultValue = true)] public bool IsValid { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ProjectAdminDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectAdminDto.cs index 3bf98356569b16ce04db23eb6123d4dd825b1945..9c62086e67107427aa983c41233d434ee21e531f 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectAdminDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectAdminDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectAdminDto + /// Represents a data transfer object (DTO) for an administrative view of a project. Extends the base information in Coscine.Api.Core.Shared.DataTransferObjects.ReturnObjects.ProjectDto. /// </summary> [DataContract(Name = "ProjectAdminDto")] public partial class ProjectAdminDto : IEquatable<ProjectAdminDto>, IValidatableObject @@ -35,27 +35,27 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectAdminDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="pid">pid.</param> - /// <param name="name">name.</param> - /// <param name="description">description.</param> - /// <param name="startDate">startDate.</param> - /// <param name="endDate">endDate.</param> - /// <param name="keywords">keywords.</param> - /// <param name="displayName">displayName.</param> - /// <param name="principleInvestigators">principleInvestigators.</param> - /// <param name="grantId">grantId.</param> + /// <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> + /// <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.</param> - /// <param name="organizations">organizations.</param> - /// <param name="slug">slug.</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="creator">creator.</param> - /// <param name="creationDate">creationDate.</param> - /// <param name="subProjects">subProjects.</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> - /// <param name="deleted">deleted.</param> - /// <param name="projectResources">projectResources.</param> - /// <param name="projectRoles">projectRoles.</param> + /// <param name="deleted">Indicates whether the project is marked as deleted..</param> + /// <param name="projectResources">Collection of minimal project resource details associated with the project..</param> + /// <param name="projectRoles">Collection of minimal project role details associated with the project..</param> /// <param name="projectQuota">projectQuota.</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>)) { @@ -84,62 +84,72 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// Unique identifier for the project. /// </summary> + /// <value>Unique identifier for the project.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets Pid + /// Persistent identifier for the project. /// </summary> + /// <value>Persistent identifier for the project.</value> [DataMember(Name = "pid", EmitDefaultValue = false)] public string Pid { get; set; } /// <summary> - /// Gets or Sets Name + /// Name of the project. /// </summary> + /// <value>Name of the project.</value> [DataMember(Name = "name", EmitDefaultValue = false)] public string Name { get; set; } /// <summary> - /// Gets or Sets Description + /// Description of the project. /// </summary> + /// <value>Description of the project.</value> [DataMember(Name = "description", EmitDefaultValue = false)] public string Description { get; set; } /// <summary> - /// Gets or Sets StartDate + /// Start date of the project. /// </summary> + /// <value>Start date of the project.</value> [DataMember(Name = "startDate", EmitDefaultValue = false)] public DateTime StartDate { get; set; } /// <summary> - /// Gets or Sets EndDate + /// End date of the project. /// </summary> + /// <value>End date of the project.</value> [DataMember(Name = "endDate", EmitDefaultValue = false)] public DateTime EndDate { get; set; } /// <summary> - /// Gets or Sets Keywords + /// Collection of keywords associated with the project. /// </summary> + /// <value>Collection of keywords associated with the project.</value> [DataMember(Name = "keywords", EmitDefaultValue = true)] public List<string> Keywords { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// Display name of the project. /// </summary> + /// <value>Display name of the project.</value> [DataMember(Name = "displayName", EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets PrincipleInvestigators + /// Principal investigators involved in the project. /// </summary> + /// <value>Principal investigators involved in the project.</value> [DataMember(Name = "principleInvestigators", EmitDefaultValue = true)] public string PrincipleInvestigators { get; set; } /// <summary> - /// Gets or Sets GrantId + /// Grant ID associated with the project. /// </summary> + /// <value>Grant ID associated with the project.</value> [DataMember(Name = "grantId", EmitDefaultValue = true)] public string GrantId { get; set; } @@ -150,20 +160,23 @@ namespace Coscine.ApiClient.Core.Model public VisibilityDto Visibility { get; set; } /// <summary> - /// Gets or Sets Disciplines + /// Disciplines related to the project. /// </summary> + /// <value>Disciplines related to the project.</value> [DataMember(Name = "disciplines", EmitDefaultValue = false)] public List<DisciplineDto> Disciplines { get; set; } /// <summary> - /// Gets or Sets Organizations + /// Organizations associated with the project. /// </summary> + /// <value>Organizations associated with the project.</value> [DataMember(Name = "organizations", EmitDefaultValue = false)] public List<OrganizationDto> Organizations { get; set; } /// <summary> - /// Gets or Sets Slug + /// Slug for the project. /// </summary> + /// <value>Slug for the project.</value> [DataMember(Name = "slug", EmitDefaultValue = false)] public string Slug { get; set; } @@ -174,14 +187,16 @@ namespace Coscine.ApiClient.Core.Model public UserMinimalDto Creator { get; set; } /// <summary> - /// Gets or Sets CreationDate + /// Date of creation of the project. /// </summary> + /// <value>Date of creation of the project.</value> [DataMember(Name = "creationDate", EmitDefaultValue = true)] public DateTime? CreationDate { get; set; } /// <summary> - /// Gets or Sets SubProjects + /// Collection of sub-projects associated with this project. /// </summary> + /// <value>Collection of sub-projects associated with this project.</value> [DataMember(Name = "subProjects", EmitDefaultValue = true)] public List<ProjectDto> SubProjects { get; set; } @@ -192,20 +207,23 @@ namespace Coscine.ApiClient.Core.Model public ProjectMinimalDto Parent { get; set; } /// <summary> - /// Gets or Sets Deleted + /// Indicates whether the project is marked as deleted. /// </summary> + /// <value>Indicates whether the project is marked as deleted.</value> [DataMember(Name = "deleted", EmitDefaultValue = true)] public bool Deleted { get; set; } /// <summary> - /// Gets or Sets ProjectResources + /// Collection of minimal project resource details associated with the project. /// </summary> + /// <value>Collection of minimal project resource details associated with the project.</value> [DataMember(Name = "projectResources", EmitDefaultValue = false)] public List<ProjectResourceMinimalDto> ProjectResources { get; set; } /// <summary> - /// Gets or Sets ProjectRoles + /// Collection of minimal project role details associated with the project. /// </summary> + /// <value>Collection of minimal project role details associated with the project.</value> [DataMember(Name = "projectRoles", EmitDefaultValue = false)] public List<ProjectRoleMinimalDto> ProjectRoles { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ProjectDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectDto.cs index dd3dd0d06054f17be1fc835abe9504ca5e147814..913738e6dab08eb42d0fd74ceee29c74f078565d 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectDto + /// Represents a data transfer object (DTO) for project information. /// </summary> [DataContract(Name = "ProjectDto")] public partial class ProjectDto : IEquatable<ProjectDto>, IValidatableObject @@ -35,23 +35,23 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="pid">pid.</param> - /// <param name="name">name.</param> - /// <param name="description">description.</param> - /// <param name="startDate">startDate.</param> - /// <param name="endDate">endDate.</param> - /// <param name="keywords">keywords.</param> - /// <param name="displayName">displayName.</param> - /// <param name="principleInvestigators">principleInvestigators.</param> - /// <param name="grantId">grantId.</param> + /// <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> + /// <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.</param> - /// <param name="organizations">organizations.</param> - /// <param name="slug">slug.</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="creator">creator.</param> - /// <param name="creationDate">creationDate.</param> - /// <param name="subProjects">subProjects.</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)) { @@ -76,62 +76,72 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// Unique identifier for the project. /// </summary> + /// <value>Unique identifier for the project.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets Pid + /// Persistent identifier for the project. /// </summary> + /// <value>Persistent identifier for the project.</value> [DataMember(Name = "pid", EmitDefaultValue = false)] public string Pid { get; set; } /// <summary> - /// Gets or Sets Name + /// Name of the project. /// </summary> + /// <value>Name of the project.</value> [DataMember(Name = "name", EmitDefaultValue = false)] public string Name { get; set; } /// <summary> - /// Gets or Sets Description + /// Description of the project. /// </summary> + /// <value>Description of the project.</value> [DataMember(Name = "description", EmitDefaultValue = false)] public string Description { get; set; } /// <summary> - /// Gets or Sets StartDate + /// Start date of the project. /// </summary> + /// <value>Start date of the project.</value> [DataMember(Name = "startDate", EmitDefaultValue = false)] public DateTime StartDate { get; set; } /// <summary> - /// Gets or Sets EndDate + /// End date of the project. /// </summary> + /// <value>End date of the project.</value> [DataMember(Name = "endDate", EmitDefaultValue = false)] public DateTime EndDate { get; set; } /// <summary> - /// Gets or Sets Keywords + /// Collection of keywords associated with the project. /// </summary> + /// <value>Collection of keywords associated with the project.</value> [DataMember(Name = "keywords", EmitDefaultValue = true)] public List<string> Keywords { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// Display name of the project. /// </summary> + /// <value>Display name of the project.</value> [DataMember(Name = "displayName", EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets PrincipleInvestigators + /// Principal investigators involved in the project. /// </summary> + /// <value>Principal investigators involved in the project.</value> [DataMember(Name = "principleInvestigators", EmitDefaultValue = true)] public string PrincipleInvestigators { get; set; } /// <summary> - /// Gets or Sets GrantId + /// Grant ID associated with the project. /// </summary> + /// <value>Grant ID associated with the project.</value> [DataMember(Name = "grantId", EmitDefaultValue = true)] public string GrantId { get; set; } @@ -142,20 +152,23 @@ namespace Coscine.ApiClient.Core.Model public VisibilityDto Visibility { get; set; } /// <summary> - /// Gets or Sets Disciplines + /// Disciplines related to the project. /// </summary> + /// <value>Disciplines related to the project.</value> [DataMember(Name = "disciplines", EmitDefaultValue = false)] public List<DisciplineDto> Disciplines { get; set; } /// <summary> - /// Gets or Sets Organizations + /// Organizations associated with the project. /// </summary> + /// <value>Organizations associated with the project.</value> [DataMember(Name = "organizations", EmitDefaultValue = false)] public List<OrganizationDto> Organizations { get; set; } /// <summary> - /// Gets or Sets Slug + /// Slug for the project. /// </summary> + /// <value>Slug for the project.</value> [DataMember(Name = "slug", EmitDefaultValue = false)] public string Slug { get; set; } @@ -166,14 +179,16 @@ namespace Coscine.ApiClient.Core.Model public UserMinimalDto Creator { get; set; } /// <summary> - /// Gets or Sets CreationDate + /// Date of creation of the project. /// </summary> + /// <value>Date of creation of the project.</value> [DataMember(Name = "creationDate", EmitDefaultValue = true)] public DateTime? CreationDate { get; set; } /// <summary> - /// Gets or Sets SubProjects + /// Collection of sub-projects associated with this project. /// </summary> + /// <value>Collection of sub-projects associated with this project.</value> [DataMember(Name = "subProjects", EmitDefaultValue = true)] public List<ProjectDto> SubProjects { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ProjectForCreationDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectForCreationDto.cs index 0bd2b125f34b9d1aa98000bf989506a70491e99a..7703be78165bb83eaf5737b7e482c490c79e6ba4 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectForCreationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectForCreationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectForCreationDto + /// Data transfer object (DTO) representing the creation of a project. Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ProjectForManipulationDto. /// </summary> [DataContract(Name = "ProjectForCreationDto")] public partial class ProjectForCreationDto : IEquatable<ProjectForCreationDto>, IValidatableObject @@ -40,19 +40,20 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectForCreationDto" /> class. /// </summary> - /// <param name="name">name (required).</param> - /// <param name="description">description (required).</param> - /// <param name="startDate">startDate.</param> - /// <param name="endDate">endDate.</param> - /// <param name="keywords">keywords.</param> - /// <param name="displayName">displayName.</param> - /// <param name="principleInvestigators">principleInvestigators.</param> - /// <param name="grantId">grantId.</param> + /// <param name="name">Gets or initializes the name of the project. (required).</param> + /// <param name="description">Gets or initializes the description of the project. (required).</param> + /// <param name="startDate">Gets or initializes the start date of the project..</param> + /// <param name="endDate">Gets or initializes the end date of the project..</param> + /// <param name="keywords">Gets or initializes the keywords associated with the project..</param> + /// <param name="displayName">Gets or initializes the display name of the project..</param> + /// <param name="principleInvestigators">Gets or initializes the principal investigators associated with the project..</param> + /// <param name="grantId">Gets or initializes the grant ID associated with the project..</param> /// <param name="visibility">visibility (required).</param> - /// <param name="disciplines">disciplines (required).</param> - /// <param name="organizations">organizations (required).</param> - /// <param name="parentId">parentId.</param> - public ProjectForCreationDto(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), VisibilityForProjectManipulationDto visibility = default(VisibilityForProjectManipulationDto), List<DisciplineForProjectManipulationDto> disciplines = default(List<DisciplineForProjectManipulationDto>), List<OrganizationForProjectManipulationDto> organizations = default(List<OrganizationForProjectManipulationDto>), Guid? parentId = default(Guid?)) + /// <param name="disciplines">Gets or initializes the disciplines associated with the project. (required).</param> + /// <param name="organizations">Gets or initializes the organizations associated with the project. (required).</param> + /// <param name="parentId">Gets or initializes the identifier of the parent project..</param> + /// <param name="copyOwnersFromParent">Gets or initializes if the owners of the parent project should be copied to the sub project..</param> + public ProjectForCreationDto(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), VisibilityForProjectManipulationDto visibility = default(VisibilityForProjectManipulationDto), List<DisciplineForProjectManipulationDto> disciplines = default(List<DisciplineForProjectManipulationDto>), List<OrganizationForProjectManipulationDto> organizations = default(List<OrganizationForProjectManipulationDto>), Guid? parentId = default(Guid?), bool? copyOwnersFromParent = default(bool?)) { // to ensure "name" is required (not null) if (name == null) @@ -91,53 +92,62 @@ namespace Coscine.ApiClient.Core.Model this.PrincipleInvestigators = principleInvestigators; this.GrantId = grantId; this.ParentId = parentId; + this.CopyOwnersFromParent = copyOwnersFromParent; } /// <summary> - /// Gets or Sets Name + /// Gets or initializes the name of the project. /// </summary> + /// <value>Gets or initializes the name of the project.</value> [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> - /// Gets or Sets Description + /// Gets or initializes the description of the project. /// </summary> + /// <value>Gets or initializes the description of the project.</value> [DataMember(Name = "description", IsRequired = true, EmitDefaultValue = true)] public string Description { get; set; } /// <summary> - /// Gets or Sets StartDate + /// Gets or initializes the start date of the project. /// </summary> + /// <value>Gets or initializes the start date of the project.</value> [DataMember(Name = "startDate", EmitDefaultValue = false)] public DateTime StartDate { get; set; } /// <summary> - /// Gets or Sets EndDate + /// Gets or initializes the end date of the project. /// </summary> + /// <value>Gets or initializes the end date of the project.</value> [DataMember(Name = "endDate", EmitDefaultValue = false)] public DateTime EndDate { get; set; } /// <summary> - /// Gets or Sets Keywords + /// Gets or initializes the keywords associated with the project. /// </summary> + /// <value>Gets or initializes the keywords associated with the project.</value> [DataMember(Name = "keywords", EmitDefaultValue = true)] public List<string> Keywords { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// Gets or initializes the display name of the project. /// </summary> + /// <value>Gets or initializes the display name of the project.</value> [DataMember(Name = "displayName", EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets PrincipleInvestigators + /// Gets or initializes the principal investigators associated with the project. /// </summary> + /// <value>Gets or initializes the principal investigators associated with the project.</value> [DataMember(Name = "principleInvestigators", EmitDefaultValue = true)] public string PrincipleInvestigators { get; set; } /// <summary> - /// Gets or Sets GrantId + /// Gets or initializes the grant ID associated with the project. /// </summary> + /// <value>Gets or initializes the grant ID associated with the project.</value> [DataMember(Name = "grantId", EmitDefaultValue = true)] public string GrantId { get; set; } @@ -148,23 +158,33 @@ namespace Coscine.ApiClient.Core.Model public VisibilityForProjectManipulationDto Visibility { get; set; } /// <summary> - /// Gets or Sets Disciplines + /// Gets or initializes the disciplines associated with the project. /// </summary> + /// <value>Gets or initializes the disciplines associated with the project.</value> [DataMember(Name = "disciplines", IsRequired = true, EmitDefaultValue = true)] public List<DisciplineForProjectManipulationDto> Disciplines { get; set; } /// <summary> - /// Gets or Sets Organizations + /// Gets or initializes the organizations associated with the project. /// </summary> + /// <value>Gets or initializes the organizations associated with the project.</value> [DataMember(Name = "organizations", IsRequired = true, EmitDefaultValue = true)] public List<OrganizationForProjectManipulationDto> Organizations { get; set; } /// <summary> - /// Gets or Sets ParentId + /// Gets or initializes the identifier of the parent project. /// </summary> + /// <value>Gets or initializes the identifier of the parent project.</value> [DataMember(Name = "parentId", EmitDefaultValue = true)] public Guid? ParentId { get; set; } + /// <summary> + /// Gets or initializes if the owners of the parent project should be copied to the sub project. + /// </summary> + /// <value>Gets or initializes if the owners of the parent project should be copied to the sub project.</value> + [DataMember(Name = "copyOwnersFromParent", EmitDefaultValue = true)] + public bool? CopyOwnersFromParent { get; set; } + /// <summary> /// Returns the string presentation of the object /// </summary> @@ -185,6 +205,7 @@ namespace Coscine.ApiClient.Core.Model sb.Append(" Disciplines: ").Append(Disciplines).Append("\n"); sb.Append(" Organizations: ").Append(Organizations).Append("\n"); sb.Append(" ParentId: ").Append(ParentId).Append("\n"); + sb.Append(" CopyOwnersFromParent: ").Append(CopyOwnersFromParent).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -282,6 +303,11 @@ namespace Coscine.ApiClient.Core.Model this.ParentId == input.ParentId || (this.ParentId != null && this.ParentId.Equals(input.ParentId)) + ) && + ( + this.CopyOwnersFromParent == input.CopyOwnersFromParent || + (this.CopyOwnersFromParent != null && + this.CopyOwnersFromParent.Equals(input.CopyOwnersFromParent)) ); } @@ -342,6 +368,10 @@ namespace Coscine.ApiClient.Core.Model { hashCode = (hashCode * 59) + this.ParentId.GetHashCode(); } + if (this.CopyOwnersFromParent != null) + { + hashCode = (hashCode * 59) + this.CopyOwnersFromParent.GetHashCode(); + } return hashCode; } } @@ -366,9 +396,9 @@ namespace Coscine.ApiClient.Core.Model } // Description (string) maxLength - if (this.Description != null && this.Description.Length > 5000) + if (this.Description != null && this.Description.Length > 10000) { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Description, length must be less than 5000.", new [] { "Description" }); + yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Description, length must be less than 10000.", new [] { "Description" }); } // Description (string) minLength diff --git a/src/Coscine.ApiClient.Core/Model/ProjectForUpdateDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectForUpdateDto.cs index 0c89c8d6295a753f415f301f4945452fba5f039f..de60087eef43914781b989a6ee7bdc3a5059bc0c 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectForUpdateDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectForUpdateDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectForUpdateDto + /// Data transfer object (DTO) representing the update of a project. Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ProjectForManipulationDto. /// </summary> [DataContract(Name = "ProjectForUpdateDto")] public partial class ProjectForUpdateDto : IEquatable<ProjectForUpdateDto>, IValidatableObject @@ -40,18 +40,18 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectForUpdateDto" /> class. /// </summary> - /// <param name="name">name (required).</param> - /// <param name="description">description (required).</param> - /// <param name="startDate">startDate.</param> - /// <param name="endDate">endDate.</param> - /// <param name="keywords">keywords.</param> - /// <param name="displayName">displayName.</param> - /// <param name="principleInvestigators">principleInvestigators.</param> - /// <param name="grantId">grantId.</param> + /// <param name="name">Gets or initializes the name of the project. (required).</param> + /// <param name="description">Gets or initializes the description of the project. (required).</param> + /// <param name="startDate">Gets or initializes the start date of the project..</param> + /// <param name="endDate">Gets or initializes the end date of the project..</param> + /// <param name="keywords">Gets or initializes the keywords associated with the project..</param> + /// <param name="displayName">Gets or initializes the display name of the project..</param> + /// <param name="principleInvestigators">Gets or initializes the principal investigators associated with the project..</param> + /// <param name="grantId">Gets or initializes the grant ID associated with the project..</param> /// <param name="visibility">visibility (required).</param> - /// <param name="disciplines">disciplines (required).</param> - /// <param name="organizations">organizations (required).</param> - /// <param name="slug">slug (required).</param> + /// <param name="disciplines">Gets or initializes the disciplines associated with the project. (required).</param> + /// <param name="organizations">Gets or initializes the organizations associated with the project. (required).</param> + /// <param name="slug">Gets or initializes the slug associated with the project for identification purposes. (required).</param> public ProjectForUpdateDto(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), VisibilityForProjectManipulationDto visibility = default(VisibilityForProjectManipulationDto), List<DisciplineForProjectManipulationDto> disciplines = default(List<DisciplineForProjectManipulationDto>), List<OrganizationForProjectManipulationDto> organizations = default(List<OrganizationForProjectManipulationDto>), string slug = default(string)) { // to ensure "name" is required (not null) @@ -99,50 +99,58 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Name + /// Gets or initializes the name of the project. /// </summary> + /// <value>Gets or initializes the name of the project.</value> [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> - /// Gets or Sets Description + /// Gets or initializes the description of the project. /// </summary> + /// <value>Gets or initializes the description of the project.</value> [DataMember(Name = "description", IsRequired = true, EmitDefaultValue = true)] public string Description { get; set; } /// <summary> - /// Gets or Sets StartDate + /// Gets or initializes the start date of the project. /// </summary> + /// <value>Gets or initializes the start date of the project.</value> [DataMember(Name = "startDate", EmitDefaultValue = false)] public DateTime StartDate { get; set; } /// <summary> - /// Gets or Sets EndDate + /// Gets or initializes the end date of the project. /// </summary> + /// <value>Gets or initializes the end date of the project.</value> [DataMember(Name = "endDate", EmitDefaultValue = false)] public DateTime EndDate { get; set; } /// <summary> - /// Gets or Sets Keywords + /// Gets or initializes the keywords associated with the project. /// </summary> + /// <value>Gets or initializes the keywords associated with the project.</value> [DataMember(Name = "keywords", EmitDefaultValue = true)] public List<string> Keywords { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// Gets or initializes the display name of the project. /// </summary> + /// <value>Gets or initializes the display name of the project.</value> [DataMember(Name = "displayName", EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets PrincipleInvestigators + /// Gets or initializes the principal investigators associated with the project. /// </summary> + /// <value>Gets or initializes the principal investigators associated with the project.</value> [DataMember(Name = "principleInvestigators", EmitDefaultValue = true)] public string PrincipleInvestigators { get; set; } /// <summary> - /// Gets or Sets GrantId + /// Gets or initializes the grant ID associated with the project. /// </summary> + /// <value>Gets or initializes the grant ID associated with the project.</value> [DataMember(Name = "grantId", EmitDefaultValue = true)] public string GrantId { get; set; } @@ -153,20 +161,23 @@ namespace Coscine.ApiClient.Core.Model public VisibilityForProjectManipulationDto Visibility { get; set; } /// <summary> - /// Gets or Sets Disciplines + /// Gets or initializes the disciplines associated with the project. /// </summary> + /// <value>Gets or initializes the disciplines associated with the project.</value> [DataMember(Name = "disciplines", IsRequired = true, EmitDefaultValue = true)] public List<DisciplineForProjectManipulationDto> Disciplines { get; set; } /// <summary> - /// Gets or Sets Organizations + /// Gets or initializes the organizations associated with the project. /// </summary> + /// <value>Gets or initializes the organizations associated with the project.</value> [DataMember(Name = "organizations", IsRequired = true, EmitDefaultValue = true)] public List<OrganizationForProjectManipulationDto> Organizations { get; set; } /// <summary> - /// Gets or Sets Slug + /// Gets or initializes the slug associated with the project for identification purposes. /// </summary> + /// <value>Gets or initializes the slug associated with the project for identification purposes.</value> [DataMember(Name = "slug", IsRequired = true, EmitDefaultValue = true)] public string Slug { get; set; } @@ -371,9 +382,9 @@ namespace Coscine.ApiClient.Core.Model } // Description (string) maxLength - if (this.Description != null && this.Description.Length > 5000) + if (this.Description != null && this.Description.Length > 10000) { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Description, length must be less than 5000.", new [] { "Description" }); + yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Description, length must be less than 10000.", new [] { "Description" }); } // Description (string) minLength diff --git a/src/Coscine.ApiClient.Core/Model/ProjectInvitationDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectInvitationDto.cs index 1755c609725711b135df08944d04743bdc569f76..67f04e71ff100708f98e821239f370704b9891bc 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectInvitationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectInvitationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectInvitationDto + /// Represents a data transfer object (DTO) for project invitations. /// </summary> [DataContract(Name = "ProjectInvitationDto")] public partial class ProjectInvitationDto : IEquatable<ProjectInvitationDto>, IValidatableObject @@ -35,9 +35,9 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectInvitationDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="expirationDate">expirationDate.</param> - /// <param name="email">email.</param> + /// <param name="id">Unique identifier for the invitation..</param> + /// <param name="expirationDate">Expiration date of the invitation..</param> + /// <param name="email">Email associated with the invitation..</param> /// <param name="issuer">issuer.</param> /// <param name="project">project.</param> /// <param name="role">role.</param> @@ -52,20 +52,23 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// Unique identifier for the invitation. /// </summary> + /// <value>Unique identifier for the invitation.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets ExpirationDate + /// Expiration date of the invitation. /// </summary> + /// <value>Expiration date of the invitation.</value> [DataMember(Name = "expirationDate", EmitDefaultValue = false)] public DateTime ExpirationDate { get; set; } /// <summary> - /// Gets or Sets Email + /// Email associated with the invitation. /// </summary> + /// <value>Email associated with the invitation.</value> [DataMember(Name = "email", EmitDefaultValue = false)] public string Email { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ProjectInvitationForProjectManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectInvitationForProjectManipulationDto.cs index 5f098b3e7992c13a3d71b7f62b97b94ee717257d..1cd0489ebf5307da4ad1147d99d0bf2c1ae60177 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectInvitationForProjectManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectInvitationForProjectManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectInvitationForProjectManipulationDto + /// Data transfer object (DTO) representing an invitation for project manipulation. /// </summary> [DataContract(Name = "ProjectInvitationForProjectManipulationDto")] public partial class ProjectInvitationForProjectManipulationDto : IEquatable<ProjectInvitationForProjectManipulationDto>, IValidatableObject @@ -40,8 +40,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectInvitationForProjectManipulationDto" /> class. /// </summary> - /// <param name="roleId">roleId (required).</param> - /// <param name="email">email (required).</param> + /// <param name="roleId">Gets or initializes the identifier of the role associated with the invitation. (required).</param> + /// <param name="email">Gets or initializes the email address of the invited user. (required).</param> public ProjectInvitationForProjectManipulationDto(Guid roleId = default(Guid), string email = default(string)) { this.RoleId = roleId; @@ -54,14 +54,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets RoleId + /// Gets or initializes the identifier of the role associated with the invitation. /// </summary> + /// <value>Gets or initializes the identifier of the role associated with the invitation.</value> [DataMember(Name = "roleId", IsRequired = true, EmitDefaultValue = true)] public Guid RoleId { get; set; } /// <summary> - /// Gets or Sets Email + /// Gets or initializes the email address of the invited user. /// </summary> + /// <value>Gets or initializes the email address of the invited user.</value> [DataMember(Name = "email", IsRequired = true, EmitDefaultValue = true)] public string Email { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ProjectInvitationResolveDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectInvitationResolveDto.cs index 130d720740d60259452b412fd263f59874270d9c..6f43444e8560d6b39c990df3ab4f671a308f3b86 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectInvitationResolveDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectInvitationResolveDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectInvitationResolveDto + /// Data transfer object (DTO) for resolving a project invitation. /// </summary> [DataContract(Name = "ProjectInvitationResolveDto")] public partial class ProjectInvitationResolveDto : IEquatable<ProjectInvitationResolveDto>, IValidatableObject @@ -40,15 +40,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectInvitationResolveDto" /> class. /// </summary> - /// <param name="token">token (required).</param> + /// <param name="token">Gets or initializes the token associated with resolving the project invitation. (required).</param> public ProjectInvitationResolveDto(Guid token = default(Guid)) { this.Token = token; } /// <summary> - /// Gets or Sets Token + /// Gets or initializes the token associated with resolving the project invitation. /// </summary> + /// <value>Gets or initializes the token associated with resolving the project invitation.</value> [DataMember(Name = "token", IsRequired = true, EmitDefaultValue = true)] public Guid Token { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ProjectMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectMinimalDto.cs index 5529e19400fbfade16fad1480a8be6a69a18a0e7..70a500ed7dc7a7f99244695c53ab891252b760ed 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectMinimalDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectMinimalDto + /// Represents a minimal data transfer object (DTO) for a project. /// </summary> [DataContract(Name = "ProjectMinimalDto")] public partial class ProjectMinimalDto : IEquatable<ProjectMinimalDto>, IValidatableObject @@ -35,15 +35,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectMinimalDto" /> class. /// </summary> - /// <param name="id">id.</param> + /// <param name="id">Unique identifier for the project..</param> public ProjectMinimalDto(Guid id = default(Guid)) { this.Id = id; } /// <summary> - /// Gets or Sets Id + /// Unique identifier for the project. /// </summary> + /// <value>Unique identifier for the project.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ProjectQuotaDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectQuotaDto.cs index 8b5d7899ec81922e3e35edd9c59ddc76fc4ce4c6..605e58c6b70870f0dc993770d31414e7ddfe3508 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectQuotaDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectQuotaDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectQuotaDto + /// Represents a data transfer object (DTO) containing quota information for a project. /// </summary> [DataContract(Name = "ProjectQuotaDto")] public partial class ProjectQuotaDto : IEquatable<ProjectQuotaDto>, IValidatableObject @@ -35,13 +35,13 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectQuotaDto" /> class. /// </summary> - /// <param name="projectId">projectId.</param> + /// <param name="projectId">Identifier of the project..</param> /// <param name="totalUsed">totalUsed.</param> /// <param name="totalReserved">totalReserved.</param> /// <param name="allocated">allocated.</param> /// <param name="maximum">maximum.</param> /// <param name="resourceType">resourceType.</param> - /// <param name="resourceQuotas">resourceQuotas.</param> + /// <param name="resourceQuotas">Quota information for individual resources of the selected project's resource type..</param> public ProjectQuotaDto(Guid projectId = default(Guid), QuotaDto totalUsed = default(QuotaDto), QuotaDto totalReserved = default(QuotaDto), QuotaDto allocated = default(QuotaDto), QuotaDto maximum = default(QuotaDto), ResourceTypeMinimalDto resourceType = default(ResourceTypeMinimalDto), List<ResourceQuotaDto> resourceQuotas = default(List<ResourceQuotaDto>)) { this.ProjectId = projectId; @@ -54,8 +54,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets ProjectId + /// Identifier of the project. /// </summary> + /// <value>Identifier of the project.</value> [DataMember(Name = "projectId", EmitDefaultValue = false)] public Guid ProjectId { get; set; } @@ -90,8 +91,9 @@ namespace Coscine.ApiClient.Core.Model public ResourceTypeMinimalDto ResourceType { get; set; } /// <summary> - /// Gets or Sets ResourceQuotas + /// Quota information for individual resources of the selected project's resource type. /// </summary> + /// <value>Quota information for individual resources of the selected project's resource type.</value> [DataMember(Name = "resourceQuotas", EmitDefaultValue = true)] public List<ResourceQuotaDto> ResourceQuotas { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ProjectQuotaForUpdateDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectQuotaForUpdateDto.cs index 085ce71b2ab430b384c2f481c76d72f0248dae60..2c238eb196ebac44fa53f2118aaf07d287ae0876 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectQuotaForUpdateDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectQuotaForUpdateDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectQuotaForUpdateDto + /// Data transfer object (DTO) representing the update of project quotas. /// </summary> [DataContract(Name = "ProjectQuotaForUpdateDto")] public partial class ProjectQuotaForUpdateDto : IEquatable<ProjectQuotaForUpdateDto>, IValidatableObject diff --git a/src/Coscine.ApiClient.Core/Model/ProjectResourceMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectResourceMinimalDto.cs index 066a8cd63d8b095d629f6a7050118d76b95792c4..85672724af426fe01fb52e20b334b99facda914f 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectResourceMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectResourceMinimalDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectResourceMinimalDto + /// Represents a minimal data transfer object (DTO) for a project resource. /// </summary> [DataContract(Name = "ProjectResourceMinimalDto")] public partial class ProjectResourceMinimalDto : IEquatable<ProjectResourceMinimalDto>, IValidatableObject @@ -35,8 +35,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectResourceMinimalDto" /> class. /// </summary> - /// <param name="resourceId">resourceId.</param> - /// <param name="projectId">projectId.</param> + /// <param name="resourceId">Identifier of the resource..</param> + /// <param name="projectId">Identifier of the project associated with the resource..</param> public ProjectResourceMinimalDto(Guid resourceId = default(Guid), Guid projectId = default(Guid)) { this.ResourceId = resourceId; @@ -44,14 +44,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets ResourceId + /// Identifier of the resource. /// </summary> + /// <value>Identifier of the resource.</value> [DataMember(Name = "resourceId", EmitDefaultValue = false)] public Guid ResourceId { get; set; } /// <summary> - /// Gets or Sets ProjectId + /// Identifier of the project associated with the resource. /// </summary> + /// <value>Identifier of the project associated with the resource.</value> [DataMember(Name = "projectId", EmitDefaultValue = false)] public Guid ProjectId { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ProjectRoleDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectRoleDto.cs index 4867a2adb85ad4f181812c81421fb941c9fa1788..642b7078d887b946ca76418adeca6c3563e86d6c 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectRoleDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectRoleDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectRoleDto + /// Represents a data transfer object (DTO) for a project role. /// </summary> [DataContract(Name = "ProjectRoleDto")] public partial class ProjectRoleDto : IEquatable<ProjectRoleDto>, IValidatableObject @@ -35,7 +35,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectRoleDto" /> class. /// </summary> - /// <param name="id">id.</param> + /// <param name="id">Identifier of the project role..</param> /// <param name="project">project.</param> /// <param name="role">role.</param> /// <param name="user">user.</param> @@ -48,8 +48,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// Identifier of the project role. /// </summary> + /// <value>Identifier of the project role.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ProjectRoleForProjectCreationDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectRoleForProjectCreationDto.cs index 3b5bb633d394139cf407aa7fe056437734364344..80aa9d837eee5df0dde4cb41701a25c534076881 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectRoleForProjectCreationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectRoleForProjectCreationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectRoleForProjectCreationDto + /// Data transfer object (DTO) representing the creation of a project role within a project. Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ProjectRoleForProjectManipulationDto. /// </summary> [DataContract(Name = "ProjectRoleForProjectCreationDto")] public partial class ProjectRoleForProjectCreationDto : IEquatable<ProjectRoleForProjectCreationDto>, IValidatableObject @@ -40,8 +40,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectRoleForProjectCreationDto" /> class. /// </summary> - /// <param name="roleId">roleId (required).</param> - /// <param name="userId">userId (required).</param> + /// <param name="roleId">Gets or initializes the identifier of the role associated with the project manipulation. (required).</param> + /// <param name="userId">Gets or initializes the identifier of the user associated with the project role creation. (required).</param> public ProjectRoleForProjectCreationDto(Guid roleId = default(Guid), Guid userId = default(Guid)) { this.RoleId = roleId; @@ -49,14 +49,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets RoleId + /// Gets or initializes the identifier of the role associated with the project manipulation. /// </summary> + /// <value>Gets or initializes the identifier of the role associated with the project manipulation.</value> [DataMember(Name = "roleId", IsRequired = true, EmitDefaultValue = true)] public Guid RoleId { get; set; } /// <summary> - /// Gets or Sets UserId + /// Gets or initializes the identifier of the user associated with the project role creation. /// </summary> + /// <value>Gets or initializes the identifier of the user associated with the project role creation.</value> [DataMember(Name = "userId", IsRequired = true, EmitDefaultValue = true)] public Guid UserId { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ProjectRoleForProjectManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectRoleForProjectManipulationDto.cs index da94510bd20bf8162beed5d8616a413cd01242a6..37e9111c7513cea01e082845830153a259cc13bc 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectRoleForProjectManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectRoleForProjectManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectRoleForProjectManipulationDto + /// Data transfer object (DTO) representing a project role for manipulation within a project. /// </summary> [DataContract(Name = "ProjectRoleForProjectManipulationDto")] public partial class ProjectRoleForProjectManipulationDto : IEquatable<ProjectRoleForProjectManipulationDto>, IValidatableObject @@ -40,15 +40,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectRoleForProjectManipulationDto" /> class. /// </summary> - /// <param name="roleId">roleId (required).</param> + /// <param name="roleId">Gets or initializes the identifier of the role associated with the project manipulation. (required).</param> public ProjectRoleForProjectManipulationDto(Guid roleId = default(Guid)) { this.RoleId = roleId; } /// <summary> - /// Gets or Sets RoleId + /// Gets or initializes the identifier of the role associated with the project manipulation. /// </summary> + /// <value>Gets or initializes the identifier of the role associated with the project manipulation.</value> [DataMember(Name = "roleId", IsRequired = true, EmitDefaultValue = true)] public Guid RoleId { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ProjectRoleMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/ProjectRoleMinimalDto.cs index c0c957649f65d12dce1b7e14909767b1e9cc9994..4729794486fd78f7f5d03988a7472014dd37ad57 100644 --- a/src/Coscine.ApiClient.Core/Model/ProjectRoleMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ProjectRoleMinimalDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ProjectRoleMinimalDto + /// Represents a minimal data transfer object (DTO) for a project role. /// </summary> [DataContract(Name = "ProjectRoleMinimalDto")] public partial class ProjectRoleMinimalDto : IEquatable<ProjectRoleMinimalDto>, IValidatableObject @@ -35,9 +35,9 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ProjectRoleMinimalDto" /> class. /// </summary> - /// <param name="projectId">projectId.</param> - /// <param name="userId">userId.</param> - /// <param name="roleId">roleId.</param> + /// <param name="projectId">Identifier of the project associated with the role..</param> + /// <param name="userId">Identifier of the user associated with the role..</param> + /// <param name="roleId">Identifier of the role..</param> public ProjectRoleMinimalDto(Guid projectId = default(Guid), Guid userId = default(Guid), Guid roleId = default(Guid)) { this.ProjectId = projectId; @@ -46,20 +46,23 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets ProjectId + /// Identifier of the project associated with the role. /// </summary> + /// <value>Identifier of the project associated with the role.</value> [DataMember(Name = "projectId", EmitDefaultValue = false)] public Guid ProjectId { get; set; } /// <summary> - /// Gets or Sets UserId + /// Identifier of the user associated with the role. /// </summary> + /// <value>Identifier of the user associated with the role.</value> [DataMember(Name = "userId", EmitDefaultValue = false)] public Guid UserId { get; set; } /// <summary> - /// Gets or Sets RoleId + /// Identifier of the role. /// </summary> + /// <value>Identifier of the role.</value> [DataMember(Name = "roleId", EmitDefaultValue = false)] public Guid RoleId { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/PublicUserDto.cs b/src/Coscine.ApiClient.Core/Model/PublicUserDto.cs index ec415f8d2c66be836733ca6a93aa702e01b33114..a7beed974f78aecd57c5d85cccdd80867b12519c 100644 --- a/src/Coscine.ApiClient.Core/Model/PublicUserDto.cs +++ b/src/Coscine.ApiClient.Core/Model/PublicUserDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// PublicUserDto + /// Represents a public user data transfer object (DTO). /// </summary> [DataContract(Name = "PublicUserDto")] public partial class PublicUserDto : IEquatable<PublicUserDto>, IValidatableObject @@ -35,11 +35,11 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="PublicUserDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="displayName">displayName.</param> - /// <param name="givenName">givenName.</param> - /// <param name="familyName">familyName.</param> - /// <param name="email">email.</param> + /// <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> /// <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)) { @@ -52,32 +52,37 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// Unique identifier of the user. /// </summary> + /// <value>Unique identifier of the user.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// Display name of the user. /// </summary> + /// <value>Display name of the user.</value> [DataMember(Name = "displayName", EmitDefaultValue = false)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets GivenName + /// Given name of the user. /// </summary> + /// <value>Given name of the user.</value> [DataMember(Name = "givenName", EmitDefaultValue = false)] public string GivenName { get; set; } /// <summary> - /// Gets or Sets FamilyName + /// Family name of the user. /// </summary> + /// <value>Family name of the user.</value> [DataMember(Name = "familyName", EmitDefaultValue = false)] public string FamilyName { get; set; } /// <summary> - /// Gets or Sets Email + /// Email address of the user. /// </summary> + /// <value>Email address of the user.</value> [DataMember(Name = "email", EmitDefaultValue = false)] public string Email { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/QuotaDto.cs b/src/Coscine.ApiClient.Core/Model/QuotaDto.cs index 6be0d4f9ed9df57aabb5f3a0b56bc982133b0c1d..ca264629e84a79a4848fecca000d3996b5cda7f0 100644 --- a/src/Coscine.ApiClient.Core/Model/QuotaDto.cs +++ b/src/Coscine.ApiClient.Core/Model/QuotaDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// QuotaDto + /// Represents a Data Transfer Object (DTO) for quota values. /// </summary> [DataContract(Name = "QuotaDto")] public partial class QuotaDto : IEquatable<QuotaDto>, IValidatableObject @@ -46,7 +46,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="QuotaDto" /> class. /// </summary> - /// <param name="value">value (required).</param> + /// <param name="value">The value of the quota. (required).</param> /// <param name="unit">unit (required).</param> public QuotaDto(float value = default(float), QuotaUnit unit = default(QuotaUnit)) { @@ -55,8 +55,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Value + /// The value of the quota. /// </summary> + /// <value>The value of the quota.</value> [DataMember(Name = "value", IsRequired = true, EmitDefaultValue = true)] public float Value { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/QuotaForManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/QuotaForManipulationDto.cs index cf63f2606b01cec6cee3b3365c0d4d7c000ced82..d2942aac0beb65a44bdbded4b41bbad4bd086b3c 100644 --- a/src/Coscine.ApiClient.Core/Model/QuotaForManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/QuotaForManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// QuotaForManipulationDto + /// Represents a data transfer object (DTO) used for manipulating quota values. /// </summary> [DataContract(Name = "QuotaForManipulationDto")] public partial class QuotaForManipulationDto : IEquatable<QuotaForManipulationDto>, IValidatableObject @@ -46,7 +46,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="QuotaForManipulationDto" /> class. /// </summary> - /// <param name="value">value (required).</param> + /// <param name="value">The numerical value of the quota. Must be a positive System.Int64. (required).</param> /// <param name="unit">unit (required).</param> public QuotaForManipulationDto(long value = default(long), QuotaUnit unit = default(QuotaUnit)) { @@ -55,8 +55,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Value + /// The numerical value of the quota. Must be a positive System.Int64. /// </summary> + /// <value>The numerical value of the quota. Must be a positive System.Int64.</value> [DataMember(Name = "value", IsRequired = true, EmitDefaultValue = true)] public long Value { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/QuotaUnit.cs b/src/Coscine.ApiClient.Core/Model/QuotaUnit.cs index 49c004d7958eb1c9638554bdfe9ee5c0a696a543..4058592036fc566cbc28a0fcfb1fbaa2629d292d 100644 --- a/src/Coscine.ApiClient.Core/Model/QuotaUnit.cs +++ b/src/Coscine.ApiClient.Core/Model/QuotaUnit.cs @@ -27,8 +27,9 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// Defines QuotaUnit + /// Specifies the unit of quota. /// </summary> + /// <value>Specifies the unit of quota.</value> [JsonConverter(typeof(StringEnumConverter))] public enum QuotaUnit { diff --git a/src/Coscine.ApiClient.Core/Model/RdfDefinitionDto.cs b/src/Coscine.ApiClient.Core/Model/RdfDefinitionDto.cs index 2a73e7e7967706abe4b50d57c7509b13cd24ee81..3f11786a5c045a5ad48fe6ddb3ccd78c0fb4af0e 100644 --- a/src/Coscine.ApiClient.Core/Model/RdfDefinitionDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdfDefinitionDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// RdfDefinitionDto + /// Represents a Data Transfer Object (DTO) for RDF (Resource Description Framework) definition details. /// </summary> [DataContract(Name = "RdfDefinitionDto")] public partial class RdfDefinitionDto : IEquatable<RdfDefinitionDto>, IValidatableObject @@ -35,8 +35,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RdfDefinitionDto" /> class. /// </summary> - /// <param name="content">content.</param> - /// <param name="type">type.</param> + /// <param name="content">The content of the RDF definition..</param> + /// <param name="type">The type of the RDF definition..</param> public RdfDefinitionDto(string content = default(string), string type = default(string)) { this.Content = content; @@ -44,14 +44,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Content + /// The content of the RDF definition. /// </summary> + /// <value>The content of the RDF definition.</value> [DataMember(Name = "content", EmitDefaultValue = true)] public string Content { get; set; } /// <summary> - /// Gets or Sets Type + /// The type of the RDF definition. /// </summary> + /// <value>The type of the RDF definition.</value> [DataMember(Name = "type", EmitDefaultValue = true)] public string Type { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/RdfDefinitionForManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/RdfDefinitionForManipulationDto.cs index 9470e4002f55ae855880119af03daded3382545a..ef640792099febafeee38a84f2861cedbe968a55 100644 --- a/src/Coscine.ApiClient.Core/Model/RdfDefinitionForManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdfDefinitionForManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// RdfDefinitionForManipulationDto + /// Represents the data transfer object (DTO) used for manipulating RDF definitions. /// </summary> [DataContract(Name = "RdfDefinitionForManipulationDto")] public partial class RdfDefinitionForManipulationDto : IEquatable<RdfDefinitionForManipulationDto>, IValidatableObject @@ -46,7 +46,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RdfDefinitionForManipulationDto" /> class. /// </summary> - /// <param name="content">content (required).</param> + /// <param name="content">The content of the RDF definition. (required).</param> /// <param name="type">type (required).</param> public RdfDefinitionForManipulationDto(string content = default(string), RdfFormat type = default(RdfFormat)) { @@ -60,8 +60,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Content + /// The content of the RDF definition. /// </summary> + /// <value>The content of the RDF definition.</value> [DataMember(Name = "content", IsRequired = true, EmitDefaultValue = true)] public string Content { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/RdfFormat.cs b/src/Coscine.ApiClient.Core/Model/RdfFormat.cs index 434870444b2e7760981758548326d12325a90c0f..c777f88648d7ef4aec05c32b8b621ac9d876cd43 100644 --- a/src/Coscine.ApiClient.Core/Model/RdfFormat.cs +++ b/src/Coscine.ApiClient.Core/Model/RdfFormat.cs @@ -27,8 +27,9 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// Defines RdfFormat + /// Specifies the RDF <i>(Resource Description Framework)</i> format. /// </summary> + /// <value>Specifies the RDF <i>(Resource Description Framework)</i> format.</value> [JsonConverter(typeof(StringEnumConverter))] public enum RdfFormat { diff --git a/src/Coscine.ApiClient.Core/Model/RdfPatchDocumentDto.cs b/src/Coscine.ApiClient.Core/Model/RdfPatchDocumentDto.cs new file mode 100644 index 0000000000000000000000000000000000000000..ffd641f0fc210ac1047fe812d21a19fb25c95b7b --- /dev/null +++ b/src/Coscine.ApiClient.Core/Model/RdfPatchDocumentDto.cs @@ -0,0 +1,131 @@ +/* + * Coscine Web API (Internal Use Only) + * + * 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> + /// Represents an RDF Patch document containing a series of operations. + /// </summary> + [DataContract(Name = "RdfPatchDocumentDto")] + public partial class RdfPatchDocumentDto : IEquatable<RdfPatchDocumentDto>, IValidatableObject + { + /// <summary> + /// Initializes a new instance of the <see cref="RdfPatchDocumentDto" /> class. + /// </summary> + /// <param name="operations">The list of operations in the RDF Patch document..</param> + public RdfPatchDocumentDto(List<RdfPatchOperationDto> operations = default(List<RdfPatchOperationDto>)) + { + this.Operations = operations; + } + + /// <summary> + /// The list of operations in the RDF Patch document. + /// </summary> + /// <value>The list of operations in the RDF Patch document.</value> + [DataMember(Name = "operations", EmitDefaultValue = false)] + public List<RdfPatchOperationDto> Operations { 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 RdfPatchDocumentDto {\n"); + sb.Append(" Operations: ").Append(Operations).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> + /// Returns true if objects are equal + /// </summary> + /// <param name="input">Object to be compared</param> + /// <returns>Boolean</returns> + public override bool Equals(object input) + { + return this.Equals(input as RdfPatchDocumentDto); + } + + /// <summary> + /// Returns true if RdfPatchDocumentDto instances are equal + /// </summary> + /// <param name="input">Instance of RdfPatchDocumentDto to be compared</param> + /// <returns>Boolean</returns> + public bool Equals(RdfPatchDocumentDto input) + { + if (input == null) + { + return false; + } + return + ( + this.Operations == input.Operations || + this.Operations != null && + input.Operations != null && + this.Operations.SequenceEqual(input.Operations) + ); + } + + /// <summary> + /// Gets the hash code + /// </summary> + /// <returns>Hash code</returns> + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + if (this.Operations != null) + { + hashCode = (hashCode * 59) + this.Operations.GetHashCode(); + } + return hashCode; + } + } + + /// <summary> + /// To validate all properties of the instance + /// </summary> + /// <param name="validationContext">Validation context</param> + /// <returns>Validation Result</returns> + IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/src/Coscine.ApiClient.Core/Model/RdfPatchOperationDto.cs b/src/Coscine.ApiClient.Core/Model/RdfPatchOperationDto.cs new file mode 100644 index 0000000000000000000000000000000000000000..0695f1ec9cb7eed9fc1c566e62a71c788f4cb659 --- /dev/null +++ b/src/Coscine.ApiClient.Core/Model/RdfPatchOperationDto.cs @@ -0,0 +1,143 @@ +/* + * Coscine Web API (Internal Use Only) + * + * 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> + /// Represents a single operation in an RDF Patch document. + /// </summary> + [DataContract(Name = "RdfPatchOperationDto")] + public partial class RdfPatchOperationDto : IEquatable<RdfPatchOperationDto>, IValidatableObject + { + + /// <summary> + /// Gets or Sets OperationType + /// </summary> + [DataMember(Name = "operationType", EmitDefaultValue = false)] + public RdfPatchOperationType? OperationType { get; set; } + /// <summary> + /// Initializes a new instance of the <see cref="RdfPatchOperationDto" /> class. + /// </summary> + /// <param name="operationType">operationType.</param> + /// <param name="changes">changes.</param> + public RdfPatchOperationDto(RdfPatchOperationType? operationType = default(RdfPatchOperationType?), RdfDefinitionForManipulationDto changes = default(RdfDefinitionForManipulationDto)) + { + this.OperationType = operationType; + this.Changes = changes; + } + + /// <summary> + /// Gets or Sets Changes + /// </summary> + [DataMember(Name = "changes", EmitDefaultValue = false)] + public RdfDefinitionForManipulationDto Changes { 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 RdfPatchOperationDto {\n"); + sb.Append(" OperationType: ").Append(OperationType).Append("\n"); + sb.Append(" Changes: ").Append(Changes).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> + /// Returns true if objects are equal + /// </summary> + /// <param name="input">Object to be compared</param> + /// <returns>Boolean</returns> + public override bool Equals(object input) + { + return this.Equals(input as RdfPatchOperationDto); + } + + /// <summary> + /// Returns true if RdfPatchOperationDto instances are equal + /// </summary> + /// <param name="input">Instance of RdfPatchOperationDto to be compared</param> + /// <returns>Boolean</returns> + public bool Equals(RdfPatchOperationDto input) + { + if (input == null) + { + return false; + } + return + ( + this.OperationType == input.OperationType || + this.OperationType.Equals(input.OperationType) + ) && + ( + this.Changes == input.Changes || + (this.Changes != null && + this.Changes.Equals(input.Changes)) + ); + } + + /// <summary> + /// Gets the hash code + /// </summary> + /// <returns>Hash code</returns> + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + hashCode = (hashCode * 59) + this.OperationType.GetHashCode(); + if (this.Changes != null) + { + hashCode = (hashCode * 59) + this.Changes.GetHashCode(); + } + return hashCode; + } + } + + /// <summary> + /// To validate all properties of the instance + /// </summary> + /// <param name="validationContext">Validation context</param> + /// <returns>Validation Result</returns> + IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + } + +} diff --git a/src/Coscine.ApiClient.Core/Model/RdfPatchOperationType.cs b/src/Coscine.ApiClient.Core/Model/RdfPatchOperationType.cs new file mode 100644 index 0000000000000000000000000000000000000000..f406d5b0f3ef76c837a7b69901237f5cc53d15ee --- /dev/null +++ b/src/Coscine.ApiClient.Core/Model/RdfPatchOperationType.cs @@ -0,0 +1,49 @@ +/* + * Coscine Web API (Internal Use Only) + * + * 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> + /// Represents the types of operations that can be performed in an RDF Patch document. + /// </summary> + /// <value>Represents the types of operations that can be performed in an RDF Patch document.</value> + [JsonConverter(typeof(StringEnumConverter))] + public enum RdfPatchOperationType + { + /// <summary> + /// Enum A for value: A + /// </summary> + [EnumMember(Value = "A")] + A = 1, + + /// <summary> + /// Enum D for value: D + /// </summary> + [EnumMember(Value = "D")] + D = 2 + } + +} diff --git a/src/Coscine.ApiClient.Core/Model/RdsOptionsDto.cs b/src/Coscine.ApiClient.Core/Model/RdsOptionsDto.cs index ccf2a7fb95978580fdfa939c22f6d37cbad47093..c82ea43c2c0d55e70d31063e1e0ac25488813112 100644 --- a/src/Coscine.ApiClient.Core/Model/RdsOptionsDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdsOptionsDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// RdsOptionsDto + /// Represents the data transfer object (DTO) for RDS options. /// </summary> [DataContract(Name = "RdsOptionsDto")] public partial class RdsOptionsDto : IEquatable<RdsOptionsDto>, IValidatableObject @@ -35,7 +35,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RdsOptionsDto" /> class. /// </summary> - /// <param name="bucketName">bucketName.</param> + /// <param name="bucketName">The name of the bucket associated with RDS..</param> /// <param name="size">size.</param> public RdsOptionsDto(string bucketName = default(string), QuotaDto size = default(QuotaDto)) { @@ -44,8 +44,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets BucketName + /// The name of the bucket associated with RDS. /// </summary> + /// <value>The name of the bucket associated with RDS.</value> [DataMember(Name = "bucketName", EmitDefaultValue = false)] public string BucketName { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/RdsResourceTypeOptionsForManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/RdsResourceTypeOptionsForManipulationDto.cs index ac96af2653e160208a1f4179935754df0909fda0..b900ef563473bcf35628fe84bc4c64d8109960f0 100644 --- a/src/Coscine.ApiClient.Core/Model/RdsResourceTypeOptionsForManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdsResourceTypeOptionsForManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// RdsResourceTypeOptionsForManipulationDto + /// Represents the data transfer object (DTO) for manipulating RDS Web resource type options. /// </summary> [DataContract(Name = "RdsResourceTypeOptionsForManipulationDto")] public partial class RdsResourceTypeOptionsForManipulationDto : IEquatable<RdsResourceTypeOptionsForManipulationDto>, IValidatableObject diff --git a/src/Coscine.ApiClient.Core/Model/RdsS3OptionsDto.cs b/src/Coscine.ApiClient.Core/Model/RdsS3OptionsDto.cs index 5489902dd81795af52ed7f88eda15166d2957586..996a98d346346b4141f095fca4e0b4a9b3eafec5 100644 --- a/src/Coscine.ApiClient.Core/Model/RdsS3OptionsDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdsS3OptionsDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// RdsS3OptionsDto + /// Represents the data transfer object (DTO) for RDS S3 options. /// </summary> [DataContract(Name = "RdsS3OptionsDto")] public partial class RdsS3OptionsDto : IEquatable<RdsS3OptionsDto>, IValidatableObject @@ -35,12 +35,12 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RdsS3OptionsDto" /> class. /// </summary> - /// <param name="bucketName">bucketName.</param> - /// <param name="accessKeyRead">accessKeyRead.</param> - /// <param name="secretKeyRead">secretKeyRead.</param> - /// <param name="accessKeyWrite">accessKeyWrite.</param> - /// <param name="secretKeyWrite">secretKeyWrite.</param> - /// <param name="endpoint">endpoint.</param> + /// <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> /// <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)) { @@ -54,38 +54,44 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets BucketName + /// 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)] public string BucketName { get; set; } /// <summary> - /// Gets or Sets AccessKeyRead + /// 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)] public string AccessKeyRead { get; set; } /// <summary> - /// Gets or Sets SecretKeyRead + /// 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)] public string SecretKeyRead { get; set; } /// <summary> - /// Gets or Sets AccessKeyWrite + /// 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)] public string AccessKeyWrite { get; set; } /// <summary> - /// Gets or Sets SecretKeyWrite + /// 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)] public string SecretKeyWrite { get; set; } /// <summary> - /// Gets or Sets Endpoint + /// The endpoint for the RDS S3 bucket. /// </summary> + /// <value>The endpoint for the RDS S3 bucket.</value> [DataMember(Name = "endpoint", EmitDefaultValue = false)] public string Endpoint { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/RdsS3ResourceTypeOptionsForManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/RdsS3ResourceTypeOptionsForManipulationDto.cs index b05412bca360e8887ea0b43ac65bbe1fcf0c7254..9a9e4728524116990606e33d36a47b1f8d1a9241 100644 --- a/src/Coscine.ApiClient.Core/Model/RdsS3ResourceTypeOptionsForManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdsS3ResourceTypeOptionsForManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// RdsS3ResourceTypeOptionsForManipulationDto + /// Represents the data transfer object (DTO) for manipulating RDS S3 resource type options. /// </summary> [DataContract(Name = "RdsS3ResourceTypeOptionsForManipulationDto")] public partial class RdsS3ResourceTypeOptionsForManipulationDto : IEquatable<RdsS3ResourceTypeOptionsForManipulationDto>, IValidatableObject diff --git a/src/Coscine.ApiClient.Core/Model/RdsS3WormOptionsDto.cs b/src/Coscine.ApiClient.Core/Model/RdsS3WormOptionsDto.cs index b1eaa5e620f9720bf4d0a593ddce8705de6494f6..d45a69297fecd234c21104e384af737cdd3b5294 100644 --- a/src/Coscine.ApiClient.Core/Model/RdsS3WormOptionsDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdsS3WormOptionsDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// RdsS3WormOptionsDto + /// Represents the data transfer object (DTO) for RDS S3 WORM options. /// </summary> [DataContract(Name = "RdsS3WormOptionsDto")] public partial class RdsS3WormOptionsDto : IEquatable<RdsS3WormOptionsDto>, IValidatableObject @@ -35,12 +35,12 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RdsS3WormOptionsDto" /> class. /// </summary> - /// <param name="bucketName">bucketName.</param> - /// <param name="accessKeyRead">accessKeyRead.</param> - /// <param name="secretKeyRead">secretKeyRead.</param> - /// <param name="accessKeyWrite">accessKeyWrite.</param> - /// <param name="secretKeyWrite">secretKeyWrite.</param> - /// <param name="endpoint">endpoint.</param> + /// <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> /// <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)) { @@ -54,38 +54,44 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets BucketName + /// 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)] public string BucketName { get; set; } /// <summary> - /// Gets or Sets AccessKeyRead + /// 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)] public string AccessKeyRead { get; set; } /// <summary> - /// Gets or Sets SecretKeyRead + /// 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)] public string SecretKeyRead { get; set; } /// <summary> - /// Gets or Sets AccessKeyWrite + /// 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)] public string AccessKeyWrite { get; set; } /// <summary> - /// Gets or Sets SecretKeyWrite + /// 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)] public string SecretKeyWrite { get; set; } /// <summary> - /// Gets or Sets Endpoint + /// The endpoint for the RDS S3 WORM bucket. /// </summary> + /// <value>The endpoint for the RDS S3 WORM bucket.</value> [DataMember(Name = "endpoint", EmitDefaultValue = false)] public string Endpoint { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/RdsS3WormResourceTypeOptionsForManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/RdsS3WormResourceTypeOptionsForManipulationDto.cs index fc49c5f494d65b2b4d3054be4b5d3d82f133a576..5fd3081a30a4cdc01067b4a22001f1669466c8e4 100644 --- a/src/Coscine.ApiClient.Core/Model/RdsS3WormResourceTypeOptionsForManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RdsS3WormResourceTypeOptionsForManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// RdsS3WormResourceTypeOptionsForManipulationDto + /// Represents the data transfer object (DTO) for manipulating RDS S3 WORM resource type options. /// </summary> [DataContract(Name = "RdsS3WormResourceTypeOptionsForManipulationDto")] public partial class RdsS3WormResourceTypeOptionsForManipulationDto : IEquatable<RdsS3WormResourceTypeOptionsForManipulationDto>, IValidatableObject diff --git a/src/Coscine.ApiClient.Core/Model/ResourceAdminDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceAdminDto.cs index a312ecd611e0bd44b65c6c83191afc905567b649..bb0b46809e9768b44478a0ff2a8c159e18009b7e 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceAdminDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceAdminDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceAdminDto + /// Represents a Data Transfer Object (DTO) for administrative purposes with additional resource details. /// </summary> [DataContract(Name = "ResourceAdminDto")] public partial class ResourceAdminDto : IEquatable<ResourceAdminDto>, IValidatableObject @@ -35,25 +35,26 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceAdminDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="pid">pid.</param> + /// <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.</param> - /// <param name="displayName">displayName.</param> - /// <param name="description">description.</param> - /// <param name="keywords">keywords.</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="keywords">Keywords associated with the resource..</param> /// <param name="license">license.</param> - /// <param name="usageRights">usageRights.</param> + /// <param name="usageRights">Usage rights associated with the resource..</param> /// <param name="applicationProfile">applicationProfile.</param> - /// <param name="fixedValues">fixedValues.</param> - /// <param name="disciplines">disciplines.</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="dateCreated">dateCreated.</param> + /// <param name="dateCreated">Date when the resource was created..</param> /// <param name="creator">creator.</param> - /// <param name="archived">archived.</param> - /// <param name="deleted">deleted.</param> - /// <param name="projectResources">projectResources.</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), 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?), Guid? creator = default(Guid?), bool archived = default(bool), bool deleted = default(bool), List<ProjectResourceMinimalDto> projectResources = default(List<ProjectResourceMinimalDto>)) + /// <param name="archived">Indicates whether the resource is archived..</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="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), 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), bool deleted = default(bool), List<ProjectResourceMinimalDto> projectResources = default(List<ProjectResourceMinimalDto>), ResourceQuotaDto resourceQuota = default(ResourceQuotaDto)) { this.Id = id; this.Pid = pid; @@ -73,17 +74,20 @@ namespace Coscine.ApiClient.Core.Model this.Archived = archived; this.Deleted = deleted; this.ProjectResources = projectResources; + this.ResourceQuota = resourceQuota; } /// <summary> - /// Gets or Sets Id + /// Unique identifier for the resource. /// </summary> + /// <value>Unique identifier for the resource.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets Pid + /// Persistent identifier for the resource. /// </summary> + /// <value>Persistent identifier for the resource.</value> [DataMember(Name = "pid", EmitDefaultValue = false)] public string Pid { get; set; } @@ -94,26 +98,30 @@ namespace Coscine.ApiClient.Core.Model public ResourceTypeDto Type { get; set; } /// <summary> - /// Gets or Sets Name + /// Name of the resource. /// </summary> + /// <value>Name of the resource.</value> [DataMember(Name = "name", EmitDefaultValue = false)] public string Name { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// Display name of the resource. /// </summary> + /// <value>Display name of the resource.</value> [DataMember(Name = "displayName", EmitDefaultValue = false)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Description + /// Description of the resource. /// </summary> + /// <value>Description of the resource.</value> [DataMember(Name = "description", EmitDefaultValue = false)] public string Description { get; set; } /// <summary> - /// Gets or Sets Keywords + /// Keywords associated with the resource. /// </summary> + /// <value>Keywords associated with the resource.</value> [DataMember(Name = "keywords", EmitDefaultValue = true)] public List<string> Keywords { get; set; } @@ -124,8 +132,9 @@ namespace Coscine.ApiClient.Core.Model public LicenseDto License { get; set; } /// <summary> - /// Gets or Sets UsageRights + /// Usage rights associated with the resource. /// </summary> + /// <value>Usage rights associated with the resource.</value> [DataMember(Name = "usageRights", EmitDefaultValue = true)] public string UsageRights { get; set; } @@ -136,14 +145,16 @@ namespace Coscine.ApiClient.Core.Model public ApplicationProfileMinimalDto ApplicationProfile { get; set; } /// <summary> - /// Gets or Sets 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. /// </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)] public Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>> FixedValues { get; set; } /// <summary> - /// Gets or Sets Disciplines + /// Disciplines associated with the resource. /// </summary> + /// <value>Disciplines associated with the resource.</value> [DataMember(Name = "disciplines", EmitDefaultValue = false)] public List<DisciplineDto> Disciplines { get; set; } @@ -154,35 +165,45 @@ namespace Coscine.ApiClient.Core.Model public VisibilityDto Visibility { get; set; } /// <summary> - /// Gets or Sets DateCreated + /// Date when the resource was created. /// </summary> + /// <value>Date when the resource was created.</value> [DataMember(Name = "dateCreated", EmitDefaultValue = true)] public DateTime? DateCreated { get; set; } /// <summary> /// Gets or Sets Creator /// </summary> - [DataMember(Name = "creator", EmitDefaultValue = true)] - public Guid? Creator { get; set; } + [DataMember(Name = "creator", EmitDefaultValue = false)] + public UserMinimalDto Creator { get; set; } /// <summary> - /// Gets or Sets Archived + /// Indicates whether the resource is archived. /// </summary> + /// <value>Indicates whether the resource is archived.</value> [DataMember(Name = "archived", EmitDefaultValue = true)] public bool Archived { get; set; } /// <summary> - /// Gets or Sets Deleted + /// Indicates whether the resource is deleted. /// </summary> + /// <value>Indicates whether the resource is deleted.</value> [DataMember(Name = "deleted", EmitDefaultValue = true)] public bool Deleted { get; set; } /// <summary> - /// Gets or Sets ProjectResources + /// 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)] public List<ProjectResourceMinimalDto> ProjectResources { get; set; } + /// <summary> + /// Gets or Sets ResourceQuota + /// </summary> + [DataMember(Name = "resourceQuota", EmitDefaultValue = false)] + public ResourceQuotaDto ResourceQuota { get; set; } + /// <summary> /// Returns the string presentation of the object /// </summary> @@ -209,6 +230,7 @@ namespace Coscine.ApiClient.Core.Model sb.Append(" Archived: ").Append(Archived).Append("\n"); sb.Append(" Deleted: ").Append(Deleted).Append("\n"); sb.Append(" ProjectResources: ").Append(ProjectResources).Append("\n"); + sb.Append(" ResourceQuota: ").Append(ResourceQuota).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -335,6 +357,11 @@ namespace Coscine.ApiClient.Core.Model this.ProjectResources != null && input.ProjectResources != null && this.ProjectResources.SequenceEqual(input.ProjectResources) + ) && + ( + this.ResourceQuota == input.ResourceQuota || + (this.ResourceQuota != null && + this.ResourceQuota.Equals(input.ResourceQuota)) ); } @@ -413,6 +440,10 @@ namespace Coscine.ApiClient.Core.Model { hashCode = (hashCode * 59) + this.ProjectResources.GetHashCode(); } + if (this.ResourceQuota != null) + { + hashCode = (hashCode * 59) + this.ResourceQuota.GetHashCode(); + } return hashCode; } } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceContentPageColumnsDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceContentPageColumnsDto.cs index ec7c21e239305e8fc3286636d232d95f769a48f7..55cd3980a9b2337ff225b204519cec2cfed0fb94 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceContentPageColumnsDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceContentPageColumnsDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceContentPageColumnsDto + /// Represents a set of columns to be displayed in the content view. /// </summary> [DataContract(Name = "ResourceContentPageColumnsDto")] public partial class ResourceContentPageColumnsDto : IEquatable<ResourceContentPageColumnsDto>, IValidatableObject @@ -35,15 +35,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceContentPageColumnsDto" /> class. /// </summary> - /// <param name="always">always.</param> + /// <param name="always">Set of columns that should always be displayed in the content view..</param> public ResourceContentPageColumnsDto(List<string> always = default(List<string>)) { this.Always = always; } /// <summary> - /// Gets or Sets Always + /// Set of columns that should always be displayed in the content view. /// </summary> + /// <value>Set of columns that should always be displayed in the content view.</value> [DataMember(Name = "always", EmitDefaultValue = false)] public List<string> Always { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceContentPageDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceContentPageDto.cs index 0357e7505f0cf14793a40fcedab41aa2f8284a95..bbc1bcd016a7952010ad80f6c8b422c48305b00e 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceContentPageDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceContentPageDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceContentPageDto + /// Represents the content page details for a resource. /// </summary> [DataContract(Name = "ResourceContentPageDto")] public partial class ResourceContentPageDto : IEquatable<ResourceContentPageDto>, IValidatableObject @@ -35,7 +35,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceContentPageDto" /> class. /// </summary> - /// <param name="varReadOnly">varReadOnly.</param> + /// <param name="varReadOnly">Indicates whether the resource is read-only..</param> /// <param name="metadataView">metadataView.</param> /// <param name="entriesView">entriesView.</param> public ResourceContentPageDto(bool varReadOnly = default(bool), ResourceContentPageMetadataViewDto metadataView = default(ResourceContentPageMetadataViewDto), ResourceContentPageEntriesViewDto entriesView = default(ResourceContentPageEntriesViewDto)) @@ -46,8 +46,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets VarReadOnly + /// Indicates whether the resource is read-only. /// </summary> + /// <value>Indicates whether the resource is read-only.</value> [DataMember(Name = "readOnly", EmitDefaultValue = true)] public bool VarReadOnly { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceContentPageEntriesViewDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceContentPageEntriesViewDto.cs index ce58c02f60072c1cd1088399eea02c1f58f76729..fc32ad79e1ff50cf249bcf6ceea5a2151313c1f0 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceContentPageEntriesViewDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceContentPageEntriesViewDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceContentPageEntriesViewDto + /// Represents information about the resource type for the columns within the entries view Vue component. /// </summary> [DataContract(Name = "ResourceContentPageEntriesViewDto")] public partial class ResourceContentPageEntriesViewDto : IEquatable<ResourceContentPageEntriesViewDto>, IValidatableObject diff --git a/src/Coscine.ApiClient.Core/Model/ResourceContentPageMetadataViewDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceContentPageMetadataViewDto.cs index f6a3a9ef056cc5595bcd0fe090df4f07a08bca17..c3ef4b75b88615bf7518e9a0b6cbc440e67eadd5 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceContentPageMetadataViewDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceContentPageMetadataViewDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceContentPageMetadataViewDto + /// Represents the metadata view for a resource's content page. /// </summary> [DataContract(Name = "ResourceContentPageMetadataViewDto")] public partial class ResourceContentPageMetadataViewDto : IEquatable<ResourceContentPageMetadataViewDto>, IValidatableObject @@ -35,8 +35,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceContentPageMetadataViewDto" /> class. /// </summary> - /// <param name="editableDataUrl">editableDataUrl.</param> - /// <param name="editableKey">editableKey.</param> + /// <param name="editableDataUrl">Indicates if a data URL can be provided and is editable..</param> + /// <param name="editableKey">Indicates if a key can be provided and is editable..</param> public ResourceContentPageMetadataViewDto(bool editableDataUrl = default(bool), bool editableKey = default(bool)) { this.EditableDataUrl = editableDataUrl; @@ -44,14 +44,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets EditableDataUrl + /// Indicates if a data URL can be provided and is editable. /// </summary> + /// <value>Indicates if a data URL can be provided and is editable.</value> [DataMember(Name = "editableDataUrl", EmitDefaultValue = true)] public bool EditableDataUrl { get; set; } /// <summary> - /// Gets or Sets EditableKey + /// Indicates if a key can be provided and is editable. /// </summary> + /// <value>Indicates if a key can be provided and is editable.</value> [DataMember(Name = "editableKey", EmitDefaultValue = true)] public bool EditableKey { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceCreationPageDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceCreationPageDto.cs index d3e1270c19d3ae5d6205c00a2fd8a1820f733c0b..054e25cc371268a42c64caed5885b1e35433c52a 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceCreationPageDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceCreationPageDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceCreationPageDto + /// Represents the structure of resource type-specific components for steps in the resource creation page. /// </summary> [DataContract(Name = "ResourceCreationPageDto")] public partial class ResourceCreationPageDto : IEquatable<ResourceCreationPageDto>, IValidatableObject @@ -35,15 +35,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceCreationPageDto" /> class. /// </summary> - /// <param name="components">components.</param> + /// <param name="components">List of Lists containing all the resource type specific components for the steps in the resource creation page..</param> public ResourceCreationPageDto(List<List<string>> components = default(List<List<string>>)) { this.Components = components; } /// <summary> - /// Gets or Sets Components + /// List of Lists containing all the resource type specific components for the steps in the resource creation page. /// </summary> + /// <value>List of Lists containing all the resource type specific components for the steps in the resource creation page.</value> [DataMember(Name = "components", EmitDefaultValue = false)] public List<List<string>> Components { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceDto.cs index 2a79fbd86b2b4edfae84a77dc380382fea0f69bb..95a649b98667515ed98c687395201e8a99f83f2b 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceDto + /// Represents a Data Transfer Object (DTO) for resource details. /// </summary> [DataContract(Name = "ResourceDto")] public partial class ResourceDto : IEquatable<ResourceDto>, IValidatableObject @@ -35,23 +35,23 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="pid">pid.</param> + /// <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.</param> - /// <param name="displayName">displayName.</param> - /// <param name="description">description.</param> - /// <param name="keywords">keywords.</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="keywords">Keywords associated with the resource..</param> /// <param name="license">license.</param> - /// <param name="usageRights">usageRights.</param> + /// <param name="usageRights">Usage rights associated with the resource..</param> /// <param name="applicationProfile">applicationProfile.</param> - /// <param name="fixedValues">fixedValues.</param> - /// <param name="disciplines">disciplines.</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="dateCreated">dateCreated.</param> + /// <param name="dateCreated">Date when the resource was created..</param> /// <param name="creator">creator.</param> - /// <param name="archived">archived.</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), 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?), Guid? creator = default(Guid?), bool archived = default(bool)) + /// <param name="archived">Indicates whether the resource is archived..</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), 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)) { this.Id = id; this.Pid = pid; @@ -72,14 +72,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// Unique identifier for the resource. /// </summary> + /// <value>Unique identifier for the resource.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets Pid + /// Persistent identifier for the resource. /// </summary> + /// <value>Persistent identifier for the resource.</value> [DataMember(Name = "pid", EmitDefaultValue = false)] public string Pid { get; set; } @@ -90,26 +92,30 @@ namespace Coscine.ApiClient.Core.Model public ResourceTypeDto Type { get; set; } /// <summary> - /// Gets or Sets Name + /// Name of the resource. /// </summary> + /// <value>Name of the resource.</value> [DataMember(Name = "name", EmitDefaultValue = false)] public string Name { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// Display name of the resource. /// </summary> + /// <value>Display name of the resource.</value> [DataMember(Name = "displayName", EmitDefaultValue = false)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Description + /// Description of the resource. /// </summary> + /// <value>Description of the resource.</value> [DataMember(Name = "description", EmitDefaultValue = false)] public string Description { get; set; } /// <summary> - /// Gets or Sets Keywords + /// Keywords associated with the resource. /// </summary> + /// <value>Keywords associated with the resource.</value> [DataMember(Name = "keywords", EmitDefaultValue = true)] public List<string> Keywords { get; set; } @@ -120,8 +126,9 @@ namespace Coscine.ApiClient.Core.Model public LicenseDto License { get; set; } /// <summary> - /// Gets or Sets UsageRights + /// Usage rights associated with the resource. /// </summary> + /// <value>Usage rights associated with the resource.</value> [DataMember(Name = "usageRights", EmitDefaultValue = true)] public string UsageRights { get; set; } @@ -132,14 +139,16 @@ namespace Coscine.ApiClient.Core.Model public ApplicationProfileMinimalDto ApplicationProfile { get; set; } /// <summary> - /// Gets or Sets 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. /// </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)] public Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>> FixedValues { get; set; } /// <summary> - /// Gets or Sets Disciplines + /// Disciplines associated with the resource. /// </summary> + /// <value>Disciplines associated with the resource.</value> [DataMember(Name = "disciplines", EmitDefaultValue = false)] public List<DisciplineDto> Disciplines { get; set; } @@ -150,20 +159,22 @@ namespace Coscine.ApiClient.Core.Model public VisibilityDto Visibility { get; set; } /// <summary> - /// Gets or Sets DateCreated + /// Date when the resource was created. /// </summary> + /// <value>Date when the resource was created.</value> [DataMember(Name = "dateCreated", EmitDefaultValue = true)] public DateTime? DateCreated { get; set; } /// <summary> /// Gets or Sets Creator /// </summary> - [DataMember(Name = "creator", EmitDefaultValue = true)] - public Guid? Creator { get; set; } + [DataMember(Name = "creator", EmitDefaultValue = false)] + public UserMinimalDto Creator { get; set; } /// <summary> - /// Gets or Sets Archived + /// Indicates whether the resource is archived. /// </summary> + /// <value>Indicates whether the resource is archived.</value> [DataMember(Name = "archived", EmitDefaultValue = true)] public bool Archived { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceForCreationDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceForCreationDto.cs index a97809d5f35597005aeee5e254bd3bc02e1d0e09..6c8ac187ac4a99fb48dfbb34d7f71789ec8fcd1d 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceForCreationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceForCreationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceForCreationDto + /// Represents the data transfer object (DTO) used for creating a resource. Inherits properties from Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ResourceForManipulationDto. /// </summary> [DataContract(Name = "ResourceForCreationDto")] public partial class ResourceForCreationDto : IEquatable<ResourceForCreationDto>, IValidatableObject @@ -40,16 +40,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceForCreationDto" /> class. /// </summary> - /// <param name="name">name (required).</param> - /// <param name="displayName">displayName.</param> - /// <param name="description">description (required).</param> - /// <param name="keywords">keywords.</param> - /// <param name="fixedValues">fixedValues.</param> + /// <param name="name">The name of the resource. (required).</param> + /// <param name="displayName">The display name of the resource..</param> + /// <param name="description">The description of the resource. (required).</param> + /// <param name="keywords">The keywords associated with the resource..</param> + /// <param name="fixedValues">Fixed values associated with the resource..</param> /// <param name="license">license.</param> - /// <param name="usageNote">usageNote.</param> + /// <param name="usageNote">Notes about the usage of the resource..</param> /// <param name="visibility">visibility (required).</param> - /// <param name="disciplines">disciplines (required).</param> - /// <param name="resourceTypeId">resourceTypeId (required).</param> + /// <param name="disciplines">The disciplines associated with the resource. (required).</param> + /// <param name="resourceTypeId">The identifier of the resource type associated with the resource. (required).</param> /// <param name="applicationProfile">applicationProfile (required).</param> /// <param name="resourceTypeOptions">resourceTypeOptions (required).</param> public ResourceForCreationDto(string name = default(string), string displayName = default(string), string description = default(string), List<string> keywords = default(List<string>), Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>> fixedValues = default(Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>>), LicenseForResourceManipulationDto license = default(LicenseForResourceManipulationDto), string usageNote = default(string), VisibilityForResourceManipulationDto visibility = default(VisibilityForResourceManipulationDto), List<DisciplineForResourceManipulationDto> disciplines = default(List<DisciplineForResourceManipulationDto>), Guid resourceTypeId = default(Guid), ApplicationProfileForResourceCreationDto applicationProfile = default(ApplicationProfileForResourceCreationDto), ResourceTypeOptionsForCreationDto resourceTypeOptions = default(ResourceTypeOptionsForCreationDto)) @@ -99,32 +99,37 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Name + /// The name of the resource. /// </summary> + /// <value>The name of the resource.</value> [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// The display name of the resource. /// </summary> + /// <value>The display name of the resource.</value> [DataMember(Name = "displayName", EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Description + /// The description of the resource. /// </summary> + /// <value>The description of the resource.</value> [DataMember(Name = "description", IsRequired = true, EmitDefaultValue = true)] public string Description { get; set; } /// <summary> - /// Gets or Sets Keywords + /// The keywords associated with the resource. /// </summary> + /// <value>The keywords associated with the resource.</value> [DataMember(Name = "keywords", EmitDefaultValue = true)] public List<string> Keywords { get; set; } /// <summary> - /// Gets or Sets FixedValues + /// Fixed values associated with the resource. /// </summary> + /// <value>Fixed values associated with the resource.</value> [DataMember(Name = "fixedValues", EmitDefaultValue = true)] public Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>> FixedValues { get; set; } @@ -135,8 +140,9 @@ namespace Coscine.ApiClient.Core.Model public LicenseForResourceManipulationDto License { get; set; } /// <summary> - /// Gets or Sets UsageNote + /// Notes about the usage of the resource. /// </summary> + /// <value>Notes about the usage of the resource.</value> [DataMember(Name = "usageNote", EmitDefaultValue = true)] public string UsageNote { get; set; } @@ -147,14 +153,16 @@ namespace Coscine.ApiClient.Core.Model public VisibilityForResourceManipulationDto Visibility { get; set; } /// <summary> - /// Gets or Sets Disciplines + /// The disciplines associated with the resource. /// </summary> + /// <value>The disciplines associated with the resource.</value> [DataMember(Name = "disciplines", IsRequired = true, EmitDefaultValue = true)] public List<DisciplineForResourceManipulationDto> Disciplines { get; set; } /// <summary> - /// Gets or Sets ResourceTypeId + /// The identifier of the resource type associated with the resource. /// </summary> + /// <value>The identifier of the resource type associated with the resource.</value> [DataMember(Name = "resourceTypeId", IsRequired = true, EmitDefaultValue = true)] public Guid ResourceTypeId { get; set; } @@ -377,9 +385,9 @@ namespace Coscine.ApiClient.Core.Model } // Description (string) maxLength - if (this.Description != null && this.Description.Length > 1000) + if (this.Description != null && this.Description.Length > 10000) { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Description, length must be less than 1000.", new [] { "Description" }); + yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Description, length must be less than 10000.", new [] { "Description" }); } // Description (string) minLength diff --git a/src/Coscine.ApiClient.Core/Model/ResourceForUpdateDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceForUpdateDto.cs index f49103acadb85d53619aa1d80161452362104fec..f5d51d385e39337f11e31e3101c96ba23f9e091f 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceForUpdateDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceForUpdateDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceForUpdateDto + /// Represents the data transfer object (DTO) used for updating a resource. Inherits properties from Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ResourceForManipulationDto. /// </summary> [DataContract(Name = "ResourceForUpdateDto")] public partial class ResourceForUpdateDto : IEquatable<ResourceForUpdateDto>, IValidatableObject @@ -40,16 +40,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceForUpdateDto" /> class. /// </summary> - /// <param name="name">name (required).</param> - /// <param name="displayName">displayName.</param> - /// <param name="description">description (required).</param> - /// <param name="keywords">keywords.</param> - /// <param name="fixedValues">fixedValues.</param> + /// <param name="name">The name of the resource. (required).</param> + /// <param name="displayName">The display name of the resource..</param> + /// <param name="description">The description of the resource. (required).</param> + /// <param name="keywords">The keywords associated with the resource..</param> + /// <param name="fixedValues">Fixed values associated with the resource..</param> /// <param name="license">license.</param> - /// <param name="usageNote">usageNote.</param> + /// <param name="usageNote">Notes about the usage of the resource..</param> /// <param name="visibility">visibility (required).</param> - /// <param name="disciplines">disciplines (required).</param> - /// <param name="archived">archived (required).</param> + /// <param name="disciplines">The disciplines associated with the resource. (required).</param> + /// <param name="archived">Indicates whether the resource is archived. (required).</param> /// <param name="resourceTypeOptions">resourceTypeOptions.</param> public ResourceForUpdateDto(string name = default(string), string displayName = default(string), string description = default(string), List<string> keywords = default(List<string>), Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>> fixedValues = default(Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>>), LicenseForResourceManipulationDto license = default(LicenseForResourceManipulationDto), string usageNote = default(string), VisibilityForResourceManipulationDto visibility = default(VisibilityForResourceManipulationDto), List<DisciplineForResourceManipulationDto> disciplines = default(List<DisciplineForResourceManipulationDto>), bool archived = default(bool), ResourceTypeOptionsForUpdateDto resourceTypeOptions = default(ResourceTypeOptionsForUpdateDto)) { @@ -87,32 +87,37 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Name + /// The name of the resource. /// </summary> + /// <value>The name of the resource.</value> [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// The display name of the resource. /// </summary> + /// <value>The display name of the resource.</value> [DataMember(Name = "displayName", EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Description + /// The description of the resource. /// </summary> + /// <value>The description of the resource.</value> [DataMember(Name = "description", IsRequired = true, EmitDefaultValue = true)] public string Description { get; set; } /// <summary> - /// Gets or Sets Keywords + /// The keywords associated with the resource. /// </summary> + /// <value>The keywords associated with the resource.</value> [DataMember(Name = "keywords", EmitDefaultValue = true)] public List<string> Keywords { get; set; } /// <summary> - /// Gets or Sets FixedValues + /// Fixed values associated with the resource. /// </summary> + /// <value>Fixed values associated with the resource.</value> [DataMember(Name = "fixedValues", EmitDefaultValue = true)] public Dictionary<string, Dictionary<string, List<FixedValueForResourceManipulationDto>>> FixedValues { get; set; } @@ -123,8 +128,9 @@ namespace Coscine.ApiClient.Core.Model public LicenseForResourceManipulationDto License { get; set; } /// <summary> - /// Gets or Sets UsageNote + /// Notes about the usage of the resource. /// </summary> + /// <value>Notes about the usage of the resource.</value> [DataMember(Name = "usageNote", EmitDefaultValue = true)] public string UsageNote { get; set; } @@ -135,14 +141,16 @@ namespace Coscine.ApiClient.Core.Model public VisibilityForResourceManipulationDto Visibility { get; set; } /// <summary> - /// Gets or Sets Disciplines + /// The disciplines associated with the resource. /// </summary> + /// <value>The disciplines associated with the resource.</value> [DataMember(Name = "disciplines", IsRequired = true, EmitDefaultValue = true)] public List<DisciplineForResourceManipulationDto> Disciplines { get; set; } /// <summary> - /// Gets or Sets Archived + /// Indicates whether the resource is archived. /// </summary> + /// <value>Indicates whether the resource is archived.</value> [DataMember(Name = "archived", IsRequired = true, EmitDefaultValue = true)] public bool Archived { get; set; } @@ -345,9 +353,9 @@ namespace Coscine.ApiClient.Core.Model } // Description (string) maxLength - if (this.Description != null && this.Description.Length > 1000) + if (this.Description != null && this.Description.Length > 10000) { - yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Description, length must be less than 1000.", new [] { "Description" }); + yield return new System.ComponentModel.DataAnnotations.ValidationResult("Invalid value for Description, length must be less than 10000.", new [] { "Description" }); } // Description (string) minLength diff --git a/src/Coscine.ApiClient.Core/Model/ResourceMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceMinimalDto.cs index 03996208d4f5995f551b7899d12569647bfcc99e..caa18b069e027fcf117ed2f358eb12c13e1b23dd 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceMinimalDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceMinimalDto + /// Represents a minimal Data Transfer Object (DTO) for a resource, containing essential identifiers. /// </summary> [DataContract(Name = "ResourceMinimalDto")] public partial class ResourceMinimalDto : IEquatable<ResourceMinimalDto>, IValidatableObject @@ -35,15 +35,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceMinimalDto" /> class. /// </summary> - /// <param name="id">id.</param> + /// <param name="id">Unique identifier for the resource..</param> public ResourceMinimalDto(Guid id = default(Guid)) { this.Id = id; } /// <summary> - /// Gets or Sets Id + /// Unique identifier for the resource. /// </summary> + /// <value>Unique identifier for the resource.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceQuotaDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceQuotaDto.cs index d584b52ecf05ba2021030312ae05780193e04b06..d4e45ba3ed5d255734ed700d050f8f3db77729c5 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceQuotaDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceQuotaDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceQuotaDto + /// Represents a Data Transfer Object (DTO) containing quota information for a resource. /// </summary> [DataContract(Name = "ResourceQuotaDto")] public partial class ResourceQuotaDto : IEquatable<ResourceQuotaDto>, IValidatableObject @@ -36,7 +36,7 @@ namespace Coscine.ApiClient.Core.Model /// Initializes a new instance of the <see cref="ResourceQuotaDto" /> class. /// </summary> /// <param name="resource">resource.</param> - /// <param name="usedPercentage">usedPercentage.</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)) @@ -54,8 +54,9 @@ namespace Coscine.ApiClient.Core.Model public ResourceMinimalDto Resource { get; set; } /// <summary> - /// Gets or Sets UsedPercentage + /// The percentage of quota used by the resource. /// </summary> + /// <value>The percentage of quota used by the resource.</value> [DataMember(Name = "usedPercentage", EmitDefaultValue = true)] public float? UsedPercentage { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceTypeDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceTypeDto.cs index f50a2d5648db537ead6d353c4ac02fc09bd02c32..348fff6cfaf9762905dc9dc305b23eda107e517a 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceTypeDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceTypeDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceTypeDto + /// Represents a resource type. /// </summary> [DataContract(Name = "ResourceTypeDto")] public partial class ResourceTypeDto : IEquatable<ResourceTypeDto>, IValidatableObject @@ -35,9 +35,9 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceTypeDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="generalType">generalType.</param> - /// <param name="specificType">specificType.</param> + /// <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="options">options.</param> public ResourceTypeDto(Guid id = default(Guid), string generalType = default(string), string specificType = default(string), ResourceTypeOptionsDto options = default(ResourceTypeOptionsDto)) { @@ -48,20 +48,23 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// The unique identifier of the resource type. /// </summary> + /// <value>The unique identifier of the resource type.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets GeneralType + /// The general type of the resource. /// </summary> + /// <value>The general type of the resource.</value> [DataMember(Name = "generalType", EmitDefaultValue = false)] public string GeneralType { get; set; } /// <summary> - /// Gets or Sets SpecificType + /// The specific type of the resource. /// </summary> + /// <value>The specific type of the resource.</value> [DataMember(Name = "specificType", EmitDefaultValue = false)] public string SpecificType { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceTypeInformationDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceTypeInformationDto.cs index 127918dccde8142852dd7cb16bd7c10a7988c599..877b1838967ec772febd2fc1c5d00fcf082610ad 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceTypeInformationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceTypeInformationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceTypeInformationDto + /// Represents information about a resource type. /// </summary> [DataContract(Name = "ResourceTypeInformationDto")] public partial class ResourceTypeInformationDto : IEquatable<ResourceTypeInformationDto>, IValidatableObject @@ -41,22 +41,22 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceTypeInformationDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="generalType">generalType.</param> - /// <param name="specificType">specificType.</param> + /// <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="status">status.</param> - /// <param name="canCreate">canCreate.</param> - /// <param name="canRead">canRead.</param> - /// <param name="canSetResourceReadonly">canSetResourceReadonly.</param> - /// <param name="canUpdate">canUpdate.</param> - /// <param name="canUpdateResource">canUpdateResource.</param> - /// <param name="canDelete">canDelete.</param> - /// <param name="canDeleteResource">canDeleteResource.</param> - /// <param name="canList">canList.</param> - /// <param name="canCreateLinks">canCreateLinks.</param> - /// <param name="isArchived">isArchived.</param> - /// <param name="isQuotaAvailable">isQuotaAvailable.</param> - /// <param name="isQuotaAdjustable">isQuotaAdjustable.</param> + /// <param name="canCreate">Indicates if the resource type supports creation..</param> + /// <param name="canRead">Indicates if the resource type supports reading..</param> + /// <param name="canSetResourceReadonly">Indicates if the resource type supports read-only..</param> + /// <param name="canUpdate">Indicates if the resource type supports updating..</param> + /// <param name="canUpdateResource">Indicates if the resource type supports updating (not an Object)..</param> + /// <param name="canDelete">Indicates if the resource type supports deletion..</param> + /// <param name="canDeleteResource">Indicates if the resource type supports deletion (not an Object)..</param> + /// <param name="canList">Indicates if the resource type supports listing..</param> + /// <param name="canCreateLinks">Indicates if the resource type supports linking..</param> + /// <param name="isArchived">Indicates if the resource type is archived..</param> + /// <param name="isQuotaAvailable">Indicates if the resource type supports quota..</param> + /// <param name="isQuotaAdjustable">Indicates if the resource type quota can be changed..</param> /// <param name="resourceCreation">resourceCreation.</param> /// <param name="resourceContent">resourceContent.</param> public ResourceTypeInformationDto(Guid id = default(Guid), string generalType = default(string), string specificType = default(string), ResourceTypeStatus? status = default(ResourceTypeStatus?), bool canCreate = default(bool), bool canRead = default(bool), bool canSetResourceReadonly = default(bool), bool canUpdate = default(bool), bool canUpdateResource = default(bool), bool canDelete = default(bool), bool canDeleteResource = default(bool), bool canList = default(bool), bool canCreateLinks = default(bool), bool isArchived = default(bool), bool isQuotaAvailable = default(bool), bool isQuotaAdjustable = default(bool), ResourceCreationPageDto resourceCreation = default(ResourceCreationPageDto), ResourceContentPageDto resourceContent = default(ResourceContentPageDto)) @@ -82,98 +82,114 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// The unique identifier of the resource type. /// </summary> + /// <value>The unique identifier of the resource type.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets GeneralType + /// The general type of the resource. /// </summary> + /// <value>The general type of the resource.</value> [DataMember(Name = "generalType", EmitDefaultValue = true)] public string GeneralType { get; set; } /// <summary> - /// Gets or Sets SpecificType + /// The specific type of the resource. /// </summary> + /// <value>The specific type of the resource.</value> [DataMember(Name = "specificType", EmitDefaultValue = true)] public string SpecificType { get; set; } /// <summary> - /// Gets or Sets CanCreate + /// Indicates if the resource type supports creation. /// </summary> + /// <value>Indicates if the resource type supports creation.</value> [DataMember(Name = "canCreate", EmitDefaultValue = true)] public bool CanCreate { get; set; } /// <summary> - /// Gets or Sets CanRead + /// Indicates if the resource type supports reading. /// </summary> + /// <value>Indicates if the resource type supports reading.</value> [DataMember(Name = "canRead", EmitDefaultValue = true)] public bool CanRead { get; set; } /// <summary> - /// Gets or Sets CanSetResourceReadonly + /// Indicates if the resource type supports read-only. /// </summary> + /// <value>Indicates if the resource type supports read-only.</value> [DataMember(Name = "canSetResourceReadonly", EmitDefaultValue = true)] public bool CanSetResourceReadonly { get; set; } /// <summary> - /// Gets or Sets CanUpdate + /// Indicates if the resource type supports updating. /// </summary> + /// <value>Indicates if the resource type supports updating.</value> [DataMember(Name = "canUpdate", EmitDefaultValue = true)] public bool CanUpdate { get; set; } /// <summary> - /// Gets or Sets CanUpdateResource + /// Indicates if the resource type supports updating (not an Object). /// </summary> + /// <value>Indicates if the resource type supports updating (not an Object).</value> [DataMember(Name = "canUpdateResource", EmitDefaultValue = true)] public bool CanUpdateResource { get; set; } /// <summary> - /// Gets or Sets CanDelete + /// Indicates if the resource type supports deletion. /// </summary> + /// <value>Indicates if the resource type supports deletion.</value> [DataMember(Name = "canDelete", EmitDefaultValue = true)] public bool CanDelete { get; set; } /// <summary> - /// Gets or Sets CanDeleteResource + /// Indicates if the resource type supports deletion (not an Object). /// </summary> + /// <value>Indicates if the resource type supports deletion (not an Object).</value> [DataMember(Name = "canDeleteResource", EmitDefaultValue = true)] public bool CanDeleteResource { get; set; } /// <summary> - /// Gets or Sets CanList + /// Indicates if the resource type supports listing. /// </summary> + /// <value>Indicates if the resource type supports listing.</value> [DataMember(Name = "canList", EmitDefaultValue = true)] public bool CanList { get; set; } /// <summary> - /// Gets or Sets CanCreateLinks + /// Indicates if the resource type supports linking. /// </summary> + /// <value>Indicates if the resource type supports linking.</value> [DataMember(Name = "canCreateLinks", EmitDefaultValue = true)] public bool CanCreateLinks { get; set; } /// <summary> - /// Gets or Sets IsArchived + /// Indicates if the resource type is archived. /// </summary> + /// <value>Indicates if the resource type is archived.</value> [DataMember(Name = "isArchived", EmitDefaultValue = true)] public bool IsArchived { get; set; } /// <summary> - /// Gets or Sets IsQuotaAvailable + /// Indicates if the resource type supports quota. /// </summary> + /// <value>Indicates if the resource type supports quota.</value> [DataMember(Name = "isQuotaAvailable", EmitDefaultValue = true)] public bool IsQuotaAvailable { get; set; } /// <summary> - /// Gets or Sets IsQuotaAdjustable + /// Indicates if the resource type quota can be changed. /// </summary> + /// <value>Indicates if the resource type quota can be changed.</value> [DataMember(Name = "isQuotaAdjustable", EmitDefaultValue = true)] public bool IsQuotaAdjustable { get; set; } /// <summary> - /// Gets or Sets IsEnabled + /// Indicates if the resource type is enabled. /// </summary> + /// <value>Indicates if the resource type is enabled.</value> [DataMember(Name = "isEnabled", EmitDefaultValue = true)] public bool IsEnabled { get; private set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceTypeMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceTypeMinimalDto.cs index 94971ce19ce5d5f22849f9dad0a57d3c2be98726..6e76d54198af7e342974c9d2438c62d7bbcaafdb 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceTypeMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceTypeMinimalDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceTypeMinimalDto + /// Represents a minimal Data Transfer Object (DTO) for a resource type. /// </summary> [DataContract(Name = "ResourceTypeMinimalDto")] public partial class ResourceTypeMinimalDto : IEquatable<ResourceTypeMinimalDto>, IValidatableObject @@ -35,8 +35,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceTypeMinimalDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="specificType">specificType.</param> + /// <param name="id">The unique identifier of the resource type..</param> + /// <param name="specificType">The specific type of the resource..</param> public ResourceTypeMinimalDto(Guid id = default(Guid), string specificType = default(string)) { this.Id = id; @@ -44,14 +44,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// The unique identifier of the resource type. /// </summary> + /// <value>The unique identifier of the resource type.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets SpecificType + /// The specific type of the resource. /// </summary> + /// <value>The specific type of the resource.</value> [DataMember(Name = "specificType", EmitDefaultValue = false)] public string SpecificType { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceTypeOptionsDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceTypeOptionsDto.cs index 3c8b38afce785bccb0c411b5435f99b87c527de3..5d58315bb1d4eadd7c23bc786c8479b1a9be48e1 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceTypeOptionsDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceTypeOptionsDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceTypeOptionsDto + /// Represents the options available for different resource types. /// </summary> [DataContract(Name = "ResourceTypeOptionsDto")] public partial class ResourceTypeOptionsDto : IEquatable<ResourceTypeOptionsDto>, IValidatableObject @@ -35,7 +35,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceTypeOptionsDto" /> class. /// </summary> - /// <param name="linkedData">linkedData.</param> + /// <param name="linkedData">Represents the data transfer object (DTO) for Linked Data options..</param> /// <param name="gitLab">gitLab.</param> /// <param name="rds">rds.</param> /// <param name="rdsS3">rdsS3.</param> @@ -50,8 +50,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets LinkedData + /// Represents the data transfer object (DTO) for Linked Data options. /// </summary> + /// <value>Represents the data transfer object (DTO) for Linked Data options.</value> [DataMember(Name = "linkedData", EmitDefaultValue = false)] public Object LinkedData { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceTypeOptionsForCreationDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceTypeOptionsForCreationDto.cs index 316f2aff68b42c2d20f02d1ba1dc3a8e9ef4a232..1a8258bac3eb8236a1acc4ccde818ddd171a9d1e 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceTypeOptionsForCreationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceTypeOptionsForCreationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceTypeOptionsForCreationDto + /// Represents the data transfer object (DTO) for creating options related to any resource type. /// </summary> [DataContract(Name = "ResourceTypeOptionsForCreationDto")] public partial class ResourceTypeOptionsForCreationDto : IEquatable<ResourceTypeOptionsForCreationDto>, IValidatableObject @@ -35,7 +35,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceTypeOptionsForCreationDto" /> class. /// </summary> - /// <param name="linkedResourceTypeOptions">linkedResourceTypeOptions.</param> + /// <param name="linkedResourceTypeOptions">Represents the data transfer object (DTO) for manipulating linked data resource type options..</param> /// <param name="gitlabResourceTypeOptions">gitlabResourceTypeOptions.</param> /// <param name="rdsResourceTypeOptions">rdsResourceTypeOptions.</param> /// <param name="rdsS3ResourceTypeOptions">rdsS3ResourceTypeOptions.</param> @@ -50,8 +50,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets LinkedResourceTypeOptions + /// Represents the data transfer object (DTO) for manipulating linked data resource type options. /// </summary> + /// <value>Represents the data transfer object (DTO) for manipulating linked data resource type options.</value> [DataMember(Name = "linkedResourceTypeOptions", EmitDefaultValue = false)] public Object LinkedResourceTypeOptions { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceTypeOptionsForUpdateDto.cs b/src/Coscine.ApiClient.Core/Model/ResourceTypeOptionsForUpdateDto.cs index a677cc207dd0284ca9ef43f0d32b3b7923289768..7452ef906629cef333dcb391b41452100e89c2f6 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceTypeOptionsForUpdateDto.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceTypeOptionsForUpdateDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// ResourceTypeOptionsForUpdateDto + /// Represents the data transfer object (DTO) used for updating options related to any resource type. /// </summary> [DataContract(Name = "ResourceTypeOptionsForUpdateDto")] public partial class ResourceTypeOptionsForUpdateDto : IEquatable<ResourceTypeOptionsForUpdateDto>, IValidatableObject @@ -35,7 +35,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="ResourceTypeOptionsForUpdateDto" /> class. /// </summary> - /// <param name="linkedResourceTypeOptions">linkedResourceTypeOptions.</param> + /// <param name="linkedResourceTypeOptions">Represents the data transfer object (DTO) for manipulating linked data resource type options..</param> /// <param name="gitlabResourceTypeOptions">gitlabResourceTypeOptions.</param> /// <param name="rdsResourceTypeOptions">rdsResourceTypeOptions.</param> /// <param name="rdsS3ResourceTypeOptions">rdsS3ResourceTypeOptions.</param> @@ -50,8 +50,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets LinkedResourceTypeOptions + /// Represents the data transfer object (DTO) for manipulating linked data resource type options. /// </summary> + /// <value>Represents the data transfer object (DTO) for manipulating linked data resource type options.</value> [DataMember(Name = "linkedResourceTypeOptions", EmitDefaultValue = false)] public Object LinkedResourceTypeOptions { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/ResourceTypeStatus.cs b/src/Coscine.ApiClient.Core/Model/ResourceTypeStatus.cs index 297260d6d5eb00723edf5a0df067ac9d2d5b95ba..3385fb36159a9320dc33c71a998f07de22ffc634 100644 --- a/src/Coscine.ApiClient.Core/Model/ResourceTypeStatus.cs +++ b/src/Coscine.ApiClient.Core/Model/ResourceTypeStatus.cs @@ -27,8 +27,9 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// Defines ResourceTypeStatus + /// Specifies the status of a resource type. /// </summary> + /// <value>Specifies the status of a resource type.</value> [JsonConverter(typeof(StringEnumConverter))] public enum ResourceTypeStatus { diff --git a/src/Coscine.ApiClient.Core/Model/RoleDto.cs b/src/Coscine.ApiClient.Core/Model/RoleDto.cs index 0ef62731cd4aee0b18514a56e7f819edbe317628..46ffc8cbf3260b1d6e9cd051b3e4ef160ff060a9 100644 --- a/src/Coscine.ApiClient.Core/Model/RoleDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RoleDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// RoleDto + /// Represents a Data Transfer Object (DTO) for a role. /// </summary> [DataContract(Name = "RoleDto")] public partial class RoleDto : IEquatable<RoleDto>, IValidatableObject @@ -35,9 +35,9 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RoleDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="displayName">displayName.</param> - /// <param name="description">description.</param> + /// <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> public RoleDto(Guid id = default(Guid), string displayName = default(string), string description = default(string)) { this.Id = id; @@ -46,20 +46,23 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// The unique identifier of the role. /// </summary> + /// <value>The unique identifier of the role.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// The display name of the role. /// </summary> + /// <value>The display name of the role.</value> [DataMember(Name = "displayName", EmitDefaultValue = false)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Description + /// The description of the role. /// </summary> + /// <value>The description of the role.</value> [DataMember(Name = "description", EmitDefaultValue = false)] public string Description { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/RoleMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/RoleMinimalDto.cs index c2addb5ff7eb284ab66c470295e5116dc228a6db..1e5ebaac0d5fd7d947377e146e16469413912448 100644 --- a/src/Coscine.ApiClient.Core/Model/RoleMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/RoleMinimalDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// RoleMinimalDto + /// Represents a Data Transfer Object (DTO) containing minimal information about a role. /// </summary> [DataContract(Name = "RoleMinimalDto")] public partial class RoleMinimalDto : IEquatable<RoleMinimalDto>, IValidatableObject @@ -35,15 +35,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="RoleMinimalDto" /> class. /// </summary> - /// <param name="id">id.</param> + /// <param name="id">The unique identifier of the role..</param> public RoleMinimalDto(Guid id = default(Guid)) { this.Id = id; } /// <summary> - /// Gets or Sets Id + /// The unique identifier of the role. /// </summary> + /// <value>The unique identifier of the role.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/SearchCategory.cs b/src/Coscine.ApiClient.Core/Model/SearchCategory.cs index 531b4b252b1c7d05f16b1dbbf9e31c997a3d5eab..ba1492ab36465c070a9a56090a60a24b762f2075 100644 --- a/src/Coscine.ApiClient.Core/Model/SearchCategory.cs +++ b/src/Coscine.ApiClient.Core/Model/SearchCategory.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// SearchCategory + /// Represents a search category with a name and count of occurrences. /// </summary> [DataContract(Name = "SearchCategory")] public partial class SearchCategory : IEquatable<SearchCategory>, IValidatableObject @@ -35,8 +35,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="SearchCategory" /> class. /// </summary> - /// <param name="name">name.</param> - /// <param name="count">count.</param> + /// <param name="name">The name of the search category..</param> + /// <param name="count">The count of occurrences for the search category..</param> public SearchCategory(string name = default(string), long count = default(long)) { this.Name = name; @@ -44,14 +44,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Name + /// The name of the search category. /// </summary> + /// <value>The name of the search category.</value> [DataMember(Name = "name", EmitDefaultValue = false)] public string Name { get; set; } /// <summary> - /// Gets or Sets Count + /// The count of occurrences for the search category. /// </summary> + /// <value>The count of occurrences for the search category.</value> [DataMember(Name = "count", EmitDefaultValue = false)] public long Count { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/SearchCategoryType.cs b/src/Coscine.ApiClient.Core/Model/SearchCategoryType.cs index ba31e086be17901e90a84248306943c39e20880e..1efc90988309d963fa693f4f27c712ec7f8d3c47 100644 --- a/src/Coscine.ApiClient.Core/Model/SearchCategoryType.cs +++ b/src/Coscine.ApiClient.Core/Model/SearchCategoryType.cs @@ -27,8 +27,9 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// Defines SearchCategoryType + /// Specifies the search item type. /// </summary> + /// <value>Specifies the search item type.</value> [JsonConverter(typeof(StringEnumConverter))] public enum SearchCategoryType { diff --git a/src/Coscine.ApiClient.Core/Model/SearchResultDto.cs b/src/Coscine.ApiClient.Core/Model/SearchResultDto.cs index 1f9287aa766844488041a4116e3f7f31239d2d2c..7abbc972828809db47471d3b077fcea4928aa792 100644 --- a/src/Coscine.ApiClient.Core/Model/SearchResultDto.cs +++ b/src/Coscine.ApiClient.Core/Model/SearchResultDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// SearchResultDto + /// Represents a Data Transfer Object (DTO) for search results. /// </summary> [DataContract(Name = "SearchResultDto")] public partial class SearchResultDto : IEquatable<SearchResultDto>, IValidatableObject @@ -41,9 +41,9 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="SearchResultDto" /> class. /// </summary> - /// <param name="uri">uri.</param> + /// <param name="uri">The URI associated with the search result..</param> /// <param name="type">type.</param> - /// <param name="source">source.</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)) { this.Uri = uri; @@ -52,14 +52,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Uri + /// The URI associated with the search result. /// </summary> + /// <value>The URI associated with the search result.</value> [DataMember(Name = "uri", EmitDefaultValue = false)] public string Uri { get; set; } /// <summary> - /// Gets or Sets Source + /// The dynamic source data for the search result. /// </summary> + /// <value>The dynamic source data for the search result.</value> [DataMember(Name = "source", EmitDefaultValue = true)] public Object Source { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/TermsOfServiceDto.cs b/src/Coscine.ApiClient.Core/Model/TermsOfServiceDto.cs index c70eefbf6e87eabd5485b31a7dd211ac7732a257..f5df73b9db91949657d078c74d7f48ea130e9de8 100644 --- a/src/Coscine.ApiClient.Core/Model/TermsOfServiceDto.cs +++ b/src/Coscine.ApiClient.Core/Model/TermsOfServiceDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// TermsOfServiceDto + /// Represents the Data Transfer Object (DTO) for terms of service information. /// </summary> [DataContract(Name = "TermsOfServiceDto")] public partial class TermsOfServiceDto : IEquatable<TermsOfServiceDto>, IValidatableObject @@ -35,8 +35,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="TermsOfServiceDto" /> class. /// </summary> - /// <param name="varVersion">varVersion.</param> - /// <param name="isCurrent">isCurrent.</param> + /// <param name="varVersion">The version of the terms of service..</param> + /// <param name="isCurrent">Indicates whether these terms of service are current or not..</param> public TermsOfServiceDto(string varVersion = default(string), bool isCurrent = default(bool)) { this.VarVersion = varVersion; @@ -44,14 +44,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets VarVersion + /// The version of the terms of service. /// </summary> + /// <value>The version of the terms of service.</value> [DataMember(Name = "version", EmitDefaultValue = false)] public string VarVersion { get; set; } /// <summary> - /// Gets or Sets IsCurrent + /// 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)] public bool IsCurrent { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/TitleDto.cs b/src/Coscine.ApiClient.Core/Model/TitleDto.cs index 2d39083c25c07daf6a8ef0aa10dbce14e21e8dee..03303f676322d3da06d645b3e0e6554df083a0d5 100644 --- a/src/Coscine.ApiClient.Core/Model/TitleDto.cs +++ b/src/Coscine.ApiClient.Core/Model/TitleDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// TitleDto + /// Represents the Data Transfer Object (DTO) for title information. /// </summary> [DataContract(Name = "TitleDto")] public partial class TitleDto : IEquatable<TitleDto>, IValidatableObject @@ -35,8 +35,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="TitleDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="displayName">displayName.</param> + /// <param name="id">The identifier for the title..</param> + /// <param name="displayName">The displayed name of the title..</param> public TitleDto(Guid id = default(Guid), string displayName = default(string)) { this.Id = id; @@ -44,14 +44,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// The identifier for the title. /// </summary> + /// <value>The identifier for the title.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// The displayed name of the title. /// </summary> + /// <value>The displayed name of the title.</value> [DataMember(Name = "displayName", EmitDefaultValue = false)] public string DisplayName { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/TitleDtoPagedResponse.cs b/src/Coscine.ApiClient.Core/Model/TitleDtoIEnumerableResponse.cs similarity index 79% rename from src/Coscine.ApiClient.Core/Model/TitleDtoPagedResponse.cs rename to src/Coscine.ApiClient.Core/Model/TitleDtoIEnumerableResponse.cs index e1fa05f1ef3d190ac5b991de990702cfbd0c4156..ae4356f0f6a885e2a1cae701d35ecb9c805b6672 100644 --- a/src/Coscine.ApiClient.Core/Model/TitleDtoPagedResponse.cs +++ b/src/Coscine.ApiClient.Core/Model/TitleDtoIEnumerableResponse.cs @@ -27,24 +27,22 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// TitleDtoPagedResponse + /// TitleDtoIEnumerableResponse /// </summary> - [DataContract(Name = "TitleDtoPagedResponse")] - public partial class TitleDtoPagedResponse : IEquatable<TitleDtoPagedResponse>, IValidatableObject + [DataContract(Name = "TitleDtoIEnumerableResponse")] + public partial class TitleDtoIEnumerableResponse : IEquatable<TitleDtoIEnumerableResponse>, IValidatableObject { /// <summary> - /// Initializes a new instance of the <see cref="TitleDtoPagedResponse" /> class. + /// Initializes a new instance of the <see cref="TitleDtoIEnumerableResponse" /> class. /// </summary> /// <param name="data">data.</param> /// <param name="statusCode">statusCode.</param> /// <param name="traceId">traceId.</param> - /// <param name="pagination">pagination.</param> - public TitleDtoPagedResponse(List<TitleDto> data = default(List<TitleDto>), int? statusCode = default(int?), string traceId = default(string), Pagination pagination = default(Pagination)) + public TitleDtoIEnumerableResponse(List<TitleDto> data = default(List<TitleDto>), int? statusCode = default(int?), string traceId = default(string)) { this.Data = data; this.StatusCode = statusCode; this.TraceId = traceId; - this.Pagination = pagination; } /// <summary> @@ -79,12 +77,6 @@ namespace Coscine.ApiClient.Core.Model [DataMember(Name = "traceId", EmitDefaultValue = true)] public string TraceId { get; set; } - /// <summary> - /// Gets or Sets Pagination - /// </summary> - [DataMember(Name = "pagination", EmitDefaultValue = false)] - public Pagination Pagination { get; set; } - /// <summary> /// Returns the string presentation of the object /// </summary> @@ -92,12 +84,11 @@ namespace Coscine.ApiClient.Core.Model public override string ToString() { StringBuilder sb = new StringBuilder(); - sb.Append("class TitleDtoPagedResponse {\n"); + sb.Append("class TitleDtoIEnumerableResponse {\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(" Pagination: ").Append(Pagination).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -118,15 +109,15 @@ namespace Coscine.ApiClient.Core.Model /// <returns>Boolean</returns> public override bool Equals(object input) { - return this.Equals(input as TitleDtoPagedResponse); + return this.Equals(input as TitleDtoIEnumerableResponse); } /// <summary> - /// Returns true if TitleDtoPagedResponse instances are equal + /// Returns true if TitleDtoIEnumerableResponse instances are equal /// </summary> - /// <param name="input">Instance of TitleDtoPagedResponse to be compared</param> + /// <param name="input">Instance of TitleDtoIEnumerableResponse to be compared</param> /// <returns>Boolean</returns> - public bool Equals(TitleDtoPagedResponse input) + public bool Equals(TitleDtoIEnumerableResponse input) { if (input == null) { @@ -152,11 +143,6 @@ namespace Coscine.ApiClient.Core.Model this.TraceId == input.TraceId || (this.TraceId != null && this.TraceId.Equals(input.TraceId)) - ) && - ( - this.Pagination == input.Pagination || - (this.Pagination != null && - this.Pagination.Equals(input.Pagination)) ); } @@ -182,10 +168,6 @@ namespace Coscine.ApiClient.Core.Model { hashCode = (hashCode * 59) + this.TraceId.GetHashCode(); } - if (this.Pagination != null) - { - hashCode = (hashCode * 59) + this.Pagination.GetHashCode(); - } return hashCode; } } diff --git a/src/Coscine.ApiClient.Core/Model/TitleForUserManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/TitleForUserManipulationDto.cs index 5438dbea190dec2fa9c1d5f78cf08a965a467044..92af5f61373d0c5e06ac6b93605c18df70e2d065 100644 --- a/src/Coscine.ApiClient.Core/Model/TitleForUserManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/TitleForUserManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// TitleForUserManipulationDto + /// Represents the data transfer object (DTO) for manipulating a user's title. /// </summary> [DataContract(Name = "TitleForUserManipulationDto")] public partial class TitleForUserManipulationDto : IEquatable<TitleForUserManipulationDto>, IValidatableObject @@ -40,15 +40,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="TitleForUserManipulationDto" /> class. /// </summary> - /// <param name="id">id (required).</param> + /// <param name="id">The unique identifier of the title. (required).</param> public TitleForUserManipulationDto(Guid id = default(Guid)) { this.Id = id; } /// <summary> - /// Gets or Sets Id + /// The unique identifier of the title. /// </summary> + /// <value>The unique identifier of the title.</value> [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/TreeDataType.cs b/src/Coscine.ApiClient.Core/Model/TreeDataType.cs index 1c976fa0f80a6e6cbd9e8cecc85a11ae860213c4..ce6f5a59da1b9424b9fc4254d4a7f4e72a10b3d3 100644 --- a/src/Coscine.ApiClient.Core/Model/TreeDataType.cs +++ b/src/Coscine.ApiClient.Core/Model/TreeDataType.cs @@ -27,8 +27,9 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// Defines TreeDataType + /// Represents the types of nodes within a hierarchical tree structure. /// </summary> + /// <value>Represents the types of nodes within a hierarchical tree structure.</value> [JsonConverter(typeof(StringEnumConverter))] public enum TreeDataType { diff --git a/src/Coscine.ApiClient.Core/Model/UserDto.cs b/src/Coscine.ApiClient.Core/Model/UserDto.cs index 2183bd04fb269f880b22fc722112783899c38714..aeb3f3c5aa7e5fbafb964165e368f04c61af6b3d 100644 --- a/src/Coscine.ApiClient.Core/Model/UserDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// UserDto + /// Represents a Data Transfer Object (DTO) for user-related information. /// </summary> [DataContract(Name = "UserDto")] public partial class UserDto : IEquatable<UserDto>, IValidatableObject @@ -35,19 +35,20 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="UserDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="displayName">displayName.</param> - /// <param name="givenName">givenName.</param> - /// <param name="familyName">familyName.</param> - /// <param name="emails">emails.</param> + /// <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> /// <param name="title">title.</param> /// <param name="language">language.</param> - /// <param name="areToSAccepted">areToSAccepted.</param> - /// <param name="disciplines">disciplines.</param> - /// <param name="organizations">organizations.</param> - /// <param name="institutes">institutes.</param> - /// <param name="identities">identities.</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), 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="areToSAccepted">Indicates if the terms of service are accepted by the user..</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>)) { this.Id = id; this.DisplayName = displayName; @@ -57,6 +58,7 @@ namespace Coscine.ApiClient.Core.Model this.Title = title; this.Language = language; this.AreToSAccepted = areToSAccepted; + this.LatestActivity = latestActivity; this.Disciplines = disciplines; this.Organizations = organizations; this.Institutes = institutes; @@ -64,32 +66,37 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// The unique identifier of the user. /// </summary> + /// <value>The unique identifier of the user.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// The display name of the user. /// </summary> + /// <value>The display name of the user.</value> [DataMember(Name = "displayName", EmitDefaultValue = false)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets GivenName + /// The given name of the user. /// </summary> + /// <value>The given name of the user.</value> [DataMember(Name = "givenName", EmitDefaultValue = false)] public string GivenName { get; set; } /// <summary> - /// Gets or Sets FamilyName + /// The family name of the user. /// </summary> + /// <value>The family name of the user.</value> [DataMember(Name = "familyName", EmitDefaultValue = false)] public string FamilyName { get; set; } /// <summary> - /// Gets or Sets Emails + /// The email addresses associated with the user. /// </summary> + /// <value>The email addresses associated with the user.</value> [DataMember(Name = "emails", EmitDefaultValue = false)] public List<UserEmailDto> Emails { get; set; } @@ -106,32 +113,44 @@ namespace Coscine.ApiClient.Core.Model public LanguageDto Language { get; set; } /// <summary> - /// Gets or Sets AreToSAccepted + /// 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)] public bool AreToSAccepted { get; set; } /// <summary> - /// Gets or Sets Disciplines + /// The date and time of the latest activity of the user. /// </summary> + /// <value>The date and time of the latest activity of the user.</value> + [DataMember(Name = "latestActivity", EmitDefaultValue = true)] + public DateTime? LatestActivity { get; set; } + + /// <summary> + /// The disciplines associated with the user. + /// </summary> + /// <value>The disciplines associated with the user.</value> [DataMember(Name = "disciplines", EmitDefaultValue = false)] public List<DisciplineDto> Disciplines { get; set; } /// <summary> - /// Gets or Sets Organizations + /// The organizations associated with the user. /// </summary> + /// <value>The organizations associated with the user.</value> [DataMember(Name = "organizations", EmitDefaultValue = false)] public List<UserOrganizationDto> Organizations { get; set; } /// <summary> - /// Gets or Sets Institutes + /// 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> - /// Gets or Sets Identities + /// The identity providers associated with the user. /// </summary> + /// <value>The identity providers associated with the user.</value> [DataMember(Name = "identities", EmitDefaultValue = false)] public List<IdentityProviderDto> Identities { get; set; } @@ -151,6 +170,7 @@ namespace Coscine.ApiClient.Core.Model sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" Language: ").Append(Language).Append("\n"); sb.Append(" AreToSAccepted: ").Append(AreToSAccepted).Append("\n"); + 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"); @@ -230,6 +250,11 @@ namespace Coscine.ApiClient.Core.Model this.AreToSAccepted == input.AreToSAccepted || this.AreToSAccepted.Equals(input.AreToSAccepted) ) && + ( + this.LatestActivity == input.LatestActivity || + (this.LatestActivity != null && + this.LatestActivity.Equals(input.LatestActivity)) + ) && ( this.Disciplines == input.Disciplines || this.Disciplines != null && @@ -294,6 +319,10 @@ namespace Coscine.ApiClient.Core.Model hashCode = (hashCode * 59) + this.Language.GetHashCode(); } hashCode = (hashCode * 59) + this.AreToSAccepted.GetHashCode(); + if (this.LatestActivity != null) + { + hashCode = (hashCode * 59) + this.LatestActivity.GetHashCode(); + } if (this.Disciplines != null) { hashCode = (hashCode * 59) + this.Disciplines.GetHashCode(); diff --git a/src/Coscine.ApiClient.Core/Model/UserEmailDto.cs b/src/Coscine.ApiClient.Core/Model/UserEmailDto.cs index 47cdae328631fa29e9f67a99e1898e079c946c81..0bdcab3b5777661b914135e793528bbf8dbaa08d 100644 --- a/src/Coscine.ApiClient.Core/Model/UserEmailDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserEmailDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// UserEmailDto + /// Represents a Data Transfer Object (DTO) for user email information. /// </summary> [DataContract(Name = "UserEmailDto")] public partial class UserEmailDto : IEquatable<UserEmailDto>, IValidatableObject @@ -35,9 +35,9 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="UserEmailDto" /> class. /// </summary> - /// <param name="email">email.</param> - /// <param name="isConfirmed">isConfirmed.</param> - /// <param name="isPrimary">isPrimary.</param> + /// <param name="email">The email address of the user..</param> + /// <param name="isConfirmed">Indicates whether the email address is confirmed..</param> + /// <param name="isPrimary">Indicates whether the email address is the primary one for the user..</param> public UserEmailDto(string email = default(string), bool isConfirmed = default(bool), bool isPrimary = default(bool)) { this.Email = email; @@ -46,20 +46,23 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Email + /// The email address of the user. /// </summary> + /// <value>The email address of the user.</value> [DataMember(Name = "email", EmitDefaultValue = true)] public string Email { get; set; } /// <summary> - /// Gets or Sets IsConfirmed + /// Indicates whether the email address is confirmed. /// </summary> + /// <value>Indicates whether the email address is confirmed.</value> [DataMember(Name = "isConfirmed", EmitDefaultValue = true)] public bool IsConfirmed { get; set; } /// <summary> - /// Gets or Sets IsPrimary + /// Indicates whether the email address is the primary one for the user. /// </summary> + /// <value>Indicates whether the email address is the primary one for the user.</value> [DataMember(Name = "isPrimary", EmitDefaultValue = true)] public bool IsPrimary { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/UserForUpdateDto.cs b/src/Coscine.ApiClient.Core/Model/UserForUpdateDto.cs index 32c68ba8105c68207d5e2e189c773e7d7842b9a3..b8c16e20f2f15bfddccca8d5905c7ddf31a870ef 100644 --- a/src/Coscine.ApiClient.Core/Model/UserForUpdateDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserForUpdateDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// UserForUpdateDto + /// Represents the data transfer object (DTO) for updating user details. /// </summary> [DataContract(Name = "UserForUpdateDto")] public partial class UserForUpdateDto : IEquatable<UserForUpdateDto>, IValidatableObject @@ -40,14 +40,14 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="UserForUpdateDto" /> class. /// </summary> - /// <param name="givenName">givenName (required).</param> - /// <param name="familyName">familyName (required).</param> - /// <param name="email">email (required).</param> + /// <param name="givenName">The user's given name. (required).</param> + /// <param name="familyName">The user's family name. (required).</param> + /// <param name="email">The user's email address. (required).</param> /// <param name="title">title.</param> /// <param name="language">language (required).</param> - /// <param name="organization">organization.</param> - /// <param name="institute">institute.</param> - /// <param name="disciplines">disciplines (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>)) { // to ensure "givenName" is required (not null) @@ -86,20 +86,23 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets GivenName + /// The user's given name. /// </summary> + /// <value>The user's given name.</value> [DataMember(Name = "givenName", IsRequired = true, EmitDefaultValue = true)] public string GivenName { get; set; } /// <summary> - /// Gets or Sets FamilyName + /// The user's family name. /// </summary> + /// <value>The user's family name.</value> [DataMember(Name = "familyName", IsRequired = true, EmitDefaultValue = true)] public string FamilyName { get; set; } /// <summary> - /// Gets or Sets Email + /// The user's email address. /// </summary> + /// <value>The user's email address.</value> [DataMember(Name = "email", IsRequired = true, EmitDefaultValue = true)] public string Email { get; set; } @@ -116,20 +119,23 @@ namespace Coscine.ApiClient.Core.Model public LanguageForUserManipulationDto Language { get; set; } /// <summary> - /// Gets or Sets Organization + /// The user's organization. /// </summary> + /// <value>The user's organization.</value> [DataMember(Name = "organization", EmitDefaultValue = true)] public string Organization { get; set; } /// <summary> - /// Gets or Sets Institute + /// The user's institute. /// </summary> + /// <value>The user's institute.</value> [DataMember(Name = "institute", EmitDefaultValue = true)] public string Institute { get; set; } /// <summary> - /// Gets or Sets Disciplines + /// The disciplines associated with the user for manipulation. /// </summary> + /// <value>The disciplines associated with the user for manipulation.</value> [DataMember(Name = "disciplines", IsRequired = true, EmitDefaultValue = true)] public List<DisciplineForUserManipulationDto> Disciplines { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/UserInstituteDto.cs b/src/Coscine.ApiClient.Core/Model/UserInstituteDto.cs index 82b9fdaf9b1e807c673c8097a11104d5a1f09383..65ef7cc20826cd2c42bf18e2f82f0bd7aa9d9f2e 100644 --- a/src/Coscine.ApiClient.Core/Model/UserInstituteDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserInstituteDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// UserInstituteDto + /// Represents a Data Transfer Object (DTO) for user institute information, extending the OrganizationDto. /// </summary> [DataContract(Name = "UserInstituteDto")] public partial class UserInstituteDto : IEquatable<UserInstituteDto>, IValidatableObject @@ -35,10 +35,10 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="UserInstituteDto" /> class. /// </summary> - /// <param name="uri">uri.</param> - /// <param name="displayName">displayName.</param> - /// <param name="email">email.</param> - /// <param name="varReadOnly">varReadOnly.</param> + /// <param name="uri">The ROR (Research Organization Registry) ID of the organization..</param> + /// <param name="displayName">The display name of the organization..</param> + /// <param name="email">The email address of the organization..</param> + /// <param name="varReadOnly">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), bool varReadOnly = default(bool)) { this.Uri = uri; @@ -48,26 +48,30 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Uri + /// 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)] public string Uri { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// The display name of the organization. /// </summary> + /// <value>The display name of the organization.</value> [DataMember(Name = "displayName", EmitDefaultValue = false)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Email + /// The email address of the organization. /// </summary> + /// <value>The email address of the organization.</value> [DataMember(Name = "email", EmitDefaultValue = true)] public string Email { get; set; } /// <summary> - /// Gets or Sets VarReadOnly + /// Determines if the organization's details can be modified. Defaults to `true`; manually set to `false`. /// </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 VarReadOnly { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/UserMergeDto.cs b/src/Coscine.ApiClient.Core/Model/UserMergeDto.cs index 1e5e483802f14af470699ceb5078fd554471ffe7..42219a2cffb81775714d70cfae4efa2258d01c83 100644 --- a/src/Coscine.ApiClient.Core/Model/UserMergeDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserMergeDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// UserMergeDto + /// Represents a Data Transfer Object (DTO) for merging user accounts. /// </summary> [DataContract(Name = "UserMergeDto")] public partial class UserMergeDto : IEquatable<UserMergeDto>, IValidatableObject @@ -35,15 +35,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="UserMergeDto" /> class. /// </summary> - /// <param name="token">token.</param> + /// <param name="token">The token required for merging user accounts..</param> public UserMergeDto(string token = default(string)) { this.Token = token; } /// <summary> - /// Gets or Sets Token + /// The token required for merging user accounts. /// </summary> + /// <value>The token required for merging user accounts.</value> [DataMember(Name = "token", EmitDefaultValue = false)] public string Token { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/UserMinimalDto.cs b/src/Coscine.ApiClient.Core/Model/UserMinimalDto.cs index a5d0a05ac8b497a4a9c75d56f55902e3ea6022ff..7c386668f09555fb13cd791d9152c1a45c59b21e 100644 --- a/src/Coscine.ApiClient.Core/Model/UserMinimalDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserMinimalDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// UserMinimalDto + /// Represents a minimal Data Transfer Object (DTO) for user information. /// </summary> [DataContract(Name = "UserMinimalDto")] public partial class UserMinimalDto : IEquatable<UserMinimalDto>, IValidatableObject @@ -35,15 +35,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="UserMinimalDto" /> class. /// </summary> - /// <param name="id">id.</param> + /// <param name="id">The unique identifier for the user..</param> public UserMinimalDto(Guid id = default(Guid)) { this.Id = id; } /// <summary> - /// Gets or Sets Id + /// The unique identifier for the user. /// </summary> + /// <value>The unique identifier for the user.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/UserOrganizationDto.cs b/src/Coscine.ApiClient.Core/Model/UserOrganizationDto.cs index 939bfbb65e0cf8e9e510f2f1cd3c265081e1e132..1f1cb175da766343e264c0d428ab0884156583e8 100644 --- a/src/Coscine.ApiClient.Core/Model/UserOrganizationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserOrganizationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// UserOrganizationDto + /// Represents a Data Transfer Object (DTO) for user-related organization information, inheriting from OrganizationDto. /// </summary> [DataContract(Name = "UserOrganizationDto")] public partial class UserOrganizationDto : IEquatable<UserOrganizationDto>, IValidatableObject @@ -35,10 +35,10 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="UserOrganizationDto" /> class. /// </summary> - /// <param name="uri">uri.</param> - /// <param name="displayName">displayName.</param> - /// <param name="email">email.</param> - /// <param name="varReadOnly">varReadOnly.</param> + /// <param name="uri">The ROR (Research Organization Registry) ID of the organization..</param> + /// <param name="displayName">The display name of the organization..</param> + /// <param name="email">The email address of the organization..</param> + /// <param name="varReadOnly">Determines if the organization's details can be modified..</param> public UserOrganizationDto(string uri = default(string), string displayName = default(string), string email = default(string), bool varReadOnly = default(bool)) { this.Uri = uri; @@ -48,26 +48,30 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Uri + /// 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)] public string Uri { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// The display name of the organization. /// </summary> + /// <value>The display name of the organization.</value> [DataMember(Name = "displayName", EmitDefaultValue = false)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Email + /// The email address of the organization. /// </summary> + /// <value>The email address of the organization.</value> [DataMember(Name = "email", EmitDefaultValue = true)] public string Email { get; set; } /// <summary> - /// Gets or Sets VarReadOnly + /// 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)] public bool VarReadOnly { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/UserTermsOfServiceAcceptDto.cs b/src/Coscine.ApiClient.Core/Model/UserTermsOfServiceAcceptDto.cs index 716c8b876d40511bfb1c2b8cb0ac8e1eb12e854f..2338aa918f50c7195c88603e5f18a8a798f1c3f2 100644 --- a/src/Coscine.ApiClient.Core/Model/UserTermsOfServiceAcceptDto.cs +++ b/src/Coscine.ApiClient.Core/Model/UserTermsOfServiceAcceptDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// UserTermsOfServiceAcceptDto + /// Represents the data transfer object (DTO) for accepting the terms of service by a user. /// </summary> [DataContract(Name = "UserTermsOfServiceAcceptDto")] public partial class UserTermsOfServiceAcceptDto : IEquatable<UserTermsOfServiceAcceptDto>, IValidatableObject @@ -40,7 +40,7 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="UserTermsOfServiceAcceptDto" /> class. /// </summary> - /// <param name="varVersion">varVersion (required).</param> + /// <param name="varVersion">The version of the terms of service being accepted. (required).</param> public UserTermsOfServiceAcceptDto(string varVersion = default(string)) { // to ensure "varVersion" is required (not null) @@ -52,8 +52,9 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets VarVersion + /// The version of the terms of service being accepted. /// </summary> + /// <value>The version of the terms of service being accepted.</value> [DataMember(Name = "version", IsRequired = true, EmitDefaultValue = true)] public string VarVersion { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/VisibilityDto.cs b/src/Coscine.ApiClient.Core/Model/VisibilityDto.cs index 2bcbdcaf57836365e790b4e4cd74db4ac5fc5502..83070bae3d9b134cf63bea3dca605568690feaaa 100644 --- a/src/Coscine.ApiClient.Core/Model/VisibilityDto.cs +++ b/src/Coscine.ApiClient.Core/Model/VisibilityDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// VisibilityDto + /// Represents a Data Transfer Object (DTO) for visibility settings. /// </summary> [DataContract(Name = "VisibilityDto")] public partial class VisibilityDto : IEquatable<VisibilityDto>, IValidatableObject @@ -35,8 +35,8 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="VisibilityDto" /> class. /// </summary> - /// <param name="id">id.</param> - /// <param name="displayName">displayName.</param> + /// <param name="id">The identifier for the visibility setting..</param> + /// <param name="displayName">The display name for the visibility setting..</param> public VisibilityDto(Guid id = default(Guid), string displayName = default(string)) { this.Id = id; @@ -44,14 +44,16 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets Id + /// The identifier for the visibility setting. /// </summary> + /// <value>The identifier for the visibility setting.</value> [DataMember(Name = "id", EmitDefaultValue = false)] public Guid Id { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// The display name for the visibility setting. /// </summary> + /// <value>The display name for the visibility setting.</value> [DataMember(Name = "displayName", EmitDefaultValue = false)] public string DisplayName { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/VisibilityForProjectManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/VisibilityForProjectManipulationDto.cs index 6c799ce1e157961cc34d3f0f4502e525ebc9921a..e1cea48c88619c66d9f03fe355626f920309fd5e 100644 --- a/src/Coscine.ApiClient.Core/Model/VisibilityForProjectManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/VisibilityForProjectManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// VisibilityForProjectManipulationDto + /// Represents the data transfer object (DTO) for manipulating the visibility of a project. /// </summary> [DataContract(Name = "VisibilityForProjectManipulationDto")] public partial class VisibilityForProjectManipulationDto : IEquatable<VisibilityForProjectManipulationDto>, IValidatableObject @@ -40,15 +40,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="VisibilityForProjectManipulationDto" /> class. /// </summary> - /// <param name="id">id (required).</param> + /// <param name="id">The unique identifier of the visibility setting. (required).</param> public VisibilityForProjectManipulationDto(Guid id = default(Guid)) { this.Id = id; } /// <summary> - /// Gets or Sets Id + /// The unique identifier of the visibility setting. /// </summary> + /// <value>The unique identifier of the visibility setting.</value> [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/VisibilityForResourceManipulationDto.cs b/src/Coscine.ApiClient.Core/Model/VisibilityForResourceManipulationDto.cs index cbc5c6a6d1203fd179546a10556edf040281a978..95889f89e82b35943dfb354e8711b8010369041c 100644 --- a/src/Coscine.ApiClient.Core/Model/VisibilityForResourceManipulationDto.cs +++ b/src/Coscine.ApiClient.Core/Model/VisibilityForResourceManipulationDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// VisibilityForResourceManipulationDto + /// Represents the data transfer object (DTO) for manipulating the visibility of a resource. /// </summary> [DataContract(Name = "VisibilityForResourceManipulationDto")] public partial class VisibilityForResourceManipulationDto : IEquatable<VisibilityForResourceManipulationDto>, IValidatableObject @@ -40,15 +40,16 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="VisibilityForResourceManipulationDto" /> class. /// </summary> - /// <param name="id">id (required).</param> + /// <param name="id">The unique identifier of the visibility setting. (required).</param> public VisibilityForResourceManipulationDto(Guid id = default(Guid)) { this.Id = id; } /// <summary> - /// Gets or Sets Id + /// The unique identifier of the visibility setting. /// </summary> + /// <value>The unique identifier of the visibility setting.</value> [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public Guid Id { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/VocabularyDto.cs b/src/Coscine.ApiClient.Core/Model/VocabularyDto.cs index b1d9fc7be2cdb45a78afbf6d2ddb1dc039fb15e6..2aceade84c2113042603953ff3d76d332e4b90e9 100644 --- a/src/Coscine.ApiClient.Core/Model/VocabularyDto.cs +++ b/src/Coscine.ApiClient.Core/Model/VocabularyDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// VocabularyDto + /// Represents a Data Transfer Object (DTO) for vocabulary details. /// </summary> [DataContract(Name = "VocabularyDto")] public partial class VocabularyDto : IEquatable<VocabularyDto>, IValidatableObject @@ -35,10 +35,10 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="VocabularyDto" /> class. /// </summary> - /// <param name="graphUri">graphUri.</param> - /// <param name="classUri">classUri.</param> - /// <param name="displayName">displayName.</param> - /// <param name="description">description.</param> + /// <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> + /// <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)) { this.GraphUri = graphUri; @@ -48,26 +48,30 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets GraphUri + /// The URI of the graph containing the vocabulary. /// </summary> + /// <value>The URI of the graph containing the vocabulary.</value> [DataMember(Name = "graphUri", EmitDefaultValue = false)] public string GraphUri { get; set; } /// <summary> - /// Gets or Sets ClassUri + /// 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)] public string ClassUri { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// The display name of the vocabulary. /// </summary> + /// <value>The display name of the vocabulary.</value> [DataMember(Name = "displayName", EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Description + /// The description of the vocabulary. /// </summary> + /// <value>The description of the vocabulary.</value> [DataMember(Name = "description", EmitDefaultValue = true)] public string Description { get; set; } diff --git a/src/Coscine.ApiClient.Core/Model/VocabularyInstanceDto.cs b/src/Coscine.ApiClient.Core/Model/VocabularyInstanceDto.cs index 1b5e7f2f424b2d46f67b49a781a9521c596297bc..965fcb793bc8e6840ee1b3d1e842d76a7ce7fc6b 100644 --- a/src/Coscine.ApiClient.Core/Model/VocabularyInstanceDto.cs +++ b/src/Coscine.ApiClient.Core/Model/VocabularyInstanceDto.cs @@ -27,7 +27,7 @@ using OpenAPIDateConverter = Coscine.ApiClient.Core.Client.OpenAPIDateConverter; namespace Coscine.ApiClient.Core.Model { /// <summary> - /// VocabularyInstanceDto + /// Represents a Data Transfer Object (DTO) for vocabulary instance details. /// </summary> [DataContract(Name = "VocabularyInstanceDto")] public partial class VocabularyInstanceDto : IEquatable<VocabularyInstanceDto>, IValidatableObject @@ -35,12 +35,12 @@ namespace Coscine.ApiClient.Core.Model /// <summary> /// Initializes a new instance of the <see cref="VocabularyInstanceDto" /> class. /// </summary> - /// <param name="graphUri">graphUri.</param> - /// <param name="instanceUri">instanceUri.</param> - /// <param name="typeUri">typeUri.</param> - /// <param name="subClassOfUri">subClassOfUri.</param> - /// <param name="displayName">displayName.</param> - /// <param name="description">description.</param> + /// <param name="graphUri">The URI of the graph containing the vocabulary..</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> + /// <param name="displayName">The display name of the vocabulary instance..</param> + /// <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)) { this.GraphUri = graphUri; @@ -52,38 +52,44 @@ namespace Coscine.ApiClient.Core.Model } /// <summary> - /// Gets or Sets GraphUri + /// The URI of the graph containing the vocabulary. /// </summary> + /// <value>The URI of the graph containing the vocabulary.</value> [DataMember(Name = "graphUri", EmitDefaultValue = false)] public string GraphUri { get; set; } /// <summary> - /// Gets or Sets InstanceUri + /// The URI of the instance. /// </summary> + /// <value>The URI of the instance.</value> [DataMember(Name = "instanceUri", EmitDefaultValue = false)] public string InstanceUri { get; set; } /// <summary> - /// Gets or Sets TypeUri + /// The URI representing the type of the instance. /// </summary> + /// <value>The URI representing the type of the instance.</value> [DataMember(Name = "typeUri", EmitDefaultValue = true)] public string TypeUri { get; set; } /// <summary> - /// Gets or Sets SubClassOfUri + /// The URI of the direct parent class. /// </summary> + /// <value>The URI of the direct parent class.</value> [DataMember(Name = "subClassOfUri", EmitDefaultValue = true)] public string SubClassOfUri { get; set; } /// <summary> - /// Gets or Sets DisplayName + /// The display name of the vocabulary instance. /// </summary> + /// <value>The display name of the vocabulary instance.</value> [DataMember(Name = "displayName", EmitDefaultValue = true)] public string DisplayName { get; set; } /// <summary> - /// Gets or Sets Description + /// The description of the vocabulary instance. /// </summary> + /// <value>The description of the vocabulary instance.</value> [DataMember(Name = "description", EmitDefaultValue = true)] public string Description { get; set; } diff --git a/src/Coscine.ApiClient/JwtUtil.cs b/src/Coscine.ApiClient/ApiConfigurationUtil.cs similarity index 72% rename from src/Coscine.ApiClient/JwtUtil.cs rename to src/Coscine.ApiClient/ApiConfigurationUtil.cs index 33770f2f71de87d923bce304ce7679dc903101c4..7cd4d7037c833021a70adc5ad52aa0e692f93855 100644 --- a/src/Coscine.ApiClient/JwtUtil.cs +++ b/src/Coscine.ApiClient/ApiConfigurationUtil.cs @@ -11,17 +11,18 @@ using Winton.Extensions.Configuration.Consul; namespace Coscine.ApiClient; /// <summary> -/// Provides utility methods for JWT (JSON Web Token) configuration retrieval and token generation. +/// Provides utility methods for retrieving API configuration settings and generating JWT (JSON Web Token). /// </summary> -public class JwtUtil +public class ApiConfigurationUtil { /// <summary> - /// Retrieves the JWT configuration either from a given Consul URL or from environment variables, with support for different environments. + /// Retrieves the API configuration settings from either a specified Consul URL or environment variables, + /// accommodating different environments. This configuration includes JWT settings and other API-related settings. /// </summary> - /// <param name="environment">The environment for which to retrieve the configuration, defaulting to "development".</param> - /// <param name="givenConsulUrl">An optional Consul URL to use instead of the environment variable.</param> - /// <returns>The retrieved JWT configuration settings.</returns> - public static JwtConfiguration RetrieveJwtConfiguration(string environment = "development", string? givenConsulUrl = null) + /// <param name="environment">The environment name to target, defaulting to "development".</param> + /// <param name="givenConsulUrl">An optional URL to the Consul service. If not provided, the method attempts to use the CONSUL_URL environment variable.</param> + /// <returns>An <see cref="IConfiguration"/> object containing the API configuration settings.</returns> + public static IConfiguration RetrieveApiConfiguration(string environment = "development", string? givenConsulUrl = null) { var consulUrl = givenConsulUrl ?? Environment.GetEnvironmentVariable("CONSUL_URL") ?? "http://localhost:8500"; @@ -54,13 +55,26 @@ public class JwtUtil ) .AddEnvironmentVariables() .Build(); + + return configuration; + } + + /// <summary> + /// Retrieves JWT configuration settings from the API configuration. This can include settings specific to JWT, such as issuer, audience, and keys. + /// </summary> + /// <param name="environment">The environment name for which to retrieve the configuration, defaulting to "development".</param> + /// <param name="givenConsulUrl">An optional Consul URL to use instead of the environment variable.</param> + /// <returns>A <see cref="JwtConfiguration"/> object populated with JWT-specific settings.</returns> + public static JwtConfiguration RetrieveJwtConfiguration(string environment = "development", string? givenConsulUrl = null) + { + var configuration = RetrieveApiConfiguration(environment, givenConsulUrl); return RetrieveJwtConfiguration(configuration); } /// <summary> - /// Binds a given <see cref="IConfiguration"/> instance to a <see cref="JwtConfiguration"/> object. + /// Binds a given <see cref="IConfiguration"/> instance to a <see cref="JwtConfiguration"/> object, extracting JWT-specific settings. /// </summary> - /// <param name="configuration">The configuration instance to bind from.</param> + /// <param name="configuration">The configuration instance from which to extract JWT settings.</param> /// <returns>A <see cref="JwtConfiguration"/> object populated with values from the provided configuration instance.</returns> public static JwtConfiguration RetrieveJwtConfiguration(IConfiguration configuration) { @@ -91,12 +105,12 @@ public class JwtUtil } /// <summary> - /// Generates a JWT security token using specified payload, expiration, and key. + /// Generates a JWT security token using specified payload, expiration time, and a signing key. /// </summary> - /// <param name="jwtConfiguration">Jwt Configuration.</param> - /// <param name="payloadContents">The payload contents as a dictionary.</param> - /// <param name="expiresInMinutes">The expiration time in minutes for the token.</param> - /// <param name="jsonWebKey">The Json Web Key to sign the token with.</param> + /// <param name="jwtConfiguration">The JWT configuration containing the necessary settings for token generation.</param> + /// <param name="payloadContents">A dictionary containing the payload contents of the token.</param> + /// <param name="expiresInMinutes">The token's expiration time in minutes.</param> + /// <param name="jsonWebKey">The Json Web Key used to sign the token.</param> /// <returns>A <see cref="JwtSecurityToken"/> instance.</returns> public static JwtSecurityToken GenerateJwtSecurityToken(JwtConfiguration jwtConfiguration, IReadOnlyDictionary<string, string> payloadContents, double expiresInMinutes, JsonWebKey jsonWebKey) {