Skip to content

RegistriesApi.md

Latest commit

 

History

History
440 lines (336 loc) · 13.3 KB

RegistriesApi.md

File metadata and controls

440 lines (336 loc) · 13.3 KB

PollinationSDK.Api.RegistriesApi

All URIs are relative to http://localhost

Method HTTP request Description
GetPackage GET /registries/{owner}/{type}/{name}/{digest} Get Package
GetPackageJson GET /registries/{owner}/{type}/{name}/{digest}/json Get Package in JSON format
GetRegistryIndex GET /registries/{owner}/index.json Get Registry Index
PostPlugin POST /registries/{owner}/plugins Push a plugin to the registry
PostRecipe POST /registries/{owner}/recipes Push an Recipe to the registry

GetPackage

AnyType GetPackage (string owner, string type, string name, string digest)

Get Package

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class GetPackageExample
    {
        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 RegistriesApi(Configuration.Default);
            var owner = owner_example;  // string | 
            var type = type_example;  // string | 
            var name = name_example;  // string | 
            var digest = digest_example;  // string | 

            try
            {
                // Get Package
                AnyType result = apiInstance.GetPackage(owner, type, name, digest);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling RegistriesApi.GetPackage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
owner string
type string
name string
digest string

Return type

AnyType

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/x-tar

HTTP response details

Status code Description Response headers
200 Retrieved -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPackageJson

AnyOfRecipePluginBakedRecipe GetPackageJson (string owner, string type, string name, string digest, bool? baked = null)

Get Package in JSON format

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class GetPackageJsonExample
    {
        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 RegistriesApi(Configuration.Default);
            var owner = owner_example;  // string | 
            var type = type_example;  // string | 
            var name = name_example;  // string | 
            var digest = digest_example;  // string | 
            var baked = true;  // bool? |  (optional)  (default to false)

            try
            {
                // Get Package in JSON format
                AnyOfRecipePluginBakedRecipe result = apiInstance.GetPackageJson(owner, type, name, digest, baked);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling RegistriesApi.GetPackageJson: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
owner string
type string
name string
digest string
baked bool? [optional] [default to false]

Return type

AnyOfRecipePluginBakedRecipe

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Retrieved -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRegistryIndex

RepositoryIndex GetRegistryIndex (string owner)

Get Registry Index

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class GetRegistryIndexExample
    {
        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 RegistriesApi(Configuration.Default);
            var owner = owner_example;  // string | 

            try
            {
                // Get Registry Index
                RepositoryIndex result = apiInstance.GetRegistryIndex(owner);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling RegistriesApi.GetRegistryIndex: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
owner string

Return type

RepositoryIndex

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Retrieved -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostPlugin

AnyType PostPlugin (string owner, string type = null, System.IO.Stream package = null)

Push a plugin to the registry

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class PostPluginExample
    {
        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 RegistriesApi(Configuration.Default);
            var owner = owner_example;  // string | 
            var type = type_example;  // string |  (optional)  (default to "Body_cython_function_or_method__owner__plugins_post")
            var package = BINARY_DATA_HERE;  // System.IO.Stream |  (optional) 

            try
            {
                // Push a plugin to the registry
                AnyType result = apiInstance.PostPlugin(owner, type, package);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling RegistriesApi.PostPlugin: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
owner string
type string [optional] [default to "Body_cython_function_or_method__owner__plugins_post"]
package System.IO.Stream [optional]

Return type

AnyType

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostRecipe

AnyType PostRecipe (string owner, string type = null, System.IO.Stream package = null)

Push an Recipe to the registry

Example

using System.Collections.Generic;
using System.Diagnostics;
using PollinationSDK.Api;
using PollinationSDK.Client;
using PollinationSDK.Model;

namespace Example
{
    public class PostRecipeExample
    {
        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 RegistriesApi(Configuration.Default);
            var owner = owner_example;  // string | 
            var type = type_example;  // string |  (optional)  (default to "Body_post_recipe__owner__recipes_post")
            var package = BINARY_DATA_HERE;  // System.IO.Stream |  (optional) 

            try
            {
                // Push an Recipe to the registry
                AnyType result = apiInstance.PostRecipe(owner, type, package);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling RegistriesApi.PostRecipe: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
owner string
type string [optional] [default to "Body_post_recipe__owner__recipes_post"]
package System.IO.Stream [optional]

Return type

AnyType

Authorization

APIKeyAuth, JWTAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]