All URIs are relative to http://localhost
Method | HTTP request | Description |
---|---|---|
CreatePlugin | POST /plugins/{owner} | Create a Plugin |
CreatePluginPackage | POST /plugins/{owner}/{name}/tags | Create a new Plugin package |
DeletePlugin | DELETE /plugins/{owner}/{name} | Delete a Plugin |
DeletePluginOrgPermission | DELETE /plugins/{owner}/{name}/permissions | Remove a Repository permissions |
GetPlugin | GET /plugins/{owner}/{name} | Get a plugin |
GetPluginAccessPermissions | GET /plugins/{owner}/{name}/permissions | Get plugin access permissions |
GetPluginByTag | GET /plugins/{owner}/{name}/tags/{tag} | Get a plugin tag |
ListPluginTags | GET /plugins/{owner}/{name}/tags | Get a plugin tags |
ListPlugins | GET /plugins | List plugins |
UpdatePlugin | PUT /plugins/{owner}/{name} | Update a Plugin |
UpsertPluginPermission | PATCH /plugins/{owner}/{name}/permissions | Upsert a new permission to a plugin |
CreatedContent CreatePlugin (string owner, RepositoryCreate repositoryCreate)
Create a Plugin
Create a new plugin.
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class CreatePluginExample
{
public static void Main()
{
Configuration.Default.BasePath = "http://localhost";
// Configure API key authorization: APIKeyAuth
Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
// Configure HTTP bearer authorization: JWTAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new PluginsApi(Configuration.Default);
var owner = owner_example; // string |
var repositoryCreate = new RepositoryCreate(); // RepositoryCreate |
try
{
// Create a Plugin
CreatedContent result = apiInstance.CreatePlugin(owner, repositoryCreate);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PluginsApi.CreatePlugin: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
owner | string | ||
repositoryCreate | RepositoryCreate |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | Success | - |
403 | Access forbidden | - |
500 | Server error | - |
400 | Invalid request | - |
202 | Accepted | - |
422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreatedContent CreatePluginPackage (string owner, string name, NewPluginPackage newPluginPackage)
Create a new Plugin package
Create a new plugin package version
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class CreatePluginPackageExample
{
public static void Main()
{
Configuration.Default.BasePath = "http://localhost";
// Configure API key authorization: APIKeyAuth
Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
// Configure HTTP bearer authorization: JWTAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new PluginsApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
var newPluginPackage = new NewPluginPackage(); // NewPluginPackage |
try
{
// Create a new Plugin package
CreatedContent result = apiInstance.CreatePluginPackage(owner, name, newPluginPackage);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PluginsApi.CreatePluginPackage: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
owner | string | ||
name | string | ||
newPluginPackage | NewPluginPackage |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Success | - |
403 | Access forbidden | - |
500 | Server error | - |
400 | Invalid request | - |
404 | Not found | - |
422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void DeletePlugin (string owner, string name)
Delete a Plugin
Delete a plugin (must have admin
permission)
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class DeletePluginExample
{
public static void Main()
{
Configuration.Default.BasePath = "http://localhost";
// Configure API key authorization: APIKeyAuth
Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
// Configure HTTP bearer authorization: JWTAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new PluginsApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
try
{
// Delete a Plugin
apiInstance.DeletePlugin(owner, name);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PluginsApi.DeletePlugin: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
owner | string | ||
name | string |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
204 | Accepted | - |
403 | Access forbidden | - |
500 | Server error | - |
400 | Invalid request | - |
422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
void DeletePluginOrgPermission (string owner, string name, RepositoryPolicySubject repositoryPolicySubject)
Remove a Repository permissions
Delete a plugin's access policy (must have admin
permission)
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class DeletePluginOrgPermissionExample
{
public static void Main()
{
Configuration.Default.BasePath = "http://localhost";
// Configure API key authorization: APIKeyAuth
Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
// Configure HTTP bearer authorization: JWTAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new PluginsApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
var repositoryPolicySubject = new RepositoryPolicySubject(); // RepositoryPolicySubject |
try
{
// Remove a Repository permissions
apiInstance.DeletePluginOrgPermission(owner, name, repositoryPolicySubject);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PluginsApi.DeletePluginOrgPermission: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
owner | string | ||
name | string | ||
repositoryPolicySubject | RepositoryPolicySubject |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
204 | Accepted | - |
403 | Access forbidden | - |
500 | Server error | - |
400 | Invalid request | - |
422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Repository GetPlugin (string owner, string name)
Get a plugin
Retrieve a plugin by name
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class GetPluginExample
{
public static void Main()
{
Configuration.Default.BasePath = "http://localhost";
// Configure API key authorization: APIKeyAuth
Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
// Configure HTTP bearer authorization: JWTAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new PluginsApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
try
{
// Get a plugin
Repository result = apiInstance.GetPlugin(owner, name);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PluginsApi.GetPlugin: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
owner | string | ||
name | string |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Retrieved | - |
403 | Access forbidden | - |
500 | Server error | - |
400 | Invalid request | - |
404 | Not found | - |
422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepositoryAccessPolicyList GetPluginAccessPermissions (string owner, string name, int? page = null, int? perPage = null, List subjectType = null, List permission = null)
Get plugin access permissions
Retrieve a plugin's access permissions (must have write
permission)
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class GetPluginAccessPermissionsExample
{
public static void Main()
{
Configuration.Default.BasePath = "http://localhost";
// Configure API key authorization: APIKeyAuth
Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
// Configure HTTP bearer authorization: JWTAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new PluginsApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
var page = 56; // int? | Page number starting from 1 (optional) (default to 1)
var perPage = 56; // int? | Number of items per page (optional) (default to 25)
var subjectType = new List<string>(); // List<string> | The type of access policy subject (optional)
var permission = new List<string>(); // List<string> | An access policy permission string (optional)
try
{
// Get plugin access permissions
RepositoryAccessPolicyList result = apiInstance.GetPluginAccessPermissions(owner, name, page, perPage, subjectType, permission);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PluginsApi.GetPluginAccessPermissions: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
owner | string | ||
name | string | ||
page | int? | Page number starting from 1 | [optional] [default to 1] |
perPage | int? | Number of items per page | [optional] [default to 25] |
subjectType | List<string> | The type of access policy subject | [optional] |
permission | List<string> | An access policy permission string | [optional] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Retrieved | - |
403 | Access forbidden | - |
500 | Server error | - |
400 | Invalid request | - |
422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PluginPackage GetPluginByTag (string owner, string name, string tag)
Get a plugin tag
Retrieve a plugin tag by name and tag
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class GetPluginByTagExample
{
public static void Main()
{
Configuration.Default.BasePath = "http://localhost";
// Configure API key authorization: APIKeyAuth
Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
// Configure HTTP bearer authorization: JWTAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new PluginsApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
var tag = tag_example; // string |
try
{
// Get a plugin tag
PluginPackage result = apiInstance.GetPluginByTag(owner, name, tag);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PluginsApi.GetPluginByTag: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
owner | string | ||
name | string | ||
tag | string |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Retrieved | - |
403 | Access forbidden | - |
500 | Server error | - |
400 | Invalid request | - |
404 | Not found | - |
422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PluginPackageList ListPluginTags (string owner, string name, PackageSortKey? sortBy = null, SortEnum? sortOrder = null, int? page = null, int? perPage = null)
Get a plugin tags
Retrieve a plugin by name
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class ListPluginTagsExample
{
public static void Main()
{
Configuration.Default.BasePath = "http://localhost";
// Configure API key authorization: APIKeyAuth
Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
// Configure HTTP bearer authorization: JWTAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new PluginsApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
var sortBy = ; // PackageSortKey? | Key to sort the list by (optional)
var sortOrder = ; // SortEnum? | The order to sort the list (optional)
var page = 56; // int? | Page number starting from 1 (optional) (default to 1)
var perPage = 56; // int? | Number of items per page (optional) (default to 25)
try
{
// Get a plugin tags
PluginPackageList result = apiInstance.ListPluginTags(owner, name, sortBy, sortOrder, page, perPage);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PluginsApi.ListPluginTags: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
owner | string | ||
name | string | ||
sortBy | PackageSortKey? | Key to sort the list by | [optional] |
sortOrder | SortEnum? | The order to sort the list | [optional] |
page | int? | Page number starting from 1 | [optional] [default to 1] |
perPage | int? | Number of items per page | [optional] [default to 25] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Retrieved | - |
403 | Access forbidden | - |
500 | Server error | - |
400 | Invalid request | - |
404 | Not found | - |
422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepositoryList ListPlugins (List search = null, List name = null, List owner = null, bool? _public = null, List keyword = null, List permission = null, RepositorySortKey? sortBy = null, SortEnum? sortOrder = null, int? page = null, int? perPage = null)
List plugins
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class ListPluginsExample
{
public static void Main()
{
Configuration.Default.BasePath = "http://localhost";
// Configure API key authorization: APIKeyAuth
Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
// Configure HTTP bearer authorization: JWTAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new PluginsApi(Configuration.Default);
var search = new List<string>(); // List<string> | You know, for search (optional)
var name = new List<string>(); // List<string> | The account name (optional)
var owner = new List<string>(); // List<string> | Owner of the project (optional)
var _public = true; // bool? | Boolean check for public/private projects (optional)
var keyword = new List<string>(); // List<string> | A keyword to index the repository by (optional)
var permission = new List<string>(); // List<string> | Filter by permission on given resource (optional)
var sortBy = ; // RepositorySortKey? | Key to sort the list by (optional)
var sortOrder = ; // SortEnum? | The order to sort the list (optional)
var page = 56; // int? | Page number starting from 1 (optional) (default to 1)
var perPage = 56; // int? | Number of items per page (optional) (default to 25)
try
{
// List plugins
RepositoryList result = apiInstance.ListPlugins(search, name, owner, _public, keyword, permission, sortBy, sortOrder, page, perPage);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PluginsApi.ListPlugins: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
search | List<string> | You know, for search | [optional] |
name | List<string> | The account name | [optional] |
owner | List<string> | Owner of the project | [optional] |
_public | bool? | Boolean check for public/private projects | [optional] |
keyword | List<string> | A keyword to index the repository by | [optional] |
permission | List<string> | Filter by permission on given resource | [optional] |
sortBy | RepositorySortKey? | Key to sort the list by | [optional] |
sortOrder | SortEnum? | The order to sort the list | [optional] |
page | int? | Page number starting from 1 | [optional] [default to 1] |
perPage | int? | Number of items per page | [optional] [default to 25] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Retrieved | - |
422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateAccepted UpdatePlugin (string owner, string name, RepositoryUpdate repositoryUpdate)
Update a Plugin
Update a plugin (must have contribute
permission)
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class UpdatePluginExample
{
public static void Main()
{
Configuration.Default.BasePath = "http://localhost";
// Configure API key authorization: APIKeyAuth
Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
// Configure HTTP bearer authorization: JWTAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new PluginsApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
var repositoryUpdate = new RepositoryUpdate(); // RepositoryUpdate |
try
{
// Update a Plugin
UpdateAccepted result = apiInstance.UpdatePlugin(owner, name, repositoryUpdate);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PluginsApi.UpdatePlugin: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
owner | string | ||
name | string | ||
repositoryUpdate | RepositoryUpdate |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
202 | Accepted | - |
403 | Access forbidden | - |
500 | Server error | - |
400 | Invalid request | - |
404 | Not found | - |
422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateAccepted UpsertPluginPermission (string owner, string name, RepositoryAccessPolicy repositoryAccessPolicy)
Upsert a new permission to a plugin
Upsert a plugin's access policy (must have admin
permission)
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class UpsertPluginPermissionExample
{
public static void Main()
{
Configuration.Default.BasePath = "http://localhost";
// Configure API key authorization: APIKeyAuth
Configuration.Default.AddApiKey("x-pollination-token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("x-pollination-token", "Bearer");
// Configure HTTP bearer authorization: JWTAuth
Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
var apiInstance = new PluginsApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
var repositoryAccessPolicy = new RepositoryAccessPolicy(); // RepositoryAccessPolicy |
try
{
// Upsert a new permission to a plugin
UpdateAccepted result = apiInstance.UpsertPluginPermission(owner, name, repositoryAccessPolicy);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling PluginsApi.UpsertPluginPermission: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
owner | string | ||
name | string | ||
repositoryAccessPolicy | RepositoryAccessPolicy |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
202 | Accepted | - |
403 | Access forbidden | - |
500 | Server error | - |
400 | Invalid request | - |
404 | Not found | - |
422 | Validation Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]