[go: up one dir, main page]

Skip to content

Notes API: Add Type field

Release notes

It is hard to differentiate between from the point of the view of the API.

Problem to solve

When using the Notes API it hard to differentiate between different times of events e.g. if a pull request is changed because there is a new commit or when it is no longer WIP.

Intended users

User experience goal

Users that use Applications that use the Gitlab Notes API would have an easier time using Gitlab.

Proposal

Add a type field to the note object and add different types of notes per type of notes e.g. pull-request or issue.

Further details

A tool that listens to any event could see if it worth to issue a notification to a user or trigger another event e.g. a CI event.

Permissions and Security

They don't require additional permissions, everything is already there just no as good to use.

Documentation

Document changes in the Note API

Availability & Testing

Add test for the extended API.

Links / references

See the discussion here about the caveats in the Gitlab Notes API while parsing events: https://github.com/magit/forge/issues/318