Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found
Select Git revision

Target

Select target project
  • coscine/backend/libraries/apiclient
1 result
Select Git revision
Show changes
Commits on Source (3)
Expand all Show whitespace changes
Inline Side-by-side
Showing
with 913 additions and 94 deletions
README.md
View file @ b669f256
......@@ -6,7 +6,7 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
- API version: 2.0
- SDK version: 1.0.0
- Generator version: 7.11.0-SNAPSHOT
- Generator version: 7.13.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.CSharpClientCodegen
<a id="frameworks-supported"></a>
......@@ -15,22 +15,16 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
<a id="dependencies"></a>
## Dependencies
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 112.0.0 or later
- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 13.0.2 or later
- [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.8.0 or later
- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 5.0.0 or later
The DLLs included in the package may not be the latest version. We recommend using [NuGet](https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:
```
Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations
```
NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See [RestSharp#742](https://github.com/restsharp/RestSharp/issues/742).
NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).
<a id="installation"></a>
## Installation
Run the following command to generate the DLL
......@@ -67,12 +61,40 @@ webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;
```
### Connections
Each ApiClass (properly the ApiClient inside it) will create an instance of HttpClient. It will use that for the entire lifecycle and dispose it when called the Dispose method.
To better manager the connections it's a common practice to reuse the HttpClient and HttpClientHandler (see [here](https://docs.microsoft.com/en-us/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests#issues-with-the-original-httpclient-class-available-in-net) for details). To use your own HttpClient instance just pass it to the ApiClass constructor.
```csharp
HttpClientHandler yourHandler = new HttpClientHandler();
HttpClient yourHttpClient = new HttpClient(yourHandler);
var api = new YourApiClass(yourHttpClient, yourHandler);
```
If you want to use an HttpClient and don't have access to the handler, for example in a DI context in Asp.net Core when using IHttpClientFactory.
```csharp
HttpClient yourHttpClient = new HttpClient();
var api = new YourApiClass(yourHttpClient);
```
You'll loose some configuration settings, the features affected are: Setting and Retrieving Cookies, Client Certificates, Proxy settings. You need to either manually handle those in your setup of the HttpClient or they won't be available.
Here an example of DI setup in a sample web project:
```csharp
services.AddHttpClient<YourApiClass>(httpClient =>
new PetApi(httpClient));
```
<a id="getting-started"></a>
## Getting Started
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -85,13 +107,16 @@ namespace Example
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.ApiKey.Add("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.ApiKeyPrefix.Add("Authorization", "Bearer");
var apiInstance = new AdminApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new AdminApi(httpClient, config, httpClientHandler);
try
{
......@@ -113,11 +138,12 @@ namespace Example
<a id="documentation-for-api-endpoints"></a>
## Documentation for API Endpoints
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
All URIs are relative to *https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AdminApi* | [**ApiV2AdminOptions**](docs/AdminApi.md#apiv2adminoptions) | **OPTIONS** /api/v2/admin | Responds with the HTTP methods allowed for the endpoint.
*AdminApi* | [**CreateDatasource**](docs/AdminApi.md#createdatasource) | **POST** /api/v2/admin/resource/{resourceId}/type/{typeId} | Creates a new datasource for a specified resource and type.
*AdminApi* | [**GetAllActivityLogs**](docs/AdminApi.md#getallactivitylogs) | **GET** /api/v2/admin/activity-logs | Retrieves all activity logs.
*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.
......@@ -126,6 +152,7 @@ Class | Method | HTTP request | Description
*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.
*AdminApi* | [**UpdateResourceType**](docs/AdminApi.md#updateresourcetype) | **PUT** /api/v2/admin/resource/{resourceId}/type/{typeId} | Updates the type and option ID of a specified resource.
*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.
......@@ -150,6 +177,9 @@ Class | Method | HTTP request | Description
*LicenseApi* | [**GetLicenses**](docs/LicenseApi.md#getlicenses) | **GET** /api/v2/licenses | Retrieves all licenses.
*MaintenanceApi* | [**ApiV2MaintenancesOptions**](docs/MaintenanceApi.md#apiv2maintenancesoptions) | **OPTIONS** /api/v2/maintenances | Responds with the HTTP methods allowed for the endpoint.
*MaintenanceApi* | [**GetCurrentMaintenances**](docs/MaintenanceApi.md#getcurrentmaintenances) | **GET** /api/v2/maintenances | Retrieves the current maintenance messages.
*NotificationApi* | [**ApiV2NotificationsOptions**](docs/NotificationApi.md#apiv2notificationsoptions) | **OPTIONS** /api/v2/notifications | Responds with the HTTP methods allowed for the endpoint.
*NotificationApi* | [**GetNotification**](docs/NotificationApi.md#getnotification) | **GET** /api/v2/notifications/{notificationId} | Retrieves a notification by ID.
*NotificationApi* | [**GetNotifications**](docs/NotificationApi.md#getnotifications) | **GET** /api/v2/notifications | Retrieves all notifications.
*OrganizationApi* | [**ApiV2OrganizationsOptions**](docs/OrganizationApi.md#apiv2organizationsoptions) | **OPTIONS** /api/v2/organizations | Responds with the HTTP methods allowed for the endpoint.
*OrganizationApi* | [**GetOrganization**](docs/OrganizationApi.md#getorganization) | **GET** /api/v2/organizations/{organizationRorUri} | Retrieves an organization.
*OrganizationApi* | [**GetOrganizations**](docs/OrganizationApi.md#getorganizations) | **GET** /api/v2/organizations | Retrieves all organizations.
......@@ -244,6 +274,11 @@ Class | Method | HTTP request | Description
*TreeApi* | [**UpdateMetadataTree**](docs/TreeApi.md#updatemetadatatree) | **PUT** /api/v2/projects/{projectId}/resources/{resourceId}/trees/metadata | Updates an existing metadata tree of a resource.
*UserApi* | [**ApiV2UsersOptions**](docs/UserApi.md#apiv2usersoptions) | **OPTIONS** /api/v2/users | Responds with the HTTP methods allowed for the endpoint.
*UserApi* | [**GetUsers**](docs/UserApi.md#getusers) | **GET** /api/v2/users | Retrieves all users.
*UserNotificationOptOutApi* | [**ApiV2UserNotificationsOptions**](docs/UserNotificationOptOutApi.md#apiv2usernotificationsoptions) | **OPTIONS** /api/v2/user-notifications | Responds with the HTTP methods allowed for the endpoint.
*UserNotificationOptOutApi* | [**CreateUserNotification**](docs/UserNotificationOptOutApi.md#createusernotification) | **POST** /api/v2/user-notifications | Creates a user notification for a specified user.
*UserNotificationOptOutApi* | [**DeleteUserNotification**](docs/UserNotificationOptOutApi.md#deleteusernotification) | **DELETE** /api/v2/user-notifications/{id} | Deletes a user notification for a specified user.
*UserNotificationOptOutApi* | [**GetUserNotification**](docs/UserNotificationOptOutApi.md#getusernotification) | **GET** /api/v2/user-notifications/{notificationId} | Retrieves a user notification for a specified notification.
*UserNotificationOptOutApi* | [**GetUserNotifications**](docs/UserNotificationOptOutApi.md#getusernotifications) | **GET** /api/v2/user-notifications | Retrieves all user notifications of the current user.
*VisibilityApi* | [**ApiV2VisibilitiesOptions**](docs/VisibilityApi.md#apiv2visibilitiesoptions) | **OPTIONS** /api/v2/visibilities | Responds with the HTTP methods allowed for the endpoint.
*VisibilityApi* | [**GetVisibilities**](docs/VisibilityApi.md#getvisibilities) | **GET** /api/v2/visibilities | Retrieves all visibilities.
*VisibilityApi* | [**GetVisibility**](docs/VisibilityApi.md#getvisibility) | **GET** /api/v2/visibilities/{visibilityId} | Retrieves a visibility by ID.
......@@ -271,6 +306,14 @@ Class | Method | HTTP request | Description
- [Model.ApplicationProfileForResourceCreationDto](docs/ApplicationProfileForResourceCreationDto.md)
- [Model.ApplicationProfileMinimalDto](docs/ApplicationProfileMinimalDto.md)
- [Model.CoscineHttpMethod](docs/CoscineHttpMethod.md)
- [Model.CreateDatasourceDto](docs/CreateDatasourceDto.md)
- [Model.CreateDatasourceDtoResponse](docs/CreateDatasourceDtoResponse.md)
- [Model.DataStorageNrwS3OptionsDto](docs/DataStorageNrwS3OptionsDto.md)
- [Model.DataStorageNrwS3ResourceTypeOptionsForManipulationDto](docs/DataStorageNrwS3ResourceTypeOptionsForManipulationDto.md)
- [Model.DataStorageNrwS3WormOptionsDto](docs/DataStorageNrwS3WormOptionsDto.md)
- [Model.DataStorageNrwS3WormResourceTypeOptionsForManipulationDto](docs/DataStorageNrwS3WormResourceTypeOptionsForManipulationDto.md)
- [Model.DataStorageNrwWebOptionsDto](docs/DataStorageNrwWebOptionsDto.md)
- [Model.DataStorageNrwWebResourceTypeOptionsForManipulationDto](docs/DataStorageNrwWebResourceTypeOptionsForManipulationDto.md)
- [Model.DeployedGraphDto](docs/DeployedGraphDto.md)
- [Model.DeployedGraphDtoPagedResponse](docs/DeployedGraphDtoPagedResponse.md)
- [Model.DisciplineDto](docs/DisciplineDto.md)
......@@ -325,6 +368,9 @@ Class | Method | HTTP request | Description
- [Model.MetadataTreeForDeletionDto](docs/MetadataTreeForDeletionDto.md)
- [Model.MetadataTreeForUpdateDto](docs/MetadataTreeForUpdateDto.md)
- [Model.MetadataUpdateAdminParameters](docs/MetadataUpdateAdminParameters.md)
- [Model.NotificationDto](docs/NotificationDto.md)
- [Model.NotificationDtoPagedResponse](docs/NotificationDtoPagedResponse.md)
- [Model.NotificationDtoResponse](docs/NotificationDtoResponse.md)
- [Model.OrganizationDto](docs/OrganizationDto.md)
- [Model.OrganizationDtoPagedResponse](docs/OrganizationDtoPagedResponse.md)
- [Model.OrganizationDtoResponse](docs/OrganizationDtoResponse.md)
......@@ -433,6 +479,10 @@ Class | Method | HTTP request | Description
- [Model.UserMergeDto](docs/UserMergeDto.md)
- [Model.UserMergeDtoResponse](docs/UserMergeDtoResponse.md)
- [Model.UserMinimalDto](docs/UserMinimalDto.md)
- [Model.UserNotificationForCreationDto](docs/UserNotificationForCreationDto.md)
- [Model.UserNotificationOptOutDto](docs/UserNotificationOptOutDto.md)
- [Model.UserNotificationOptOutDtoPagedResponse](docs/UserNotificationOptOutDtoPagedResponse.md)
- [Model.UserNotificationOptOutDtoResponse](docs/UserNotificationOptOutDtoResponse.md)
- [Model.UserOrganizationDto](docs/UserOrganizationDto.md)
- [Model.UserTermsOfServiceAcceptDto](docs/UserTermsOfServiceAcceptDto.md)
- [Model.VariantDto](docs/VariantDto.md)
......
docs/AdminApi.md
View file @ b669f256
This diff is collapsed.
docs/ApplicationProfileApi.md
View file @ b669f256
# Coscine.ApiClient.Core.Api.ApplicationProfileApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
All URIs are relative to *https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
......@@ -20,6 +20,7 @@ Responds with the HTTP methods allowed for the endpoint.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -31,13 +32,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new ApplicationProfileApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new ApplicationProfileApi(httpClient, config, httpClientHandler);
try
{
......@@ -105,6 +109,7 @@ Submits a request to create a new application profile.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -116,13 +121,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new ApplicationProfileApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new ApplicationProfileApi(httpClient, config, httpClientHandler);
var applicationProfileForCreationDto = new ApplicationProfileForCreationDto?(); // ApplicationProfileForCreationDto? | The details required to create a new application profile. (optional)
try
......@@ -202,6 +210,7 @@ Retrieves an application profile by its URI.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -213,13 +222,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new ApplicationProfileApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new ApplicationProfileApi(httpClient, config, httpClientHandler);
var profile = "profile_example"; // string | The URI of the application profile to retrieve.
var format = new RdfFormat?(); // RdfFormat? | The desired data format for the returned application profile. (optional)
var acceptLanguage = new AcceptedLanguage?(); // AcceptedLanguage? | The preferred language for the application profile data. (optional)
......@@ -301,6 +313,7 @@ Retrieves all application profiles.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -312,13 +325,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new ApplicationProfileApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new ApplicationProfileApi(httpClient, config, httpClientHandler);
var searchTerm = "searchTerm_example"; // string? | Gets or sets the search term used to filter application profiles. (optional)
var language = new AcceptedLanguage?(); // AcceptedLanguage? | Gets or sets the language for which the application profiles are requested. (optional)
var modules = true; // bool? | Gets or sets a value indicating whether to include modules in the application profiles. (optional)
......@@ -405,6 +421,7 @@ Retrieves the `raw` application profile definition by its URI.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -416,13 +433,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new ApplicationProfileApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new ApplicationProfileApi(httpClient, config, httpClientHandler);
var profile = "profile_example"; // string | The URI of the application profile.
try
......
docs/BlobApi.md
View file @ b669f256
# Coscine.ApiClient.Core.Api.BlobApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
All URIs are relative to *https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
......@@ -20,6 +20,7 @@ Responds with the HTTP methods allowed for the endpoint.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -31,13 +32,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new BlobApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new BlobApi(httpClient, config, httpClientHandler);
var projectId = "projectId_example"; // string |
var resourceId = "resourceId_example"; // string |
......@@ -104,7 +108,7 @@ void (empty response body)
<a id="createblob"></a>
# **CreateBlob**
> void CreateBlob (string projectId, Guid resourceId, string key, System.IO.Stream? file = null)
> void CreateBlob (string projectId, Guid resourceId, string key, FileParameter? file = null)
Creates a new blob for a resource.
......@@ -112,6 +116,7 @@ Creates a new blob for a resource.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -123,17 +128,20 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new BlobApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new BlobApi(httpClient, config, httpClientHandler);
var projectId = "projectId_example"; // string | The identifier or slug of the project.
var resourceId = "resourceId_example"; // Guid | The identifier of the resource.
var key = "key_example"; // string | The key for the new blob.
var file = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt")); // System.IO.Stream? | (optional)
var file = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt")); // FileParameter? | (optional)
try
{
......@@ -175,7 +183,7 @@ catch (ApiException e)
| **projectId** | **string** | The identifier or slug of the project. | |
| **resourceId** | **Guid** | The identifier of the resource. | |
| **key** | **string** | The key for the new blob. | |
| **file** | **System.IO.Stream?****System.IO.Stream?** | | [optional] |
| **file** | **FileParameter?****FileParameter?** | | [optional] |
### Return type
......@@ -210,6 +218,7 @@ Deletes a blob from a resource.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -221,13 +230,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new BlobApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new BlobApi(httpClient, config, httpClientHandler);
var projectId = "projectId_example"; // string | The identifier or slug of the project.
var resourceId = "resourceId_example"; // Guid | The identifier of the resource.
var key = "key_example"; // string | The key associated with the blob to delete.
......@@ -297,7 +309,7 @@ void (empty response body)
<a id="getblob"></a>
# **GetBlob**
> System.IO.Stream GetBlob (string projectId, Guid resourceId, string key)
> FileParameter GetBlob (string projectId, Guid resourceId, string key)
Download a blob from a resource.
......@@ -305,6 +317,7 @@ Download a blob from a resource.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -316,13 +329,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new BlobApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new BlobApi(httpClient, config, httpClientHandler);
var projectId = "projectId_example"; // string | The identifier or slug of the project.
var resourceId = "resourceId_example"; // Guid | The identifier of the resource.
var key = "key_example"; // string | The key associated with the blob.
......@@ -330,7 +346,7 @@ namespace Example
try
{
// Download a blob from a resource.
System.IO.Stream result = apiInstance.GetBlob(projectId, resourceId, key);
FileParameter result = apiInstance.GetBlob(projectId, resourceId, key);
Debug.WriteLine(result);
}
catch (ApiException e)
......@@ -351,7 +367,7 @@ This returns an ApiResponse object which contains the response data, status code
try
{
// Download a blob from a resource.
ApiResponse<System.IO.Stream> response = apiInstance.GetBlobWithHttpInfo(projectId, resourceId, key);
ApiResponse<FileParameter> response = apiInstance.GetBlobWithHttpInfo(projectId, resourceId, key);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
......@@ -374,7 +390,7 @@ catch (ApiException e)
### Return type
**System.IO.Stream**
[**FileParameter**](FileParameter.md)
### Authorization
......@@ -396,7 +412,7 @@ catch (ApiException e)
<a id="updateblob"></a>
# **UpdateBlob**
> void UpdateBlob (string projectId, Guid resourceId, string key, System.IO.Stream? file = null)
> void UpdateBlob (string projectId, Guid resourceId, string key, FileParameter? file = null)
Updates an existing blob of a resource.
......@@ -404,6 +420,7 @@ Updates an existing blob of a resource.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -415,17 +432,20 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new BlobApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new BlobApi(httpClient, config, httpClientHandler);
var projectId = "projectId_example"; // string | The identifier or slug of the project.
var resourceId = "resourceId_example"; // Guid | The identifier of the resource.
var key = "key_example"; // string | The key associated with the blob to update.
var file = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt")); // System.IO.Stream? | (optional)
var file = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt")); // FileParameter? | (optional)
try
{
......@@ -467,7 +487,7 @@ catch (ApiException e)
| **projectId** | **string** | The identifier or slug of the project. | |
| **resourceId** | **Guid** | The identifier of the resource. | |
| **key** | **string** | The key associated with the blob to update. | |
| **file** | **System.IO.Stream?****System.IO.Stream?** | | [optional] |
| **file** | **FileParameter?****FileParameter?** | | [optional] |
### Return type
......
docs/CreateDatasourceDto.md 0 → 100644
View file @ b669f256
# Coscine.ApiClient.Core.Model.CreateDatasourceDto
Represents the data transfer object for creating a datasource.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ResourceTypeOptionId** | **Guid?** | Gets or initializes the unique identifier of the resource type option. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/CreateDatasourceDtoResponse.md 0 → 100644
View file @ b669f256
# Coscine.ApiClient.Core.Model.CreateDatasourceDtoResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**CreateDatasourceDto**](CreateDatasourceDto.md) | | [optional]
**IsSuccess** | **bool** | | [optional] [readonly]
**StatusCode** | **int?** | | [optional]
**TraceId** | **string** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DataStorageNrwS3OptionsDto.md 0 → 100644
View file @ b669f256
# Coscine.ApiClient.Core.Model.DataStorageNrwS3OptionsDto
Represents the data transfer object (DTO) for DataStorage.nrw S3 options.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**BucketName** | **string** | The name of the bucket associated with DataStorage.nrw S3. |
**AccessKeyRead** | **string** | The access key for reading from the DataStorage.nrw S3 bucket. |
**SecretKeyRead** | **string** | The secret key for reading from the DataStorage.nrw S3 bucket. |
**AccessKeyWrite** | **string** | The access key for writing to the DataStorage.nrw S3 bucket. |
**SecretKeyWrite** | **string** | The secret key for writing to the DataStorage.nrw S3 bucket. |
**Endpoint** | **string** | The endpoint for the DataStorage.nrw S3 bucket. |
**Size** | [**QuotaDto**](QuotaDto.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DataStorageNrwS3ResourceTypeOptionsForManipulationDto.md 0 → 100644
View file @ b669f256
# Coscine.ApiClient.Core.Model.DataStorageNrwS3ResourceTypeOptionsForManipulationDto
Represents the data transfer object (DTO) for manipulating DataStorage.nrw S3 resource type options.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Quota** | [**QuotaForManipulationDto**](QuotaForManipulationDto.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DataStorageNrwS3WormOptionsDto.md 0 → 100644
View file @ b669f256
# Coscine.ApiClient.Core.Model.DataStorageNrwS3WormOptionsDto
Represents the data transfer object (DTO) for DataStorage.nrw S3 WORM options.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**BucketName** | **string** | The name of the bucket associated with DataStorage.nrw S3 WORM. |
**AccessKeyRead** | **string** | The access key for reading from the DataStorage.nrw S3 WORM bucket. |
**SecretKeyRead** | **string** | The secret key for reading from the DataStorage.nrw S3 WORM bucket. |
**AccessKeyWrite** | **string** | The access key for writing to the DataStorage.nrw S3 WORM bucket. |
**SecretKeyWrite** | **string** | The secret key for writing to the DataStorage.nrw S3 WORM bucket. |
**Endpoint** | **string** | The endpoint for the RDS DataStorage.nrw WORM bucket. |
**Size** | [**QuotaDto**](QuotaDto.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DataStorageNrwS3WormResourceTypeOptionsForManipulationDto.md 0 → 100644
View file @ b669f256
# Coscine.ApiClient.Core.Model.DataStorageNrwS3WormResourceTypeOptionsForManipulationDto
Represents the data transfer object (DTO) for manipulating DataStorage.nrw S3 WORM resource type options.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Quota** | [**QuotaForManipulationDto**](QuotaForManipulationDto.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DataStorageNrwWebOptionsDto.md 0 → 100644
View file @ b669f256
# Coscine.ApiClient.Core.Model.DataStorageNrwWebOptionsDto
Represents the data transfer object (DTO) for DataStorage.nrw Web options.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**BucketName** | **string** | The name of the bucket associated with DataStorage.nrw Web. |
**Size** | [**QuotaDto**](QuotaDto.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DataStorageNrwWebResourceTypeOptionsForManipulationDto.md 0 → 100644
View file @ b669f256
# Coscine.ApiClient.Core.Model.DataStorageNrwWebResourceTypeOptionsForManipulationDto
Represents the data transfer object (DTO) for manipulating DataStorage.nrw Web resource type options.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Quota** | [**QuotaForManipulationDto**](QuotaForManipulationDto.md) | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/DisciplineApi.md
View file @ b669f256
# Coscine.ApiClient.Core.Api.DisciplineApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
All URIs are relative to *https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
......@@ -18,6 +18,7 @@ Responds with the HTTP methods allowed for the endpoint.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -29,13 +30,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new DisciplineApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new DisciplineApi(httpClient, config, httpClientHandler);
try
{
......@@ -103,6 +107,7 @@ Retrieves a discipline with the specified ID.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -114,13 +119,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new DisciplineApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new DisciplineApi(httpClient, config, httpClientHandler);
var disciplineId = "disciplineId_example"; // Guid | The ID of the discipline.
try
......@@ -198,6 +206,7 @@ Retrieves all disciplines.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -209,13 +218,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new DisciplineApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new DisciplineApi(httpClient, config, httpClientHandler);
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
......
docs/HandleApi.md
View file @ b669f256
# Coscine.ApiClient.Core.Api.HandleApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
All URIs are relative to *https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
......@@ -18,6 +18,7 @@ Responds with the HTTP methods allowed for the endpoint.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -29,13 +30,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HandleApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new HandleApi(httpClient, config, httpClientHandler);
try
{
......@@ -103,6 +107,7 @@ Retrieves all values of a handle by its PID.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -114,13 +119,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HandleApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new HandleApi(httpClient, config, httpClientHandler);
var prefix = "prefix_example"; // string | The prefix of the PID
var suffix = "suffix_example"; // string | The suffix of the PID
......@@ -203,6 +211,7 @@ Updates a handle.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -214,13 +223,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new HandleApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new HandleApi(httpClient, config, httpClientHandler);
var prefix = "prefix_example"; // string | The prefix of the PID
var suffix = "suffix_example"; // string | The suffix of the PID
var handleForUpdateDto = new HandleForUpdateDto?(); // HandleForUpdateDto? | The handle for updating. (optional)
......
docs/LanguageApi.md
View file @ b669f256
# Coscine.ApiClient.Core.Api.LanguageApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
All URIs are relative to *https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
......@@ -18,6 +18,7 @@ Responds with the HTTP methods allowed for the endpoint.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -29,13 +30,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new LanguageApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new LanguageApi(httpClient, config, httpClientHandler);
try
{
......@@ -103,6 +107,7 @@ Retrieves a language by ID.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -114,13 +119,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new LanguageApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new LanguageApi(httpClient, config, httpClientHandler);
var languageId = "languageId_example"; // Guid | The ID of the language.
try
......@@ -198,6 +206,7 @@ Retrieves all languages.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -209,13 +218,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new LanguageApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new LanguageApi(httpClient, config, httpClientHandler);
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
......
docs/LicenseApi.md
View file @ b669f256
# Coscine.ApiClient.Core.Api.LicenseApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
All URIs are relative to *https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
......@@ -18,6 +18,7 @@ Responds with the HTTP methods allowed for the endpoint.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -29,13 +30,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new LicenseApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new LicenseApi(httpClient, config, httpClientHandler);
try
{
......@@ -103,6 +107,7 @@ Retrieves a license with the specified ID.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -114,13 +119,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new LicenseApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new LicenseApi(httpClient, config, httpClientHandler);
var licenseId = "licenseId_example"; // Guid | The ID of the license.
try
......@@ -198,6 +206,7 @@ Retrieves all licenses.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -209,13 +218,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new LicenseApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new LicenseApi(httpClient, config, httpClientHandler);
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
......
docs/MaintenanceApi.md
View file @ b669f256
# Coscine.ApiClient.Core.Api.MaintenanceApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
All URIs are relative to *https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
......@@ -17,6 +17,7 @@ Responds with the HTTP methods allowed for the endpoint.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -28,13 +29,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new MaintenanceApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new MaintenanceApi(httpClient, config, httpClientHandler);
try
{
......@@ -102,6 +106,7 @@ Retrieves the current maintenance messages.
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
......@@ -113,13 +118,16 @@ namespace Example
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine";
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
var apiInstance = new MaintenanceApi(config);
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new MaintenanceApi(httpClient, config, httpClientHandler);
try
{
......
docs/NotificationApi.md 0 → 100644
View file @ b669f256
# Coscine.ApiClient.Core.Api.NotificationApi
All URIs are relative to *https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**ApiV2NotificationsOptions**](NotificationApi.md#apiv2notificationsoptions) | **OPTIONS** /api/v2/notifications | Responds with the HTTP methods allowed for the endpoint. |
| [**GetNotification**](NotificationApi.md#getnotification) | **GET** /api/v2/notifications/{notificationId} | Retrieves a notification by ID. |
| [**GetNotifications**](NotificationApi.md#getnotifications) | **GET** /api/v2/notifications | Retrieves all notifications. |
<a id="apiv2notificationsoptions"></a>
# **ApiV2NotificationsOptions**
> void ApiV2NotificationsOptions ()
Responds with the HTTP methods allowed for the endpoint.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class ApiV2NotificationsOptionsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new NotificationApi(httpClient, config, httpClientHandler);
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2NotificationsOptions();
}
catch (ApiException e)
{
Debug.Print("Exception when calling NotificationApi.ApiV2NotificationsOptions: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the ApiV2NotificationsOptionsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2NotificationsOptionsWithHttpInfo();
}
catch (ApiException e)
{
Debug.Print("Exception when calling NotificationApi.ApiV2NotificationsOptionsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
void (empty response body)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | OK | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a id="getnotification"></a>
# **GetNotification**
> NotificationDtoResponse GetNotification (Guid notificationId)
Retrieves a notification by ID.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class GetNotificationExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new NotificationApi(httpClient, config, httpClientHandler);
var notificationId = "notificationId_example"; // Guid | The ID of the notification.
try
{
// Retrieves a notification by ID.
NotificationDtoResponse result = apiInstance.GetNotification(notificationId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling NotificationApi.GetNotification: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetNotificationWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves a notification by ID.
ApiResponse<NotificationDtoResponse> response = apiInstance.GetNotificationWithHttpInfo(notificationId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling NotificationApi.GetNotificationWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **notificationId** | **Guid** | The ID of the notification. | |
### Return type
[**NotificationDtoResponse**](NotificationDtoResponse.md)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the notification. | - |
| **404** | Notification does not exist. | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a id="getnotifications"></a>
# **GetNotifications**
> NotificationDtoPagedResponse GetNotifications (int? pageNumber = null, int? pageSize = null, string? orderBy = null)
Retrieves all notifications.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class GetNotificationsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-hristov.web.vulcanus.otc.coscine.dev/coscine";
// Configure API key authorization: Bearer
config.AddApiKey("Authorization", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("Authorization", "Bearer");
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new NotificationApi(httpClient, config, httpClientHandler);
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
// Retrieves all notifications.
NotificationDtoPagedResponse result = apiInstance.GetNotifications(pageNumber, pageSize, orderBy);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling NotificationApi.GetNotifications: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetNotificationsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves all notifications.
ApiResponse<NotificationDtoPagedResponse> response = apiInstance.GetNotificationsWithHttpInfo(pageNumber, pageSize, orderBy);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling NotificationApi.GetNotificationsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **pageNumber** | **int?** | The desired page number. Should be greater than or equal to 1. Default is 1. | [optional] |
| **pageSize** | **int?** | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. | [optional] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
[**NotificationDtoPagedResponse**](NotificationDtoPagedResponse.md)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the notifications. | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
docs/NotificationDto.md 0 → 100644
View file @ b669f256
# Coscine.ApiClient.Core.Model.NotificationDto
Represents a minimal data transfer object (DTO) for a notification.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **Guid** | Unique identifier for the project notification. |
**Category** | **string** | category of the notification. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/NotificationDtoPagedResponse.md 0 → 100644
View file @ b669f256
# Coscine.ApiClient.Core.Model.NotificationDtoPagedResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**List&lt;NotificationDto&gt;**](NotificationDto.md) | | [optional]
**IsSuccess** | **bool** | | [optional] [readonly]
**StatusCode** | **int?** | | [optional]
**TraceId** | **string** | | [optional]
**Pagination** | [**Pagination**](Pagination.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)