Skip to content
Snippets Groups Projects
Commit 5d8cefb0 authored by Petar Hristov's avatar Petar Hristov :speech_balloon: Committed by Sandra Westerhoff
Browse files

New: Generated client

parent 640175cd
No related branches found
No related tags found
3 merge requests!26Chore: 1.9.2,!25Dev,!23New: Generated client
Showing
with 1217 additions and 7 deletions
# Development container for dotnet
FROM mcr.microsoft.com/devcontainers/dotnet:8.0 as develop
USER vscode
\ No newline at end of file
version: "3.9"
services:
app:
build:
target: develop
user: vscode
userns_mode: keep-id:uid=1000,gid=1000
environment:
SSH_AUTH_SOCK: /.ssh/ssh-agent.sock
command: /bin/sh -c "while sleep 2s; do :; done"
volumes:
- ..:/workspace/api-client:cached
- ./.vscode-server:/home/vscode/.vscode-server/:cached
- ${SSH_AUTH_SOCK}:/.ssh/ssh-agent.sock
networks:
- default
networks:
default:
driver: bridge
{
"name": "C# API-Client Devcontainer",
"dockerComposeFile": [
"compose.yml"
],
"service": "app",
"workspaceFolder": "/workspace/api-client",
"updateRemoteUserUID": false,
"remoteUser": "vscode",
"containerUser": "vscode",
"customizations": {
"vscode": {
"settings": {
"NugetGallery.sources": [
"{\"name\":\"nuget.org\",\"url\":\"https://api.nuget.org/v3/index.json\"}",
"{\"name\":\"api-client\",\"url\":\"https://git.rwth-aachen.de/api/v4/projects/88930/packages/nuget/index.json\"}"
],
"nuget.includePrereleasePackageVersions": true
},
"extensions": [
"ms-dotnettools.csdevkit",
"ms-azuretools.vscode-docker",
"ms-dotnettools.csharp",
"mhutchie.git-graph",
"mutantdino.resourcemonitor",
"patcx.vscode-nuget-gallery"
]
}
},
"forwardPorts": []
}
\ No newline at end of file
/.devcontainer/.vscode-server/*
!/.devcontainer/.vscode-server/.gitkeep
/.devcontainer/.data/*
!/.devcontainer/.data/.gitkeep
.logs/
Output/*
internallog.txt
## Ignore the secrets settings
appsettings.Development.json
appsettings.Staging.json
appsettings.Production.json
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
......@@ -24,6 +39,7 @@ bld/
[Bb]in/
[Oo]bj/
[Ll]og/
[Pp]roperties/
# Visual Studio 2015 cache/options directory
.vs/
......@@ -271,4 +287,3 @@ dist/
# Dotnet Tool Manifest
.config/*
/openapi-generator-cli.jar
{
"workbench.colorCustomizations": {
"activityBar.background": "#213647",
"activityBar.foreground": "#F7F7F7",
"activityBar.inactiveForeground": "#B3C7D6",
"activityBar.activeBorder": "#416B8B",
"activityBarBadge.background": "#B3C7D6",
"activityBarBadge.foreground": "#416B8B"
},
}
\ No newline at end of file
......@@ -174,6 +174,8 @@ 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.
......@@ -216,6 +218,14 @@ Class | Method | HTTP request | Description
*SelfApiTokenApi* | [**GetAllApiTokens**](docs/SelfApiTokenApi.md#getallapitokens) | **GET** /api/v2/self/api-tokens | Retrieves all API tokens for the current authenticated user.
*SelfApiTokenApi* | [**GetApiToken**](docs/SelfApiTokenApi.md#getapitoken) | **GET** /api/v2/self/api-tokens/{apiTokenId} | Retrieves an API token for the current authenticated user.
*SelfApiTokenApi* | [**RevokeToken**](docs/SelfApiTokenApi.md#revoketoken) | **DELETE** /api/v2/self/api-tokens/{apiTokenId} | Revokes an API token for the current authenticated user.
*SelfSessionApi* | [**ApiV2SelfSessionLogoutPost**](docs/SelfSessionApi.md#apiv2selfsessionlogoutpost) | **POST** /api/v2/self/session/logout | Initiate the Log out workflow.
*SelfSessionApi* | [**ApiV2SelfSessionOptions**](docs/SelfSessionApi.md#apiv2selfsessionoptions) | **OPTIONS** /api/v2/self/session | Responds with the HTTP methods allowed for the endpoint.
*SelfSessionApi* | [**Login**](docs/SelfSessionApi.md#login) | **GET** /api/v2/self/session | Initiate the login workflow with the default (NFDI4Ing AAI) provider.
*SelfSessionApi* | [**LoginWithProvider**](docs/SelfSessionApi.md#loginwithprovider) | **GET** /api/v2/self/session/{externalAuthenticatorId} | Initiate the login workflow with specific provider.
*SelfSessionApi* | [**Merge**](docs/SelfSessionApi.md#merge) | **GET** /api/v2/self/session/merge/{externalAuthenticatorId} | Initiate the merge workflow with specific provider.
*SystemStatusApi* | [**ApiV2SystemStatusOptions**](docs/SystemStatusApi.md#apiv2systemstatusoptions) | **OPTIONS** /api/v2/system/status | Responds with the HTTP methods allowed for the endpoint.
*SystemStatusApi* | [**GetInternalMessages**](docs/SystemStatusApi.md#getinternalmessages) | **GET** /api/v2/system/status/internal | Retrieves the internal messages.
*SystemStatusApi* | [**GetNocMessages**](docs/SystemStatusApi.md#getnocmessages) | **GET** /api/v2/system/status/noc | Retrieves the NOC messages.
*TitleApi* | [**ApiV2TitlesOptions**](docs/TitleApi.md#apiv2titlesoptions) | **OPTIONS** /api/v2/titles | Responds with the HTTP methods allowed for the endpoint.
*TitleApi* | [**GetTitle**](docs/TitleApi.md#gettitle) | **GET** /api/v2/titles/{titleId} | Retrieves a title by ID.
*TitleApi* | [**GetTitles**](docs/TitleApi.md#gettitles) | **GET** /api/v2/titles | Retrieves all titles.
......@@ -301,6 +311,9 @@ Class | Method | HTTP request | Description
- [Model.LicenseForResourceManipulationDto](docs/LicenseForResourceManipulationDto.md)
- [Model.MaintenanceDto](docs/MaintenanceDto.md)
- [Model.MaintenanceDtoPagedResponse](docs/MaintenanceDtoPagedResponse.md)
- [Model.MessageDto](docs/MessageDto.md)
- [Model.MessageDtoPagedResponse](docs/MessageDtoPagedResponse.md)
- [Model.MessageType](docs/MessageType.md)
- [Model.MetadataTreeDto](docs/MetadataTreeDto.md)
- [Model.MetadataTreeDtoPagedResponse](docs/MetadataTreeDtoPagedResponse.md)
- [Model.MetadataTreeDtoResponse](docs/MetadataTreeDtoResponse.md)
......@@ -350,6 +363,8 @@ 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.MessageDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **string** | ID of the message. | [optional]
**Body** | **Dictionary<string, string>** | Message body in multiple languages as key-value pairs. The key is the ISO 639-1 Alpha-2 two-letter language code, and the value is the message in that language. | [optional]
**Type** | **MessageType** | | [optional]
**Title** | **string** | Title of the message. | [optional]
**Href** | **string** | URL related to the message. | [optional]
**StartDate** | **DateTime?** | Start date of the message. | [optional]
**EndDate** | **DateTime?** | End date of the message. | [optional]
[[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.MessageDtoPagedResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**List<MessageDto>**](MessageDto.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.MessageType
Defines the various types of messages.
## 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)
......@@ -189,7 +189,7 @@ catch (ApiException e)
<a id="getorganizations"></a>
# **GetOrganizations**
> OrganizationDtoPagedResponse GetOrganizations (string? searchTerm = null, bool? filterByPublicationService = null, int? pageNumber = null, int? pageSize = null, string? orderBy = null)
> OrganizationDtoPagedResponse GetOrganizations (string? searchTerm = null, AcceptedLanguage? language = null, bool? filterByPublicationService = null, int? pageNumber = null, int? pageSize = null, string? orderBy = null)
Retrieves all organizations.
......@@ -216,6 +216,7 @@ namespace Example
var apiInstance = new OrganizationApi(config);
var searchTerm = "searchTerm_example"; // string? | Gets or sets the search term used to filter organizations. (optional)
var language = new AcceptedLanguage?(); // AcceptedLanguage? | Language of name or text (dataPublicationService) (optional)
var filterByPublicationService = true; // bool? | Gets or sets the option to find only organizations having the publication service set. (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
......@@ -224,7 +225,7 @@ namespace Example
try
{
// Retrieves all organizations.
OrganizationDtoPagedResponse result = apiInstance.GetOrganizations(searchTerm, filterByPublicationService, pageNumber, pageSize, orderBy);
OrganizationDtoPagedResponse result = apiInstance.GetOrganizations(searchTerm, language, filterByPublicationService, pageNumber, pageSize, orderBy);
Debug.WriteLine(result);
}
catch (ApiException e)
......@@ -245,7 +246,7 @@ This returns an ApiResponse object which contains the response data, status code
try
{
// Retrieves all organizations.
ApiResponse<OrganizationDtoPagedResponse> response = apiInstance.GetOrganizationsWithHttpInfo(searchTerm, filterByPublicationService, pageNumber, pageSize, orderBy);
ApiResponse<OrganizationDtoPagedResponse> response = apiInstance.GetOrganizationsWithHttpInfo(searchTerm, language, filterByPublicationService, pageNumber, pageSize, orderBy);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
......@@ -263,6 +264,7 @@ catch (ApiException e)
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **searchTerm** | **string?** | Gets or sets the search term used to filter organizations. | [optional] |
| **language** | [**AcceptedLanguage?**](AcceptedLanguage?.md) | Language of name or text (dataPublicationService) | [optional] |
| **filterByPublicationService** | **bool?** | Gets or sets the option to find only organizations having the publication service set. | [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] |
......
# Coscine.ApiClient.Core.Api.ProjectPublicationRequestApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**ApiV2ProjectsProjectIdPublicationsRequestsOptions**](ProjectPublicationRequestApi.md#apiv2projectsprojectidpublicationsrequestsoptions) | **OPTIONS** /api/v2/projects/{projectId}/publications/requests | Responds with the HTTP methods allowed for the endpoint. |
| [**CreatePublicationRequest**](ProjectPublicationRequestApi.md#createpublicationrequest) | **POST** /api/v2/projects/{projectId}/publications/requests | Creates a new publication request. |
<a id="apiv2projectsprojectidpublicationsrequestsoptions"></a>
# **ApiV2ProjectsProjectIdPublicationsRequestsOptions**
> void ApiV2ProjectsProjectIdPublicationsRequestsOptions (string projectId)
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 ApiV2ProjectsProjectIdPublicationsRequestsOptionsExample
{
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 ProjectPublicationRequestApi(config);
var projectId = "projectId_example"; // string |
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2ProjectsProjectIdPublicationsRequestsOptions(projectId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ProjectPublicationRequestApi.ApiV2ProjectsProjectIdPublicationsRequestsOptions: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the ApiV2ProjectsProjectIdPublicationsRequestsOptionsWithHttpInfo 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.ApiV2ProjectsProjectIdPublicationsRequestsOptionsWithHttpInfo(projectId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ProjectPublicationRequestApi.ApiV2ProjectsProjectIdPublicationsRequestsOptionsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **projectId** | **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="createpublicationrequest"></a>
# **CreatePublicationRequest**
> PublicationRequestForCreationDtoResponse CreatePublicationRequest (string projectId, PublicationRequestForCreationDto? publicationRequestForCreationDto = null)
Creates a new publication request.
### 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 CreatePublicationRequestExample
{
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 ProjectPublicationRequestApi(config);
var projectId = "projectId_example"; // string | The Id or slug of the project.
var publicationRequestForCreationDto = new PublicationRequestForCreationDto?(); // PublicationRequestForCreationDto? | The publication request data for creation. (optional)
try
{
// Creates a new publication request.
PublicationRequestForCreationDtoResponse result = apiInstance.CreatePublicationRequest(projectId, publicationRequestForCreationDto);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ProjectPublicationRequestApi.CreatePublicationRequest: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the CreatePublicationRequestWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Creates a new publication request.
ApiResponse<PublicationRequestForCreationDtoResponse> response = apiInstance.CreatePublicationRequestWithHttpInfo(projectId, publicationRequestForCreationDto);
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 ProjectPublicationRequestApi.CreatePublicationRequestWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **projectId** | **string** | The Id or slug of the project. | |
| **publicationRequestForCreationDto** | [**PublicationRequestForCreationDto?**](PublicationRequestForCreationDto?.md) | The publication request data for creation. | [optional] |
### Return type
[**PublicationRequestForCreationDtoResponse**](PublicationRequestForCreationDtoResponse.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** | Publication 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)
......@@ -7,6 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**DisplayName** | **string** | The data publication service&#39;s display name. |
**Email** | **string** | The data publication service&#39;s email address. |
**Text** | **string** | The data publication service&#39;s info text. | [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.PublicationRequestForCreationDto
Data transfer object (DTO) representing the creation of a publication request.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**DataPublicationServiceRorId** | **string** | The data publication service&#39;s ror id. |
**ResourceIds** | **List&lt;Guid&gt;** | The resource guids. |
**Message** | **string** | A message of the requester. | [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.PublicationRequestForCreationDtoResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Data** | [**PublicationRequestForCreationDto**](PublicationRequestForCreationDto.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.Api.SelfSessionApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**ApiV2SelfSessionLogoutPost**](SelfSessionApi.md#apiv2selfsessionlogoutpost) | **POST** /api/v2/self/session/logout | Initiate the Log out workflow. |
| [**ApiV2SelfSessionOptions**](SelfSessionApi.md#apiv2selfsessionoptions) | **OPTIONS** /api/v2/self/session | Responds with the HTTP methods allowed for the endpoint. |
| [**Login**](SelfSessionApi.md#login) | **GET** /api/v2/self/session | Initiate the login workflow with the default (NFDI4Ing AAI) provider. |
| [**LoginWithProvider**](SelfSessionApi.md#loginwithprovider) | **GET** /api/v2/self/session/{externalAuthenticatorId} | Initiate the login workflow with specific provider. |
| [**Merge**](SelfSessionApi.md#merge) | **GET** /api/v2/self/session/merge/{externalAuthenticatorId} | Initiate the merge workflow with specific provider. |
<a id="apiv2selfsessionlogoutpost"></a>
# **ApiV2SelfSessionLogoutPost**
> void ApiV2SelfSessionLogoutPost ()
Initiate the Log out workflow.
### 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 ApiV2SelfSessionLogoutPostExample
{
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 SelfSessionApi(config);
try
{
// Initiate the Log out workflow.
apiInstance.ApiV2SelfSessionLogoutPost();
}
catch (ApiException e)
{
Debug.Print("Exception when calling SelfSessionApi.ApiV2SelfSessionLogoutPost: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the ApiV2SelfSessionLogoutPostWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Initiate the Log out workflow.
apiInstance.ApiV2SelfSessionLogoutPostWithHttpInfo();
}
catch (ApiException e)
{
Debug.Print("Exception when calling SelfSessionApi.ApiV2SelfSessionLogoutPostWithHttpInfo: " + 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="apiv2selfsessionoptions"></a>
# **ApiV2SelfSessionOptions**
> void ApiV2SelfSessionOptions ()
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 ApiV2SelfSessionOptionsExample
{
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 SelfSessionApi(config);
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2SelfSessionOptions();
}
catch (ApiException e)
{
Debug.Print("Exception when calling SelfSessionApi.ApiV2SelfSessionOptions: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the ApiV2SelfSessionOptionsWithHttpInfo 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.ApiV2SelfSessionOptionsWithHttpInfo();
}
catch (ApiException e)
{
Debug.Print("Exception when calling SelfSessionApi.ApiV2SelfSessionOptionsWithHttpInfo: " + 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="login"></a>
# **Login**
> void Login ()
Initiate the login workflow with the default (NFDI4Ing AAI) provider.
### 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 LoginExample
{
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 SelfSessionApi(config);
try
{
// Initiate the login workflow with the default (NFDI4Ing AAI) provider.
apiInstance.Login();
}
catch (ApiException e)
{
Debug.Print("Exception when calling SelfSessionApi.Login: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the LoginWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Initiate the login workflow with the default (NFDI4Ing AAI) provider.
apiInstance.LoginWithHttpInfo();
}
catch (ApiException e)
{
Debug.Print("Exception when calling SelfSessionApi.LoginWithHttpInfo: " + 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="loginwithprovider"></a>
# **LoginWithProvider**
> void LoginWithProvider (Guid externalAuthenticatorId)
Initiate the login workflow with specific provider.
### 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 LoginWithProviderExample
{
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 SelfSessionApi(config);
var externalAuthenticatorId = "externalAuthenticatorId_example"; // Guid |
try
{
// Initiate the login workflow with specific provider.
apiInstance.LoginWithProvider(externalAuthenticatorId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling SelfSessionApi.LoginWithProvider: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the LoginWithProviderWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Initiate the login workflow with specific provider.
apiInstance.LoginWithProviderWithHttpInfo(externalAuthenticatorId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling SelfSessionApi.LoginWithProviderWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **externalAuthenticatorId** | **Guid** | | |
### 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="merge"></a>
# **Merge**
> void Merge (Guid externalAuthenticatorId)
Initiate the merge workflow with specific provider.
### 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 MergeExample
{
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 SelfSessionApi(config);
var externalAuthenticatorId = "externalAuthenticatorId_example"; // Guid |
try
{
// Initiate the merge workflow with specific provider.
apiInstance.Merge(externalAuthenticatorId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling SelfSessionApi.Merge: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the MergeWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Initiate the merge workflow with specific provider.
apiInstance.MergeWithHttpInfo(externalAuthenticatorId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling SelfSessionApi.MergeWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **externalAuthenticatorId** | **Guid** | | |
### 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)
# Coscine.ApiClient.Core.Api.SystemStatusApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**ApiV2SystemStatusOptions**](SystemStatusApi.md#apiv2systemstatusoptions) | **OPTIONS** /api/v2/system/status | Responds with the HTTP methods allowed for the endpoint. |
| [**GetInternalMessages**](SystemStatusApi.md#getinternalmessages) | **GET** /api/v2/system/status/internal | Retrieves the internal messages. |
| [**GetNocMessages**](SystemStatusApi.md#getnocmessages) | **GET** /api/v2/system/status/noc | Retrieves the NOC messages. |
<a id="apiv2systemstatusoptions"></a>
# **ApiV2SystemStatusOptions**
> void ApiV2SystemStatusOptions ()
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 ApiV2SystemStatusOptionsExample
{
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 SystemStatusApi(config);
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2SystemStatusOptions();
}
catch (ApiException e)
{
Debug.Print("Exception when calling SystemStatusApi.ApiV2SystemStatusOptions: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the ApiV2SystemStatusOptionsWithHttpInfo 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.ApiV2SystemStatusOptionsWithHttpInfo();
}
catch (ApiException e)
{
Debug.Print("Exception when calling SystemStatusApi.ApiV2SystemStatusOptionsWithHttpInfo: " + 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="getinternalmessages"></a>
# **GetInternalMessages**
> MessageDtoPagedResponse GetInternalMessages (DateTime? startDateAfter = null, DateTime? startDateBefore = null, DateTime? endDateAfter = null, DateTime? endDateBefore = null, MessageType? type = null, string? searchTerm = null, int? pageNumber = null, int? pageSize = null, string? orderBy = null)
Retrieves the internal messages.
### 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 GetInternalMessagesExample
{
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 SystemStatusApi(config);
var startDateAfter = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their start date after this date. (optional)
var startDateBefore = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their start date before this date. (optional)
var endDateAfter = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their end date after this date. (optional)
var endDateBefore = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their end date before this date. (optional)
var type = new MessageType?(); // MessageType? | Filter messages by their type (e.g. information, warning, error). (optional)
var searchTerm = "searchTerm_example"; // string? | Filter messages by text contained in the messages or title. (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
// Retrieves the internal messages.
MessageDtoPagedResponse result = apiInstance.GetInternalMessages(startDateAfter, startDateBefore, endDateAfter, endDateBefore, type, searchTerm, pageNumber, pageSize, orderBy);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling SystemStatusApi.GetInternalMessages: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetInternalMessagesWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves the internal messages.
ApiResponse<MessageDtoPagedResponse> response = apiInstance.GetInternalMessagesWithHttpInfo(startDateAfter, startDateBefore, endDateAfter, endDateBefore, type, searchTerm, 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 SystemStatusApi.GetInternalMessagesWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **startDateAfter** | **DateTime?** | Will only return messages that have their start date after this date. | [optional] |
| **startDateBefore** | **DateTime?** | Will only return messages that have their start date before this date. | [optional] |
| **endDateAfter** | **DateTime?** | Will only return messages that have their end date after this date. | [optional] |
| **endDateBefore** | **DateTime?** | Will only return messages that have their end date before this date. | [optional] |
| **type** | [**MessageType?**](MessageType?.md) | Filter messages by their type (e.g. information, warning, error). | [optional] |
| **searchTerm** | **string?** | Filter messages by text contained in the messages or title. | [optional] |
| **pageNumber** | **int?** | The desired page number. Should be greater than or equal to 1. Default is 1. | [optional] |
| **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
[**MessageDtoPagedResponse**](MessageDtoPagedResponse.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 internal message. | - |
[[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="getnocmessages"></a>
# **GetNocMessages**
> MessageDtoPagedResponse GetNocMessages (DateTime? startDateAfter = null, DateTime? startDateBefore = null, DateTime? endDateAfter = null, DateTime? endDateBefore = null, MessageType? type = null, string? searchTerm = null, int? pageNumber = null, int? pageSize = null, string? orderBy = null)
Retrieves the NOC messages.
### 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 GetNocMessagesExample
{
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 SystemStatusApi(config);
var startDateAfter = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their start date after this date. (optional)
var startDateBefore = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their start date before this date. (optional)
var endDateAfter = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their end date after this date. (optional)
var endDateBefore = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | Will only return messages that have their end date before this date. (optional)
var type = new MessageType?(); // MessageType? | Filter messages by their type (e.g. information, warning, error). (optional)
var searchTerm = "searchTerm_example"; // string? | Filter messages by text contained in the messages or title. (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "orderBy_example"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
// Retrieves the NOC messages.
MessageDtoPagedResponse result = apiInstance.GetNocMessages(startDateAfter, startDateBefore, endDateAfter, endDateBefore, type, searchTerm, pageNumber, pageSize, orderBy);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling SystemStatusApi.GetNocMessages: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetNocMessagesWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves the NOC messages.
ApiResponse<MessageDtoPagedResponse> response = apiInstance.GetNocMessagesWithHttpInfo(startDateAfter, startDateBefore, endDateAfter, endDateBefore, type, searchTerm, 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 SystemStatusApi.GetNocMessagesWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **startDateAfter** | **DateTime?** | Will only return messages that have their start date after this date. | [optional] |
| **startDateBefore** | **DateTime?** | Will only return messages that have their start date before this date. | [optional] |
| **endDateAfter** | **DateTime?** | Will only return messages that have their end date after this date. | [optional] |
| **endDateBefore** | **DateTime?** | Will only return messages that have their end date before this date. | [optional] |
| **type** | [**MessageType?**](MessageType?.md) | Filter messages by their type (e.g. information, warning, error). | [optional] |
| **searchTerm** | **string?** | Filter messages by text contained in the messages or title. | [optional] |
| **pageNumber** | **int?** | The desired page number. Should be greater than or equal to 1. Default is 1. | [optional] |
| **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
[**MessageDtoPagedResponse**](MessageDtoPagedResponse.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 NOC messages. | - |
[[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)
......@@ -11,7 +11,7 @@
# - Copying the newly generated API client source to the project directory.
# - Updating the docs.
# - Replacing the README.md file.
# - Cleaning up temporary files and the downloaded tool.
# - Cleaning up temporary files.
#
# Defined variables:
OUTPUT_DIR="temp" # The temporary directory for generated files
......@@ -62,7 +62,7 @@ cp -R "$OUTPUT_DIR/docs" "docs"
echo -e "\n${CYAN}Replacing README.md file...${NC}"
cp "$OUTPUT_DIR/README.md" "README.md"
# Remove the temp directory and the generator JAR file
# Remove the temp directory
echo -e "${YELLOW}Cleaning up...${NC}"
rm -rf "$OUTPUT_DIR"
......
......@@ -85,11 +85,12 @@ namespace Coscine.ApiClient.Core.Test.Api
{
// TODO uncomment below to test the method and replace null with proper value
//string? searchTerm = null;
//AcceptedLanguage? language = null;
//bool? filterByPublicationService = null;
//int? pageNumber = null;
//int? pageSize = null;
//string? orderBy = null;
//var response = instance.GetOrganizations(searchTerm, filterByPublicationService, pageNumber, pageSize, orderBy);
//var response = instance.GetOrganizations(searchTerm, language, filterByPublicationService, pageNumber, pageSize, orderBy);
//Assert.IsType<OrganizationDtoPagedResponse>(response);
}
}
......
/*
* Coscine Web API
*
* Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
*
* The version of the OpenAPI document: 2.0
* Contact: servicedesk@itc.rwth-aachen.de
* Generated by: https://github.com/openapitools/openapi-generator.git
*/
using System;
using System.IO;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Reflection;
using RestSharp;
using Xunit;
using Coscine.ApiClient.Core.Client;
using Coscine.ApiClient.Core.Api;
// uncomment below to import models
//using Coscine.ApiClient.Core.Model;
namespace Coscine.ApiClient.Core.Test.Api
{
/// <summary>
/// Class for testing ProjectPublicationRequestApi
/// </summary>
/// <remarks>
/// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech).
/// Please update the test case below to test the API endpoint.
/// </remarks>
public class ProjectPublicationRequestApiTests : IDisposable
{
private ProjectPublicationRequestApi instance;
public ProjectPublicationRequestApiTests()
{
instance = new ProjectPublicationRequestApi();
}
public void Dispose()
{
// Cleanup when everything is done.
}
/// <summary>
/// Test an instance of ProjectPublicationRequestApi
/// </summary>
[Fact]
public void InstanceTest()
{
// TODO uncomment below to test 'IsType' ProjectPublicationRequestApi
//Assert.IsType<ProjectPublicationRequestApi>(instance);
}
/// <summary>
/// Test ApiV2ProjectsProjectIdPublicationsRequestsOptions
/// </summary>
[Fact]
public void ApiV2ProjectsProjectIdPublicationsRequestsOptionsTest()
{
// TODO uncomment below to test the method and replace null with proper value
//string projectId = null;
//instance.ApiV2ProjectsProjectIdPublicationsRequestsOptions(projectId);
}
/// <summary>
/// Test CreatePublicationRequest
/// </summary>
[Fact]
public void CreatePublicationRequestTest()
{
// TODO uncomment below to test the method and replace null with proper value
//string projectId = null;
//PublicationRequestForCreationDto? publicationRequestForCreationDto = null;
//var response = instance.CreatePublicationRequest(projectId, publicationRequestForCreationDto);
//Assert.IsType<PublicationRequestForCreationDtoResponse>(response);
}
}
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment