All URIs are relative to http://localhost
Method | HTTP request | Description |
---|---|---|
CreateRecipe | POST /recipes/{owner} | Create a Recipe |
CreateRecipePackage | POST /recipes/{owner}/{name}/tags | Create a new Recipe package |
DeleteRecipe | DELETE /recipes/{owner}/{name} | Delete a Recipe |
DeleteRecipeOrgPermission | DELETE /recipes/{owner}/{name}/permissions | Remove a Repository permissions |
GetRecipe | GET /recipes/{owner}/{name} | Get a recipe |
GetRecipeAccessPermissions | GET /recipes/{owner}/{name}/permissions | Get recipe access permissions |
GetRecipeByTag | GET /recipes/{owner}/{name}/tags/{tag} | Get a recipe tag |
ListRecipeTags | GET /recipes/{owner}/{name}/tags | Get a recipe tags |
ListRecipes | GET /recipes | List recipes |
UpdateRecipe | PUT /recipes/{owner}/{name} | Update a Recipe |
UpsertRecipePermission | PATCH /recipes/{owner}/{name}/permissions | Upsert a new permission to a recipe |
CreatedContent CreateRecipe (string owner, RepositoryCreate repositoryCreate)
Create a Recipe
Create a new recipe.
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class CreateRecipeExample
{
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 RecipesApi(Configuration.Default);
var owner = owner_example; // string |
var repositoryCreate = new RepositoryCreate(); // RepositoryCreate |
try
{
// Create a Recipe
CreatedContent result = apiInstance.CreateRecipe(owner, repositoryCreate);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling RecipesApi.CreateRecipe: " + 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 CreateRecipePackage (string owner, string name, NewRecipePackage newRecipePackage)
Create a new Recipe package
Create a new recipe package version
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class CreateRecipePackageExample
{
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 RecipesApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
var newRecipePackage = new NewRecipePackage(); // NewRecipePackage |
try
{
// Create a new Recipe package
CreatedContent result = apiInstance.CreateRecipePackage(owner, name, newRecipePackage);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling RecipesApi.CreateRecipePackage: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Name | Type | Description | Notes |
---|---|---|---|
owner | string | ||
name | string | ||
newRecipePackage | NewRecipePackage |
- 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 DeleteRecipe (string owner, string name)
Delete a Recipe
Delete a recipe (must have admin
permission)
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class DeleteRecipeExample
{
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 RecipesApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
try
{
// Delete a Recipe
apiInstance.DeleteRecipe(owner, name);
}
catch (ApiException e)
{
Debug.Print("Exception when calling RecipesApi.DeleteRecipe: " + 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 DeleteRecipeOrgPermission (string owner, string name, RepositoryPolicySubject repositoryPolicySubject)
Remove a Repository permissions
Delete a recipe'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 DeleteRecipeOrgPermissionExample
{
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 RecipesApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
var repositoryPolicySubject = new RepositoryPolicySubject(); // RepositoryPolicySubject |
try
{
// Remove a Repository permissions
apiInstance.DeleteRecipeOrgPermission(owner, name, repositoryPolicySubject);
}
catch (ApiException e)
{
Debug.Print("Exception when calling RecipesApi.DeleteRecipeOrgPermission: " + 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 GetRecipe (string owner, string name)
Get a recipe
Retrieve a recipe by name
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class GetRecipeExample
{
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 RecipesApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
try
{
// Get a recipe
Repository result = apiInstance.GetRecipe(owner, name);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling RecipesApi.GetRecipe: " + 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 GetRecipeAccessPermissions (string owner, string name, int? page = null, int? perPage = null, List subjectType = null, List permission = null)
Get recipe access permissions
Retrieve a recipe'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 GetRecipeAccessPermissionsExample
{
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 RecipesApi(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 recipe access permissions
RepositoryAccessPolicyList result = apiInstance.GetRecipeAccessPermissions(owner, name, page, perPage, subjectType, permission);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling RecipesApi.GetRecipeAccessPermissions: " + 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]
RecipePackage GetRecipeByTag (string owner, string name, string tag)
Get a recipe tag
Retrieve a recipe 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 GetRecipeByTagExample
{
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 RecipesApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
var tag = tag_example; // string |
try
{
// Get a recipe tag
RecipePackage result = apiInstance.GetRecipeByTag(owner, name, tag);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling RecipesApi.GetRecipeByTag: " + 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]
RecipePackageList ListRecipeTags (string owner, string name, PackageSortKey? sortBy = null, SortEnum? sortOrder = null, int? page = null, int? perPage = null)
Get a recipe tags
Retrieve a recipe by name
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class ListRecipeTagsExample
{
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 RecipesApi(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 recipe tags
RecipePackageList result = apiInstance.ListRecipeTags(owner, name, sortBy, sortOrder, page, perPage);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling RecipesApi.ListRecipeTags: " + 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 ListRecipes (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 recipes
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class ListRecipesExample
{
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 RecipesApi(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 recipes
RepositoryList result = apiInstance.ListRecipes(search, name, owner, _public, keyword, permission, sortBy, sortOrder, page, perPage);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling RecipesApi.ListRecipes: " + 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 UpdateRecipe (string owner, string name, RepositoryUpdate repositoryUpdate)
Update a Recipe
Update a recipe (must have contribute
permission)
using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;
namespace Example
{
public class UpdateRecipeExample
{
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 RecipesApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
var repositoryUpdate = new RepositoryUpdate(); // RepositoryUpdate |
try
{
// Update a Recipe
UpdateAccepted result = apiInstance.UpdateRecipe(owner, name, repositoryUpdate);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling RecipesApi.UpdateRecipe: " + 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 UpsertRecipePermission (string owner, string name, RepositoryAccessPolicy repositoryAccessPolicy)
Upsert a new permission to a recipe
Upsert a recipe'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 UpsertRecipePermissionExample
{
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 RecipesApi(Configuration.Default);
var owner = owner_example; // string |
var name = name_example; // string |
var repositoryAccessPolicy = new RepositoryAccessPolicy(); // RepositoryAccessPolicy |
try
{
// Upsert a new permission to a recipe
UpdateAccepted result = apiInstance.UpsertRecipePermission(owner, name, repositoryAccessPolicy);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling RecipesApi.UpsertRecipePermission: " + 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]