Skip to content
Snippets Groups Projects

Compare revisions

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

Source

Select target project
No results found

Target

Select target project
  • coscine/backend/libraries/apiclient
1 result
Show changes
Commits on Source (4)
Hide whitespace changes
Inline Side-by-side
Showing
with 448 additions and 341 deletions
README.md
View file @ 516389f7
......@@ -6,7 +6,7 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
- API version: 2.0
- SDK version: 1.0.0
- Generator version: 7.8.0-SNAPSHOT
- Generator version: 7.11.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.CSharpClientCodegen
<a id="frameworks-supported"></a>
......@@ -15,7 +15,7 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
<a id="dependencies"></a>
## Dependencies
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.13.0 or later
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 112.0.0 or later
- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 13.0.2 or later
- [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.8.0 or later
- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 5.0.0 or later
......@@ -197,11 +197,12 @@ Class | Method | HTTP request | Description
*ResourceApi* | [**ApiV2ResourcesOptions**](docs/ResourceApi.md#apiv2resourcesoptions) | **OPTIONS** /api/v2/resources | Responds with the HTTP methods allowed for the endpoint.
*ResourceApi* | [**GetResource**](docs/ResourceApi.md#getresource) | **GET** /api/v2/resources/{resourceId} | Retrieves a resource by its ID.
*ResourceTypeApi* | [**ApiV2ResourceTypesOptions**](docs/ResourceTypeApi.md#apiv2resourcetypesoptions) | **OPTIONS** /api/v2/resource-types | Responds with the HTTP methods allowed for the endpoint.
*ResourceTypeApi* | [**GetAllGitlabBranchesForProject**](docs/ResourceTypeApi.md#getallgitlabbranchesforproject) | **GET** /api/v2/resource-types/gitlab/projects/{gitlabProjectId}/branches | Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
*ResourceTypeApi* | [**GetAllGitlabProjects**](docs/ResourceTypeApi.md#getallgitlabprojects) | **GET** /api/v2/resource-types/gitlab/projects | Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
*ResourceTypeApi* | [**GetAllResourceTypesInformation**](docs/ResourceTypeApi.md#getallresourcetypesinformation) | **GET** /api/v2/resource-types/types | Retrieves the entire global resource types information.
*ResourceTypeApi* | [**GetGitlabProject**](docs/ResourceTypeApi.md#getgitlabproject) | **GET** /api/v2/resource-types/gitlab/projects/{gitlabProjectId} | Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
*ResourceTypeApi* | [**GetResourceTypeInformation**](docs/ResourceTypeApi.md#getresourcetypeinformation) | **GET** /api/v2/resource-types/types/{resourceTypeId} | Retrieves the resource type information for a specific resource type.
*ResourceTypeGitLabApi* | [**ApiV2ResourceTypesGitlabOptions**](docs/ResourceTypeGitLabApi.md#apiv2resourcetypesgitlaboptions) | **OPTIONS** /api/v2/resource-types/gitlab | Responds with the HTTP methods allowed for the endpoint.
*ResourceTypeGitLabApi* | [**GetAllGitlabBranchesForProject**](docs/ResourceTypeGitLabApi.md#getallgitlabbranchesforproject) | **GET** /api/v2/resource-types/gitlab/projects/{gitlabProjectId}/branches | Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
*ResourceTypeGitLabApi* | [**GetAllGitlabProjects**](docs/ResourceTypeGitLabApi.md#getallgitlabprojects) | **GET** /api/v2/resource-types/gitlab/projects | Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
*ResourceTypeGitLabApi* | [**GetGitlabProject**](docs/ResourceTypeGitLabApi.md#getgitlabproject) | **GET** /api/v2/resource-types/gitlab/projects/{gitlabProjectId} | Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
*RoleApi* | [**ApiV2RolesOptions**](docs/RoleApi.md#apiv2rolesoptions) | **OPTIONS** /api/v2/roles | Responds with the HTTP methods allowed for the endpoint.
*RoleApi* | [**GetRole**](docs/RoleApi.md#getrole) | **GET** /api/v2/roles/{roleId} | Retrieves a role by ID.
*RoleApi* | [**GetRoles**](docs/RoleApi.md#getroles) | **GET** /api/v2/roles | Retrieves all roles.
......@@ -283,6 +284,7 @@ Class | Method | HTTP request | Description
- [Model.FileActionDto](docs/FileActionDto.md)
- [Model.FileActionHttpMethod](docs/FileActionHttpMethod.md)
- [Model.FileActionsDto](docs/FileActionsDto.md)
- [Model.FileSystemStorageOptionsDto](docs/FileSystemStorageOptionsDto.md)
- [Model.FileTreeDto](docs/FileTreeDto.md)
- [Model.FileTreeDtoPagedResponse](docs/FileTreeDtoPagedResponse.md)
- [Model.FixedValueForResourceManipulationDto](docs/FixedValueForResourceManipulationDto.md)
......
docs/AdminApi.md
View file @ 516389f7
......@@ -137,7 +137,7 @@ namespace Example
var httpMethod = new CoscineHttpMethod?(); // CoscineHttpMethod? | The http method to filter activity logs by. (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -188,7 +188,7 @@ catch (ApiException e)
| **httpMethod** | [**CoscineHttpMethod?**](CoscineHttpMethod?.md) | The http method to filter activity logs by. | [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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......@@ -247,7 +247,7 @@ namespace Example
var includePublicationRequests = true; // bool? | Gets or sets a value indicating whether to include project publication requests in the results. (optional)
var pageSize = 56; // int? | Number of items per page. The maximum number of items per page is `250`. (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -296,7 +296,7 @@ catch (ApiException e)
| **includePublicationRequests** | **bool?** | Gets or sets a value indicating whether to include project publication requests in the results. | [optional] |
| **pageSize** | **int?** | Number of items per page. The maximum number of items per page is &#x60;250&#x60;. | [optional] |
| **pageNumber** | **int?** | The desired page number. Should be greater than or equal to 1. Default is 1. | [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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......@@ -354,7 +354,7 @@ namespace Example
var includeQuotas = true; // bool? | Value indicating whether to include individual resource quotas. (optional)
var pageSize = 56; // int? | Number of items per page. The maximum number of items per page is `250`. (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -401,7 +401,7 @@ catch (ApiException e)
| **includeQuotas** | **bool?** | Value indicating whether to include individual resource quotas. | [optional] |
| **pageSize** | **int?** | Number of items per page. The maximum number of items per page is &#x60;250&#x60;. | [optional] |
| **pageNumber** | **int?** | The desired page number. Should be greater than or equal to 1. Default is 1. | [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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......@@ -458,7 +458,7 @@ namespace Example
var tosAccepted = true; // bool? | Gets or sets a value indicating whether the terms of service have been accepted by the user. (optional)
var pageSize = 56; // int? | Number of items per page. The maximum number of items per page is `250`. (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -504,7 +504,7 @@ catch (ApiException e)
| **tosAccepted** | **bool?** | Gets or sets a value indicating whether the terms of service have been accepted by the user. | [optional] |
| **pageSize** | **int?** | Number of items per page. The maximum number of items per page is &#x60;250&#x60;. | [optional] |
| **pageNumber** | **int?** | The desired page number. Should be greater than or equal to 1. Default is 1. | [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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......@@ -560,7 +560,7 @@ namespace Example
var apiInstance = new AdminApi(config);
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -605,7 +605,7 @@ catch (ApiException e)
|------|------|-------------|-------|
| **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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/ApplicationProfileApi.md
View file @ 516389f7
......@@ -324,7 +324,7 @@ namespace Example
var modules = true; // bool? | Gets or sets a value indicating whether to include modules in the application profiles. (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -372,7 +372,7 @@ catch (ApiException e)
| **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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/DisciplineApi.md
View file @ 516389f7
......@@ -218,7 +218,7 @@ namespace Example
var apiInstance = new DisciplineApi(config);
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -263,7 +263,7 @@ catch (ApiException e)
|------|------|-------------|-------|
| **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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/FileSystemStorageOptionsDto.md 0 → 100644
View file @ 516389f7
# Coscine.ApiClient.Core.Model.FileSystemStorageOptionsDto
Represents the data transfer object (DTO) for FileSystemStorage options.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Directory** | **string** | The directory where the files are stored. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/LanguageApi.md
View file @ 516389f7
......@@ -218,7 +218,7 @@ namespace Example
var apiInstance = new LanguageApi(config);
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -263,7 +263,7 @@ catch (ApiException e)
|------|------|-------------|-------|
| **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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/LicenseApi.md
View file @ 516389f7
......@@ -218,7 +218,7 @@ namespace Example
var apiInstance = new LicenseApi(config);
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -263,7 +263,7 @@ catch (ApiException e)
|------|------|-------------|-------|
| **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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/OrganizationApi.md
View file @ 516389f7
......@@ -220,7 +220,7 @@ namespace Example
var filterByPublicationService = true; // bool? | Gets or sets the option to find only organizations having the publication service set. (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -268,7 +268,7 @@ catch (ApiException e)
| **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] |
| **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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/PidApi.md
View file @ 516389f7
......@@ -227,7 +227,7 @@ namespace Example
var includeDeleted = true; // bool? | Gets or sets a value indicating whether to include deleted pid information. (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -275,7 +275,7 @@ catch (ApiException e)
| **includeDeleted** | **bool?** | Gets or sets a value indicating whether to include deleted pid information. | [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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/ProjectApi.md
View file @ 516389f7
......@@ -417,7 +417,7 @@ namespace Example
var topLevel = true; // bool? | Gets or sets a value indicating whether to retrieve only top-level projects. (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -464,7 +464,7 @@ catch (ApiException e)
| **topLevel** | **bool?** | Gets or sets a value indicating whether to retrieve only top-level projects. | [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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/ProjectInvitationApi.md
View file @ 516389f7
......@@ -421,7 +421,7 @@ namespace Example
var projectId = "projectId_example"; // string | The Id or slug of the project.
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -467,7 +467,7 @@ catch (ApiException e)
| **projectId** | **string** | The Id or slug of the project. | |
| **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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/ProjectMemberApi.md
View file @ 516389f7
......@@ -422,7 +422,7 @@ namespace Example
var projectId = "projectId_example"; // string | The Id or slug of the project.
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -468,7 +468,7 @@ catch (ApiException e)
| **projectId** | **string** | The Id or slug of the project. | |
| **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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/ProjectQuotaApi.md
View file @ 516389f7
......@@ -227,7 +227,7 @@ namespace Example
var projectId = "projectId_example"; // string | The Id or slug of the project.
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -273,7 +273,7 @@ catch (ApiException e)
| **projectId** | **string** | The Id or slug of the project. | |
| **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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/ProjectResourceApi.md
View file @ 516389f7
......@@ -425,7 +425,7 @@ namespace Example
var projectId = "projectId_example"; // string | The Id or slug of the project.
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -471,7 +471,7 @@ catch (ApiException e)
| **projectId** | **string** | The Id or slug of the project. | |
| **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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/ResourceTypeApi.md
View file @ 516389f7
......@@ -5,10 +5,7 @@ All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.d
| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**ApiV2ResourceTypesOptions**](ResourceTypeApi.md#apiv2resourcetypesoptions) | **OPTIONS** /api/v2/resource-types | Responds with the HTTP methods allowed for the endpoint. |
| [**GetAllGitlabBranchesForProject**](ResourceTypeApi.md#getallgitlabbranchesforproject) | **GET** /api/v2/resource-types/gitlab/projects/{gitlabProjectId}/branches | Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials. |
| [**GetAllGitlabProjects**](ResourceTypeApi.md#getallgitlabprojects) | **GET** /api/v2/resource-types/gitlab/projects | Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. |
| [**GetAllResourceTypesInformation**](ResourceTypeApi.md#getallresourcetypesinformation) | **GET** /api/v2/resource-types/types | Retrieves the entire global resource types information. |
| [**GetGitlabProject**](ResourceTypeApi.md#getgitlabproject) | **GET** /api/v2/resource-types/gitlab/projects/{gitlabProjectId} | Retrieves a single GitLab project, that the user is a member of, based on the provided credentials. |
| [**GetResourceTypeInformation**](ResourceTypeApi.md#getresourcetypeinformation) | **GET** /api/v2/resource-types/types/{resourceTypeId} | Retrieves the resource type information for a specific resource type. |
<a id="apiv2resourcetypesoptions"></a>
......@@ -96,202 +93,6 @@ void (empty response body)
[[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="getallgitlabbranchesforproject"></a>
# **GetAllGitlabBranchesForProject**
> GitlabBranchDtoIEnumerableResponse GetAllGitlabBranchesForProject (int gitlabProjectId, string domain, string accessToken)
Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
### 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 GetAllGitlabBranchesForProjectExample
{
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 ResourceTypeApi(config);
var gitlabProjectId = 56; // int | The ID of the GitLab project.
var domain = https://git.rwth-aachen.de/; // string | Domain/Host of the GitLab Provider.
var accessToken = "accessToken_example"; // string | GitLab Project or Group Access Token.
try
{
// Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
GitlabBranchDtoIEnumerableResponse result = apiInstance.GetAllGitlabBranchesForProject(gitlabProjectId, domain, accessToken);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ResourceTypeApi.GetAllGitlabBranchesForProject: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetAllGitlabBranchesForProjectWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
ApiResponse<GitlabBranchDtoIEnumerableResponse> response = apiInstance.GetAllGitlabBranchesForProjectWithHttpInfo(gitlabProjectId, domain, accessToken);
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 ResourceTypeApi.GetAllGitlabBranchesForProjectWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **gitlabProjectId** | **int** | The ID of the GitLab project. | |
| **domain** | **string** | Domain/Host of the GitLab Provider. | |
| **accessToken** | **string** | GitLab Project or Group Access Token. | |
### Return type
[**GitlabBranchDtoIEnumerableResponse**](GitlabBranchDtoIEnumerableResponse.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 GitLab project. | - |
| **403** | GitLab access token is invalid. | - |
[[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="getallgitlabprojects"></a>
# **GetAllGitlabProjects**
> GitlabProjectDtoIEnumerableResponse GetAllGitlabProjects (string domain, string accessToken)
Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
### 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 GetAllGitlabProjectsExample
{
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 ResourceTypeApi(config);
var domain = https://git.rwth-aachen.de/; // string | Domain/Host of the GitLab Provider.
var accessToken = "accessToken_example"; // string | GitLab Project or Group Access Token.
try
{
// Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
GitlabProjectDtoIEnumerableResponse result = apiInstance.GetAllGitlabProjects(domain, accessToken);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ResourceTypeApi.GetAllGitlabProjects: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetAllGitlabProjectsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
ApiResponse<GitlabProjectDtoIEnumerableResponse> response = apiInstance.GetAllGitlabProjectsWithHttpInfo(domain, accessToken);
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 ResourceTypeApi.GetAllGitlabProjectsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **domain** | **string** | Domain/Host of the GitLab Provider. | |
| **accessToken** | **string** | GitLab Project or Group Access Token. | |
### Return type
[**GitlabProjectDtoIEnumerableResponse**](GitlabProjectDtoIEnumerableResponse.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 GitLab projects. | - |
| **403** | GitLab access token is invalid. | - |
[[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="getallresourcetypesinformation"></a>
# **GetAllResourceTypesInformation**
> ResourceTypeInformationDtoIEnumerableResponse GetAllResourceTypesInformation ()
......@@ -381,105 +182,6 @@ This endpoint does not need any parameter.
[[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="getgitlabproject"></a>
# **GetGitlabProject**
> GitlabProjectDtoResponse GetGitlabProject (int gitlabProjectId, string domain, string accessToken)
Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
### 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 GetGitlabProjectExample
{
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 ResourceTypeApi(config);
var gitlabProjectId = 56; // int | The ID of the GitLab project.
var domain = https://git.rwth-aachen.de/; // string | Domain/Host of the GitLab Provider.
var accessToken = "accessToken_example"; // string | GitLab Project or Group Access Token.
try
{
// Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
GitlabProjectDtoResponse result = apiInstance.GetGitlabProject(gitlabProjectId, domain, accessToken);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ResourceTypeApi.GetGitlabProject: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetGitlabProjectWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
ApiResponse<GitlabProjectDtoResponse> response = apiInstance.GetGitlabProjectWithHttpInfo(gitlabProjectId, domain, accessToken);
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 ResourceTypeApi.GetGitlabProjectWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **gitlabProjectId** | **int** | The ID of the GitLab project. | |
| **domain** | **string** | Domain/Host of the GitLab Provider. | |
| **accessToken** | **string** | GitLab Project or Group Access Token. | |
### Return type
[**GitlabProjectDtoResponse**](GitlabProjectDtoResponse.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 GitLab project. | - |
| **403** | GitLab access token is invalid. | - |
[[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="getresourcetypeinformation"></a>
# **GetResourceTypeInformation**
> ResourceTypeInformationDtoResponse GetResourceTypeInformation (Guid resourceTypeId)
......
docs/ResourceTypeGitLabApi.md 0 → 100644
View file @ 516389f7
# Coscine.ApiClient.Core.Api.ResourceTypeGitLabApi
All URIs are relative to *https://coscine-api-hristov.web.vulcanus.otc.coscine.dev/coscine*
| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**ApiV2ResourceTypesGitlabOptions**](ResourceTypeGitLabApi.md#apiv2resourcetypesgitlaboptions) | **OPTIONS** /api/v2/resource-types/gitlab | Responds with the HTTP methods allowed for the endpoint. |
| [**GetAllGitlabBranchesForProject**](ResourceTypeGitLabApi.md#getallgitlabbranchesforproject) | **GET** /api/v2/resource-types/gitlab/projects/{gitlabProjectId}/branches | Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials. |
| [**GetAllGitlabProjects**](ResourceTypeGitLabApi.md#getallgitlabprojects) | **GET** /api/v2/resource-types/gitlab/projects | Retrieves all GitLab projects, that the user is a member of, based on the provided credentials. |
| [**GetGitlabProject**](ResourceTypeGitLabApi.md#getgitlabproject) | **GET** /api/v2/resource-types/gitlab/projects/{gitlabProjectId} | Retrieves a single GitLab project, that the user is a member of, based on the provided credentials. |
<a id="apiv2resourcetypesgitlaboptions"></a>
# **ApiV2ResourceTypesGitlabOptions**
> void ApiV2ResourceTypesGitlabOptions ()
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 ApiV2ResourceTypesGitlabOptionsExample
{
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 ResourceTypeGitLabApi(config);
try
{
// Responds with the HTTP methods allowed for the endpoint.
apiInstance.ApiV2ResourceTypesGitlabOptions();
}
catch (ApiException e)
{
Debug.Print("Exception when calling ResourceTypeGitLabApi.ApiV2ResourceTypesGitlabOptions: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the ApiV2ResourceTypesGitlabOptionsWithHttpInfo 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.ApiV2ResourceTypesGitlabOptionsWithHttpInfo();
}
catch (ApiException e)
{
Debug.Print("Exception when calling ResourceTypeGitLabApi.ApiV2ResourceTypesGitlabOptionsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
void (empty response body)
### Authorization
[Bearer](../README.md#Bearer)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | OK | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
<a id="getallgitlabbranchesforproject"></a>
# **GetAllGitlabBranchesForProject**
> GitlabBranchDtoIEnumerableResponse GetAllGitlabBranchesForProject (int gitlabProjectId, string domain, string accessToken)
Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
### 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 GetAllGitlabBranchesForProjectExample
{
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 ResourceTypeGitLabApi(config);
var gitlabProjectId = 56; // int | The ID of the GitLab project.
var domain = https://git.rwth-aachen.de/; // string | Domain/Host of the GitLab Provider.
var accessToken = "accessToken_example"; // string | GitLab Project or Group Access Token.
try
{
// Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
GitlabBranchDtoIEnumerableResponse result = apiInstance.GetAllGitlabBranchesForProject(gitlabProjectId, domain, accessToken);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ResourceTypeGitLabApi.GetAllGitlabBranchesForProject: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetAllGitlabBranchesForProjectWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves all branches of a GitLab project, that the user is a member of, based on the provided credentials.
ApiResponse<GitlabBranchDtoIEnumerableResponse> response = apiInstance.GetAllGitlabBranchesForProjectWithHttpInfo(gitlabProjectId, domain, accessToken);
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 ResourceTypeGitLabApi.GetAllGitlabBranchesForProjectWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **gitlabProjectId** | **int** | The ID of the GitLab project. | |
| **domain** | **string** | Domain/Host of the GitLab Provider. | |
| **accessToken** | **string** | GitLab Project or Group Access Token. | |
### Return type
[**GitlabBranchDtoIEnumerableResponse**](GitlabBranchDtoIEnumerableResponse.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 GitLab project. | - |
| **403** | GitLab access token is invalid. | - |
[[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="getallgitlabprojects"></a>
# **GetAllGitlabProjects**
> GitlabProjectDtoIEnumerableResponse GetAllGitlabProjects (string domain, string accessToken)
Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
### 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 GetAllGitlabProjectsExample
{
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 ResourceTypeGitLabApi(config);
var domain = https://git.rwth-aachen.de/; // string | Domain/Host of the GitLab Provider.
var accessToken = "accessToken_example"; // string | GitLab Project or Group Access Token.
try
{
// Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
GitlabProjectDtoIEnumerableResponse result = apiInstance.GetAllGitlabProjects(domain, accessToken);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ResourceTypeGitLabApi.GetAllGitlabProjects: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetAllGitlabProjectsWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves all GitLab projects, that the user is a member of, based on the provided credentials.
ApiResponse<GitlabProjectDtoIEnumerableResponse> response = apiInstance.GetAllGitlabProjectsWithHttpInfo(domain, accessToken);
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 ResourceTypeGitLabApi.GetAllGitlabProjectsWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **domain** | **string** | Domain/Host of the GitLab Provider. | |
| **accessToken** | **string** | GitLab Project or Group Access Token. | |
### Return type
[**GitlabProjectDtoIEnumerableResponse**](GitlabProjectDtoIEnumerableResponse.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 GitLab projects. | - |
| **403** | GitLab access token is invalid. | - |
[[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="getgitlabproject"></a>
# **GetGitlabProject**
> GitlabProjectDtoResponse GetGitlabProject (int gitlabProjectId, string domain, string accessToken)
Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
### 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 GetGitlabProjectExample
{
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 ResourceTypeGitLabApi(config);
var gitlabProjectId = 56; // int | The ID of the GitLab project.
var domain = https://git.rwth-aachen.de/; // string | Domain/Host of the GitLab Provider.
var accessToken = "accessToken_example"; // string | GitLab Project or Group Access Token.
try
{
// Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
GitlabProjectDtoResponse result = apiInstance.GetGitlabProject(gitlabProjectId, domain, accessToken);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ResourceTypeGitLabApi.GetGitlabProject: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```
#### Using the GetGitlabProjectWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
```csharp
try
{
// Retrieves a single GitLab project, that the user is a member of, based on the provided credentials.
ApiResponse<GitlabProjectDtoResponse> response = apiInstance.GetGitlabProjectWithHttpInfo(gitlabProjectId, domain, accessToken);
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 ResourceTypeGitLabApi.GetGitlabProjectWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```
### Parameters
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **gitlabProjectId** | **int** | The ID of the GitLab project. | |
| **domain** | **string** | Domain/Host of the GitLab Provider. | |
| **accessToken** | **string** | GitLab Project or Group Access Token. | |
### Return type
[**GitlabProjectDtoResponse**](GitlabProjectDtoResponse.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 GitLab project. | - |
| **403** | GitLab access token is invalid. | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
docs/ResourceTypeOptionsDto.md
View file @ 516389f7
......@@ -10,6 +10,7 @@ Name | Type | Description | Notes
**Rds** | [**RdsOptionsDto**](RdsOptionsDto.md) | | [optional]
**RdsS3** | [**RdsS3OptionsDto**](RdsS3OptionsDto.md) | | [optional]
**RdsS3Worm** | [**RdsS3WormOptionsDto**](RdsS3WormOptionsDto.md) | | [optional]
**FileSystemStorage** | [**FileSystemStorageOptionsDto**](FileSystemStorageOptionsDto.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/RoleApi.md
View file @ 516389f7
......@@ -218,7 +218,7 @@ namespace Example
var apiInstance = new RoleApi(config);
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -263,7 +263,7 @@ catch (ApiException e)
|------|------|-------------|-------|
| **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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/SearchApi.md
View file @ 516389f7
......@@ -126,7 +126,7 @@ namespace Example
var category = new SearchCategoryType?(); // SearchCategoryType? | Set the category filter (optional)
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -175,7 +175,7 @@ catch (ApiException e)
| **category** | [**SearchCategoryType?**](SearchCategoryType?.md) | Set the category filter | [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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......
docs/SelfApiTokenApi.md
View file @ 516389f7
......@@ -221,7 +221,7 @@ namespace Example
var apiInstance = new SelfApiTokenApi(config);
var pageNumber = 56; // int? | The desired page number. Should be greater than or equal to 1. Default is 1. (optional)
var pageSize = 56; // int? | The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
var orderBy = "propertyA asc, propertyB desc"; // string? | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc. (optional)
try
{
......@@ -266,7 +266,7 @@ catch (ApiException e)
|------|------|-------------|-------|
| **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] |
| **orderBy** | **string?** | Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc. | [optional] |
### Return type
......