Skip to content
Snippets Groups Projects
Commit 2d85717e authored by L. Ellenbeck's avatar L. Ellenbeck
Browse files

Merge branch 'Issue/2944-gdShenanigans' into 'main'

Update: New version and generation improvements supporting Linux systems using podman

See merge request !22
parents d6c69997 4323b618
Branches
Tags
1 merge request!22Update: New version and generation improvements supporting Linux systems using podman
Pipeline #1404093 passed
Showing
with 2114 additions and 6 deletions
......@@ -6,6 +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.8.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.CSharpClientCodegen
<a id="frameworks-supported"></a>
......@@ -84,7 +85,7 @@ namespace Example
{
Configuration config = new Configuration();
config.BasePath = "http://localhost:7206/coscine";
config.BasePath = "https://coscine-api-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
......@@ -112,7 +113,7 @@ namespace Example
<a id="documentation-for-api-endpoints"></a>
## Documentation for API Endpoints
All URIs are relative to *http://localhost:7206/coscine*
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
......@@ -173,8 +174,6 @@ Class | Method | HTTP request | Description
*ProjectMemberApi* | [**GetMembership**](docs/ProjectMemberApi.md#getmembership) | **GET** /api/v2/projects/{projectId}/members/{membershipId} | Retrieves a project membership for a specified project.
*ProjectMemberApi* | [**GetMemberships**](docs/ProjectMemberApi.md#getmemberships) | **GET** /api/v2/projects/{projectId}/members | Retrieves all project memberships for a specified project.
*ProjectMemberApi* | [**UpdateMembership**](docs/ProjectMemberApi.md#updatemembership) | **PUT** /api/v2/projects/{projectId}/members/{membershipId} | Updates a project membership for a specified project.
*ProjectPublicationRequestApi* | [**ApiV2ProjectsProjectIdPublicationsRequestsOptions**](docs/ProjectPublicationRequestApi.md#apiv2projectsprojectidpublicationsrequestsoptions) | **OPTIONS** /api/v2/projects/{projectId}/publications/requests | Responds with the HTTP methods allowed for the endpoint.
*ProjectPublicationRequestApi* | [**CreatePublicationRequest**](docs/ProjectPublicationRequestApi.md#createpublicationrequest) | **POST** /api/v2/projects/{projectId}/publications/requests | Creates a new publication request.
*ProjectQuotaApi* | [**ApiV2ProjectsProjectIdQuotasOptions**](docs/ProjectQuotaApi.md#apiv2projectsprojectidquotasoptions) | **OPTIONS** /api/v2/projects/{projectId}/quotas | Responds with the HTTP methods allowed for the endpoint.
*ProjectQuotaApi* | [**GetProjectQuota**](docs/ProjectQuotaApi.md#getprojectquota) | **GET** /api/v2/projects/{projectId}/quotas/{resourceTypeId} | Retrieves a project quota for a specified project and resource type.
*ProjectQuotaApi* | [**GetProjectQuotas**](docs/ProjectQuotaApi.md#getprojectquotas) | **GET** /api/v2/projects/{projectId}/quotas | Retrieves all project quotas for a specified project.
......@@ -351,8 +350,6 @@ Class | Method | HTTP request | Description
- [Model.PublicUserDto](docs/PublicUserDto.md)
- [Model.PublicUserDtoIEnumerableResponse](docs/PublicUserDtoIEnumerableResponse.md)
- [Model.PublicationAdvisoryServiceDto](docs/PublicationAdvisoryServiceDto.md)
- [Model.PublicationRequestForCreationDto](docs/PublicationRequestForCreationDto.md)
- [Model.PublicationRequestForCreationDtoResponse](docs/PublicationRequestForCreationDtoResponse.md)
- [Model.QuotaDto](docs/QuotaDto.md)
- [Model.QuotaForManipulationDto](docs/QuotaForManipulationDto.md)
- [Model.QuotaUnit](docs/QuotaUnit.md)
......
# Coscine.ApiClient.Core.Model.AcceptedLanguage
Accepted languages by the API.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.ActivityLogDto
Represents a data transfer object (DTO) for an activity log.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **Guid** | | [optional]
**ApiPath** | **string** | | [optional]
**HttpAction** | **string** | | [optional]
**ControllerName** | **string** | | [optional]
**ActionName** | **string** | | [optional]
**UserId** | **Guid** | | [optional]
**ActivityTimestamp** | **DateTime** | | [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)
# Coscine.ApiClient.Core.Model.ActivityLogDtoPagedResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**List&lt;ActivityLogDto&gt;**](ActivityLogDto.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)
This diff is collapsed.
# Coscine.ApiClient.Core.Model.ApiTokenDto
Represents an API token used for authentication.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **Guid** | The unique identifier of the API token. | [optional]
**Name** | **string** | The name associated with the API token. | [optional]
**CreationDate** | **DateTime** | The date when the API token was created. | [optional]
**ExpiryDate** | **DateTime** | The expiry date of the API token. | [optional]
**Token** | **string** | The actual token used for authentication. | [optional]
**Owner** | [**UserMinimalDto**](UserMinimalDto.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)
# Coscine.ApiClient.Core.Model.ApiTokenDtoPagedResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**List&lt;ApiTokenDto&gt;**](ApiTokenDto.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)
# Coscine.ApiClient.Core.Model.ApiTokenDtoResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**ApiTokenDto**](ApiTokenDto.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)
# Coscine.ApiClient.Core.Model.ApiTokenForCreationDto
Data transfer object (DTO) representing the creation of an API token.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **string** | Gets or sets the name of the API token. |
**ExpiresInDays** | **int** | Gets or sets the expiration duration of the token in days. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Api.ApplicationProfileApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**ApiV2ApplicationProfilesOptions**](ApplicationProfileApi.md#apiv2applicationprofilesoptions) | **OPTIONS** /api/v2/application-profiles | Responds with the HTTP methods allowed for the endpoint. |
| [**CreateApplicationProfileRequest**](ApplicationProfileApi.md#createapplicationprofilerequest) | **POST** /api/v2/application-profiles/requests | Submits a request to create a new application profile. |
| [**GetApplicationProfile**](ApplicationProfileApi.md#getapplicationprofile) | **GET** /api/v2/application-profiles/profiles/{profile} | Retrieves an application profile by its URI. |
| [**GetApplicationProfiles**](ApplicationProfileApi.md#getapplicationprofiles) | **GET** /api/v2/application-profiles/profiles | Retrieves all application profiles. |
| [**GetRawApplicationProfile**](ApplicationProfileApi.md#getrawapplicationprofile) | **GET** /api/v2/application-profiles/profiles/{profile}/raw | Retrieves the &#x60;raw&#x60; application profile definition by its URI. |
<a id="apiv2applicationprofilesoptions"></a>
# **ApiV2ApplicationProfilesOptions**
> void ApiV2ApplicationProfilesOptions ()
Responds with the HTTP methods allowed for the endpoint.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class ApiV2ApplicationProfilesOptionsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-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);
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2ApplicationProfilesOptions();
}
catch (ApiException e)
{
Debug.Print("Exception when calling ApplicationProfileApi.ApiV2ApplicationProfilesOptions: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the ApiV2ApplicationProfilesOptionsWithHttpInfo 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.ApiV2ApplicationProfilesOptionsWithHttpInfo();
}
catch (ApiException e)
{
Debug.Print("Exception when calling ApplicationProfileApi.ApiV2ApplicationProfilesOptionsWithHttpInfo: " + 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** | Success | - |
[[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="createapplicationprofilerequest"></a>
# **CreateApplicationProfileRequest**
> ApplicationProfileForCreationDtoResponse CreateApplicationProfileRequest (ApplicationProfileForCreationDto? applicationProfileForCreationDto = null)
Submits a request to create a new application profile.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class CreateApplicationProfileRequestExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-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);
var applicationProfileForCreationDto = new ApplicationProfileForCreationDto?(); // ApplicationProfileForCreationDto? | The details required to create a new application profile. (optional)
try
{
// Submits a request to create a new application profile.
ApplicationProfileForCreationDtoResponse result = apiInstance.CreateApplicationProfileRequest(applicationProfileForCreationDto);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ApplicationProfileApi.CreateApplicationProfileRequest: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the CreateApplicationProfileRequestWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Submits a request to create a new application profile.
ApiResponse<ApplicationProfileForCreationDtoResponse> response = apiInstance.CreateApplicationProfileRequestWithHttpInfo(applicationProfileForCreationDto);
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 ApplicationProfileApi.CreateApplicationProfileRequestWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **applicationProfileForCreationDto** | [**ApplicationProfileForCreationDto?**](ApplicationProfileForCreationDto?.md) | The details required to create a new application profile. | [optional] |
### Return type
[**ApplicationProfileForCreationDtoResponse**](ApplicationProfileForCreationDtoResponse.md)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: application/json, text/json, application/*+json
- **Accept**: application/json, text/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** | Application profile request created. | - |
| **403** | User is missing authorization requirements. | - |
| **400** | Provided input has a bad format. | - |
| **404** | Provided input refers to entries that do not exist or have been deleted. | - |
[[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="getapplicationprofile"></a>
# **GetApplicationProfile**
> ApplicationProfileDtoResponse GetApplicationProfile (string profile, RdfFormat? format = null, AcceptedLanguage? acceptLanguage = null)
Retrieves an application profile by its URI.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class GetApplicationProfileExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-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);
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)
try
{
// Retrieves an application profile by its URI.
ApplicationProfileDtoResponse result = apiInstance.GetApplicationProfile(profile, format, acceptLanguage);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ApplicationProfileApi.GetApplicationProfile: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetApplicationProfileWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves an application profile by its URI.
ApiResponse<ApplicationProfileDtoResponse> response = apiInstance.GetApplicationProfileWithHttpInfo(profile, format, acceptLanguage);
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 ApplicationProfileApi.GetApplicationProfileWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **profile** | **string** | The URI of the application profile to retrieve. | |
| **format** | [**RdfFormat?**](RdfFormat?.md) | The desired data format for the returned application profile. | [optional] |
| **acceptLanguage** | [**AcceptedLanguage?**](AcceptedLanguage?.md) | The preferred language for the application profile data. | [optional] |
### Return type
[**ApplicationProfileDtoResponse**](ApplicationProfileDtoResponse.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 application profile. | - |
| **404** | Application profile 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="getapplicationprofiles"></a>
# **GetApplicationProfiles**
> ApplicationProfileDtoPagedResponse GetApplicationProfiles (string? searchTerm = null, AcceptedLanguage? language = null, bool? modules = null, int? pageNumber = null, int? pageSize = null, string? orderBy = null)
Retrieves all application profiles.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class GetApplicationProfilesExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-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);
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)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
// Retrieves all application profiles.
ApplicationProfileDtoPagedResponse result = apiInstance.GetApplicationProfiles(searchTerm, language, modules, pageNumber, pageSize, orderBy);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ApplicationProfileApi.GetApplicationProfiles: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetApplicationProfilesWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves all application profiles.
ApiResponse<ApplicationProfileDtoPagedResponse> response = apiInstance.GetApplicationProfilesWithHttpInfo(searchTerm, language, modules, 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 ApplicationProfileApi.GetApplicationProfilesWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **searchTerm** | **string?** | Gets or sets the search term used to filter application profiles. | [optional] |
| **language** | [**AcceptedLanguage?**](AcceptedLanguage?.md) | Gets or sets the language for which the application profiles are requested. | [optional] |
| **modules** | **bool?** | Gets or sets a value indicating whether to include modules in the application profiles. | [optional] |
| **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 a 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
[**ApplicationProfileDtoPagedResponse**](ApplicationProfileDtoPagedResponse.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 application profiles. | - |
[[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="getrawapplicationprofile"></a>
# **GetRawApplicationProfile**
> string GetRawApplicationProfile (string profile)
Retrieves the `raw` application profile definition by its URI.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class GetRawApplicationProfileExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-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);
var profile = "profile_example"; // string | The URI of the application profile.
try
{
// Retrieves the `raw` application profile definition by its URI.
string result = apiInstance.GetRawApplicationProfile(profile);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ApplicationProfileApi.GetRawApplicationProfile: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetRawApplicationProfileWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves the `raw` application profile definition by its URI.
ApiResponse<string> response = apiInstance.GetRawApplicationProfileWithHttpInfo(profile);
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 ApplicationProfileApi.GetRawApplicationProfileWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **profile** | **string** | The URI of the application profile. | |
### Return type
**string**
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/turtle, application/ld+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the raw application profile. | - |
| **404** | Application profile 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)
# Coscine.ApiClient.Core.Model.ApplicationProfileDto
Represents an application profile data transfer object.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Uri** | **string** | The URI associated with the application profile. | [optional]
**DisplayName** | **string** | The display name for the application profile. | [optional]
**Description** | **string** | The description of the application profile. | [optional]
**Definition** | [**RdfDefinitionDto**](RdfDefinitionDto.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)
# Coscine.ApiClient.Core.Model.ApplicationProfileDtoPagedResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**List&lt;ApplicationProfileDto&gt;**](ApplicationProfileDto.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)
# Coscine.ApiClient.Core.Model.ApplicationProfileDtoResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**ApplicationProfileDto**](ApplicationProfileDto.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)
# Coscine.ApiClient.Core.Model.ApplicationProfileForCreationDto
Data transfer object (DTO) representing the creation of an application profile.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **string** | Gets or initializes the name of the application profile. |
**Uri** | **string** | Gets or initializes the URI of the application profile. |
**Definition** | [**RdfDefinitionForManipulationDto**](RdfDefinitionForManipulationDto.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)
# Coscine.ApiClient.Core.Model.ApplicationProfileForCreationDtoResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**ApplicationProfileForCreationDto**](ApplicationProfileForCreationDto.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)
# Coscine.ApiClient.Core.Model.ApplicationProfileForResourceCreationDto
Data transfer object (DTO) representing the creation of an application profile for a resource.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Uri** | **string** | Gets or initializes the URI of the resource for the application profile. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.ApplicationProfileMinimalDto
Represents a minimalistic application profile data transfer object.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Uri** | **string** | The URI associated with the application profile. | [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)
# Coscine.ApiClient.Core.Api.BlobApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**ApiV2ProjectsProjectIdResourcesResourceIdBlobsOptions**](BlobApi.md#apiv2projectsprojectidresourcesresourceidblobsoptions) | **OPTIONS** /api/v2/projects/{projectId}/resources/{resourceId}/blobs | Responds with the HTTP methods allowed for the endpoint. |
| [**CreateBlob**](BlobApi.md#createblob) | **POST** /api/v2/projects/{projectId}/resources/{resourceId}/blobs/{key} | Creates a new blob for a resource. |
| [**DeleteBlob**](BlobApi.md#deleteblob) | **DELETE** /api/v2/projects/{projectId}/resources/{resourceId}/blobs/{key} | Deletes a blob from a resource. |
| [**GetBlob**](BlobApi.md#getblob) | **GET** /api/v2/projects/{projectId}/resources/{resourceId}/blobs/{key} | Download a blob from a resource. |
| [**UpdateBlob**](BlobApi.md#updateblob) | **PUT** /api/v2/projects/{projectId}/resources/{resourceId}/blobs/{key} | Updates an existing blob of a resource. |
<a id="apiv2projectsprojectidresourcesresourceidblobsoptions"></a>
# **ApiV2ProjectsProjectIdResourcesResourceIdBlobsOptions**
> void ApiV2ProjectsProjectIdResourcesResourceIdBlobsOptions (string projectId, string resourceId)
Responds with the HTTP methods allowed for the endpoint.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class ApiV2ProjectsProjectIdResourcesResourceIdBlobsOptionsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-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);
var projectId = "projectId_example"; // string |
var resourceId = "resourceId_example"; // string |
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2ProjectsProjectIdResourcesResourceIdBlobsOptions(projectId, resourceId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling BlobApi.ApiV2ProjectsProjectIdResourcesResourceIdBlobsOptions: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the ApiV2ProjectsProjectIdResourcesResourceIdBlobsOptionsWithHttpInfo 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.ApiV2ProjectsProjectIdResourcesResourceIdBlobsOptionsWithHttpInfo(projectId, resourceId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling BlobApi.ApiV2ProjectsProjectIdResourcesResourceIdBlobsOptionsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **projectId** | **string** | | |
| **resourceId** | **string** | | |
### 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** | Success | - |
[[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="createblob"></a>
# **CreateBlob**
> void CreateBlob (string projectId, Guid resourceId, string key, System.IO.Stream? file = null)
Creates a new blob for a resource.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class CreateBlobExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-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);
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)
try
{
// Creates a new blob for a resource.
apiInstance.CreateBlob(projectId, resourceId, key, file);
}
catch (ApiException e)
{
Debug.Print("Exception when calling BlobApi.CreateBlob: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the CreateBlobWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Creates a new blob for a resource.
apiInstance.CreateBlobWithHttpInfo(projectId, resourceId, key, file);
}
catch (ApiException e)
{
Debug.Print("Exception when calling BlobApi.CreateBlobWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **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] |
### Return type
void (empty response body)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** | Blob created. | - |
| **400** | Blob already exists. | - |
| **415** | Blob is not of the type \&quot;multipart/form-data\&quot; | - |
[[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="deleteblob"></a>
# **DeleteBlob**
> void DeleteBlob (string projectId, Guid resourceId, string key)
Deletes a blob from a resource.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class DeleteBlobExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-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);
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.
try
{
// Deletes a blob from a resource.
apiInstance.DeleteBlob(projectId, resourceId, key);
}
catch (ApiException e)
{
Debug.Print("Exception when calling BlobApi.DeleteBlob: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the DeleteBlobWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Deletes a blob from a resource.
apiInstance.DeleteBlobWithHttpInfo(projectId, resourceId, key);
}
catch (ApiException e)
{
Debug.Print("Exception when calling BlobApi.DeleteBlobWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **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 delete. | |
### 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 |
|-------------|-------------|------------------|
| **204** | Blob deleted. | - |
| **404** | Blob 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="getblob"></a>
# **GetBlob**
> System.IO.Stream GetBlob (string projectId, Guid resourceId, string key)
Download a blob from a resource.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class GetBlobExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-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);
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.
try
{
// Download a blob from a resource.
System.IO.Stream result = apiInstance.GetBlob(projectId, resourceId, key);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling BlobApi.GetBlob: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetBlobWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Download a blob from a resource.
ApiResponse<System.IO.Stream> response = apiInstance.GetBlobWithHttpInfo(projectId, resourceId, key);
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 BlobApi.GetBlobWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **projectId** | **string** | The identifier or slug of the project. | |
| **resourceId** | **Guid** | The identifier of the resource. | |
| **key** | **string** | The key associated with the blob. | |
### Return type
**System.IO.Stream**
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/octet-stream
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns the blob. | - |
| **404** | Blob 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="updateblob"></a>
# **UpdateBlob**
> void UpdateBlob (string projectId, Guid resourceId, string key, System.IO.Stream? file = null)
Updates an existing blob of a resource.
### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using Coscine.ApiClient.Core.Api;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Model;
namespace Example
{
public class UpdateBlobExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://coscine-api-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);
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)
try
{
// Updates an existing blob of a resource.
apiInstance.UpdateBlob(projectId, resourceId, key, file);
}
catch (ApiException e)
{
Debug.Print("Exception when calling BlobApi.UpdateBlob: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the UpdateBlobWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Updates an existing blob of a resource.
apiInstance.UpdateBlobWithHttpInfo(projectId, resourceId, key, file);
}
catch (ApiException e)
{
Debug.Print("Exception when calling BlobApi.UpdateBlobWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **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] |
### Return type
void (empty response body)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** | Blob updated. | - |
| **400** | Blob already exists. | - |
| **415** | Blob is not of the type \&quot;multipart/form-data\&quot; | - |
[[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)
# Coscine.ApiClient.Core.Model.CoscineHttpMethod
An enumeration representing the supported HTTP verbs.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
# Coscine.ApiClient.Core.Model.DeployedGraphDto
Represents a Data Transfer Object (DTO) for deployed graph details.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Uri** | **string** | Graph URI and identifier. | [optional]
**FileHashes** | **List&lt;string&gt;** | Collection of file hashes associated with the graph. | [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)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment