Skip to content

Latest commit

 

History

History
316 lines (173 loc) · 10.7 KB

AddonApi.md

File metadata and controls

316 lines (173 loc) · 10.7 KB

\AddonApi

All URIs are relative to https://api.bitbucket.org/2.0

Method HTTP request Description
AddonDelete Delete /addon
AddonLinkersGet Get /addon/linkers
AddonLinkersLinkerKeyGet Get /addon/linkers/{linker_key}
AddonLinkersLinkerKeyValuesDelete Delete /addon/linkers/{linker_key}/values
AddonLinkersLinkerKeyValuesDelete_0 Delete /addon/linkers/{linker_key}/values/
AddonLinkersLinkerKeyValuesGet Get /addon/linkers/{linker_key}/values
AddonLinkersLinkerKeyValuesGet_0 Get /addon/linkers/{linker_key}/values/
AddonLinkersLinkerKeyValuesPost Post /addon/linkers/{linker_key}/values
AddonLinkersLinkerKeyValuesPut Put /addon/linkers/{linker_key}/values
AddonPut Put /addon
AddonUsersTargetUserEventsEventKeyPost Post /addon/users/{target_user}/events/{event_key}

AddonDelete

ModelError AddonDelete(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

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

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

AddonLinkersGet

ModelError AddonLinkersGet(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

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

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

AddonLinkersLinkerKeyGet

ModelError AddonLinkersLinkerKeyGet(ctx, linkerKey)

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
linkerKey string

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

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

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

AddonLinkersLinkerKeyValuesDelete

ModelError AddonLinkersLinkerKeyValuesDelete(ctx, linkerKey)

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
linkerKey string

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

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

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

AddonLinkersLinkerKeyValuesDelete_0

ModelError AddonLinkersLinkerKeyValuesDelete_0(ctx, linkerKey)

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
linkerKey string

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

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

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

AddonLinkersLinkerKeyValuesGet

ModelError AddonLinkersLinkerKeyValuesGet(ctx, linkerKey)

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
linkerKey string

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

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

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

AddonLinkersLinkerKeyValuesGet_0

ModelError AddonLinkersLinkerKeyValuesGet_0(ctx, linkerKey)

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
linkerKey string

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

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

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

AddonLinkersLinkerKeyValuesPost

ModelError AddonLinkersLinkerKeyValuesPost(ctx, linkerKey)

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
linkerKey string

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

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

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

AddonLinkersLinkerKeyValuesPut

ModelError AddonLinkersLinkerKeyValuesPut(ctx, linkerKey)

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
linkerKey string

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

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

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

AddonPut

ModelError AddonPut(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

ModelError

Authorization

api_key, basic, oauth2

HTTP request headers

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

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

AddonUsersTargetUserEventsEventKeyPost

AddonUsersTargetUserEventsEventKeyPost(ctx, targetUser, eventKey)

POST a new custom event. The data within the event body will be hydrated by Bitbucket. For example, the following event submission would result in subscribers for the event receiving the full repository object corresponding to the UUID. $ curl -X POST -H \"Content-Type: application/json\" -d '{ \"mynumdata\": \"12345\", \"repository\": { \"type\": \"repository\", \"uuid\": \"{be95aa1f-c0b2-47f6-99d1-bf5d3a0f850f}\" }}' https://api.bitbucket.org/2.0/addon/users/myuser/events/com.example.app%3Amyevent Use the optional fields property of the custom event Connect module where the event is defined to add additional fields to the expanded payload sent to listeners. For example, the customEvents module in the app descriptor for the previous example would look like this: 'modules': { 'customEvents': { 'com.example.app:myevent': { 'schema': { 'properties': { 'mynumdata': {'type': 'number'}, 'repository': {'$ref': '#/definitions/repository'} } }, 'fields': ['repository.owner'] } } } By specifying fields as above, the repository owner will also be sent to subscribers of the event.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
targetUser string The account the app is installed in. This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
eventKey string The key of the event, which corresponds to an event defined in the connect app descriptor.

Return type

(empty response body)

Authorization

api_key, basic, oauth2

HTTP request headers

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

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