Skip to content

Latest commit

 

History

History
351 lines (223 loc) · 12.4 KB

RegistryApi.md

File metadata and controls

351 lines (223 loc) · 12.4 KB
Raw

\RegistryApi

All URIs are relative to http://localhost/api/v2.0

Method HTTP request Description
CreateRegistry Post /registries Create a registry
DeleteRegistry Delete /registries/{id} Delete the specific registry
GetRegistry Get /registries/{id} Get the specific registry
GetRegistryInfo Get /registries/{id}/info Get the registry info
ListRegistries Get /registries List the registries
ListRegistryProviderInfos Get /replication/adapterinfos List all registered registry provider information
ListRegistryProviderTypes Get /replication/adapters List registry adapters
PingRegistry Post /registries/ping Check status of a registry
UpdateRegistry Put /registries/{id} Update the registry

CreateRegistry

CreateRegistry(ctx, registry, optional) Create a registry

Create a registry

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
registry Registry The registry
optional *RegistryApiCreateRegistryOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RegistryApiCreateRegistryOpts struct

Name Type Description Notes

xRequestId | optional.String| An unique ID for the request |

Return type

(empty response body)

Authorization

basic

HTTP request headers

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

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

DeleteRegistry

DeleteRegistry(ctx, id, optional) Delete the specific registry

Delete the specific registry

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int64 Registry ID
optional *RegistryApiDeleteRegistryOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RegistryApiDeleteRegistryOpts struct

Name Type Description Notes

xRequestId | optional.String| An unique ID for the request |

Return type

(empty response body)

Authorization

basic

HTTP request headers

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

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

GetRegistry

Registry GetRegistry(ctx, id, optional) Get the specific registry

Get the specific registry

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int64 Registry ID
optional *RegistryApiGetRegistryOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RegistryApiGetRegistryOpts struct

Name Type Description Notes

xRequestId | optional.String| An unique ID for the request |

Return type

Registry

Authorization

basic

HTTP request headers

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

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

GetRegistryInfo

RegistryInfo GetRegistryInfo(ctx, id, optional) Get the registry info

Get the registry info

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int64 Registry ID
optional *RegistryApiGetRegistryInfoOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RegistryApiGetRegistryInfoOpts struct

Name Type Description Notes

xRequestId | optional.String| An unique ID for the request |

Return type

RegistryInfo

Authorization

basic

HTTP request headers

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

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

ListRegistries

[]Registry ListRegistries(ctx, optional) List the registries

List the registries

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *RegistryApiListRegistriesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RegistryApiListRegistriesOpts struct

Name Type Description Notes
xRequestId optional.String An unique ID for the request
q optional.String Query string to query resources. Supported query patterns are "exact match(k=v)", "fuzzy match(k=v)", "range(k=[minmax])", "list with union releationship(k={v1 v2 v3})" and "list with intersetion relationship(k=(v1 v2 v3))". The value of range and list can be string(enclosed by " or '), integer or time(in format "2020-04-09 02:36:00"). All of these query patterns should be put in the query string "q=xxx" and splitted by ",". e.g. q=k1=v1,k2=v2,k3=[minmax]
sort optional.String Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with "sort=field1,-field2"
page optional.Int64 The page number [default to 1]
pageSize optional.Int64 The size of per page [default to 10]
name optional.String Deprecated, use `q` instead.

Return type

[]Registry

Authorization

basic

HTTP request headers

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

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

ListRegistryProviderInfos

map[string]RegistryProviderInfo ListRegistryProviderInfos(ctx, optional) List all registered registry provider information

List all registered registry provider information

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *RegistryApiListRegistryProviderInfosOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RegistryApiListRegistryProviderInfosOpts struct

Name Type Description Notes
xRequestId optional.String An unique ID for the request

Return type

map[string]RegistryProviderInfo

Authorization

basic

HTTP request headers

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

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

ListRegistryProviderTypes

[]string ListRegistryProviderTypes(ctx, optional) List registry adapters

List registry adapters

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *RegistryApiListRegistryProviderTypesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RegistryApiListRegistryProviderTypesOpts struct

Name Type Description Notes
xRequestId optional.String An unique ID for the request

Return type

[]string

Authorization

basic

HTTP request headers

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

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

PingRegistry

PingRegistry(ctx, registry, optional) Check status of a registry

Check status of a registry

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
registry RegistryPing The registry
optional *RegistryApiPingRegistryOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RegistryApiPingRegistryOpts struct

Name Type Description Notes

xRequestId | optional.String| An unique ID for the request |

Return type

(empty response body)

Authorization

basic

HTTP request headers

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

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

UpdateRegistry

UpdateRegistry(ctx, id, registry, optional) Update the registry

Update the registry

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int64 The registry ID
registry RegistryUpdate The registry
optional *RegistryApiUpdateRegistryOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RegistryApiUpdateRegistryOpts struct

Name Type Description Notes

xRequestId | optional.String| An unique ID for the request |

Return type

(empty response body)

Authorization

basic

HTTP request headers

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

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