Skip to content

Latest commit

 

History

History
125 lines (79 loc) · 4.03 KB

GrafeasProjectsApi.md

File metadata and controls

125 lines (79 loc) · 4.03 KB
Raw

\GrafeasProjectsApi

All URIs are relative to http://localhost

Method HTTP request Description
CreateProject Post /v1alpha1/projects Creates a new `Project`.
DeleteProject Delete /v1alpha1/{name} Deletes the given `Project` from the system.
GetProject Get /v1alpha1/{name} Returns the requested `Project`.
ListProjects Get /v1alpha1/projects Lists `Projects`

CreateProject

ProtobufEmpty CreateProject(ctx, body) Creates a new Project.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ApiProject

Return type

ProtobufEmpty

Authorization

No authorization required

HTTP request headers

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

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

DeleteProject

ProtobufEmpty DeleteProject(ctx, name) Deletes the given Project from the system.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string

Return type

ProtobufEmpty

Authorization

No authorization required

HTTP request headers

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

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

GetProject

ApiProject GetProject(ctx, name) Returns the requested Project.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
name string

Return type

ApiProject

Authorization

No authorization required

HTTP request headers

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

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

ListProjects

ApiListProjectsResponse ListProjects(ctx, optional) Lists Projects

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ListProjectsOpts struct

Name Type Description Notes
filter optional.String The filter expression.
pageSize optional.Int32 Number of projects to return in the list.
pageToken optional.String Token to provide to skip to a particular spot in the list.

Return type

ApiListProjectsResponse

Authorization

No authorization required

HTTP request headers

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

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