Skip to content

Latest commit

 

History

History
261 lines (168 loc) · 9.32 KB

GrafeasApi.md

File metadata and controls

261 lines (168 loc) · 9.32 KB
Raw

\GrafeasApi

All URIs are relative to http://localhost

Method HTTP request Description
CreateNote Post /v1alpha1/{parent}/notes Creates a new `Note`.
CreateOccurrence Post /v1alpha1/{parent}/occurrences Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource.
CreateOperation Post /v1alpha1/{parent}/operations Creates a new `Operation`.
GetOccurrenceNote Get /v1alpha1/{name}/notes Gets the `Note` attached to the given `Occurrence`.
ListNoteOccurrences Get /v1alpha1/{name}/occurrences Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer projects.
ListNotes Get /v1alpha1/{parent}/notes Lists all `Notes` for a given project.
ListOccurrences Get /v1alpha1/{parent}/occurrences Lists active `Occurrences` for a given project matching the filters.
UpdateNote Patch /v1alpha1/{name} Updates an existing `Note`.

CreateNote

ApiNote CreateNote(ctx, parent, body) Creates a new Note.

Required Parameters

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

Return type

ApiNote

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]

CreateOccurrence

ApiOccurrence CreateOccurrence(ctx, parent, body) Creates a new Occurrence. Use this method to create Occurrences for a resource.

Required Parameters

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

Return type

ApiOccurrence

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]

CreateOperation

LongrunningOperation CreateOperation(ctx, parent, body) Creates a new Operation.

Required Parameters

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

Return type

LongrunningOperation

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]

GetOccurrenceNote

ApiNote GetOccurrenceNote(ctx, name) Gets the Note attached to the given Occurrence.

Required Parameters

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

Return type

ApiNote

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]

ListNoteOccurrences

ApiListNoteOccurrencesResponse ListNoteOccurrences(ctx, name, optional) Lists Occurrences referencing the specified Note. Use this method to get all occurrences referencing your Note across all your customer projects.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ListNoteOccurrencesOpts struct

Name Type Description Notes

filter | optional.String| The filter expression. | pageSize | optional.Int32| Number of notes to return in the list. | pageToken | optional.String| Token to provide to skip to a particular spot in the list. |

Return type

ApiListNoteOccurrencesResponse

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]

ListNotes

ApiListNotesResponse ListNotes(ctx, parent, optional) Lists all Notes for a given project.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ListNotesOpts struct

Name Type Description Notes

filter | optional.String| The filter expression. | pageSize | optional.Int32| Number of notes to return in the list. | pageToken | optional.String| Token to provide to skip to a particular spot in the list. |

Return type

ApiListNotesResponse

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]

ListOccurrences

ApiListOccurrencesResponse ListOccurrences(ctx, parent, optional) Lists active Occurrences for a given project matching the filters.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ListOccurrencesOpts struct

Name Type Description Notes

filter | optional.String| The filter expression. | pageSize | optional.Int32| Number of occurrences to return in the list. | pageToken | optional.String| Token to provide to skip to a particular spot in the list. |

Return type

ApiListOccurrencesResponse

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]

UpdateNote

ApiNote UpdateNote(ctx, name, body) Updates an existing Note.

Required Parameters

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

Return type

ApiNote

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]