Skip to content

Latest commit

 

History

History
212 lines (135 loc) · 9.08 KB

RepositoryApi.md

File metadata and controls

212 lines (135 loc) · 9.08 KB

\RepositoryApi

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

Method HTTP request Description
DeleteRepository Delete /projects/{project_name}/repositories/{repository_name} Delete repository
GetRepository Get /projects/{project_name}/repositories/{repository_name} Get repository
ListAllRepositories Get /repositories List all authorized repositories
ListRepositories Get /projects/{project_name}/repositories List repositories
UpdateRepository Put /projects/{project_name}/repositories/{repository_name} Update repository

DeleteRepository

DeleteRepository(ctx, projectName, repositoryName, optional) Delete repository

Delete the repository specified by name

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectName string The name of the project
repositoryName string The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
optional *RepositoryApiDeleteRepositoryOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RepositoryApiDeleteRepositoryOpts 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]

GetRepository

Repository GetRepository(ctx, projectName, repositoryName, optional) Get repository

Get the repository specified by name

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectName string The name of the project
repositoryName string The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
optional *RepositoryApiGetRepositoryOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RepositoryApiGetRepositoryOpts struct

Name Type Description Notes

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

Return type

Repository

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]

ListAllRepositories

[]Repository ListAllRepositories(ctx, optional) List all authorized repositories

List all authorized repositories

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a RepositoryApiListAllRepositoriesOpts 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]

Return type

[]Repository

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]

ListRepositories

[]Repository ListRepositories(ctx, projectName, optional) List repositories

List repositories of the specified project

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectName string The name of the project
optional *RepositoryApiListRepositoriesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RepositoryApiListRepositoriesOpts 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]

Return type

[]Repository

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]

UpdateRepository

UpdateRepository(ctx, projectName, repositoryName, repository, optional) Update repository

Update the repository specified by name

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectName string The name of the project
repositoryName string The name of the repository. If it contains slash, encode it with URL encoding. e.g. a/b -> a%252Fb
repository Repository The JSON object of repository.
optional *RepositoryApiUpdateRepositoryOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RepositoryApiUpdateRepositoryOpts 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]