connectors icon indicating copy to clipboard operation
connectors copied to clipboard

Add `Contents > Create or update file contents` operation to the OOTB GitHub Connector

Open wollefitz opened this issue 1 year ago • 4 comments

Is your feature request related to a problem? Please describe.

If I want to create or update GitHub file contents from my C8 process, I have to manually put in all necessary data using the REST Connector to call https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#create-or-update-file-contents. This is quite error-prone since I have to know all necessary headers and define the request body correctly.

Additionally, the GitHub API requires the file content passed in the request body to be Base64 encoded which requires cumbersome workarounds if the content is not already encoded when receiving it from another source (e.g. Web Modeler's REST API, see https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/getFile).

Describe the solution you'd like

Using the GitHub connector, I would like to have the option to create or update file contents. I would want to input as little data as possible and as much custom data as required. The file content passed in the request payload should be automatically Base64 encoded.

Describe alternatives you've considered

Use the REST Connector and define my own template once I figured out all the necessary headers and how to define the body correctly.

Additional context

  • API to run create or update file contents: https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#create-or-update-file-contents
  • Result of https://github.com/camunda/web-modeler/issues/7842

wollefitz avatar Feb 26 '24 11:02 wollefitz