diff mbox series

[9/9] release-notes: Add release notes for the patch note feature

Message ID 20240313065642.385843-9-andrepapoti@gmail.com
State New
Headers show
Series [1/9] models: Add Note model | expand

Commit Message

andrepapoti March 13, 2024, 6:56 a.m. UTC 
---
 .../notes/issue-441-8392549b54b1178d.yaml         | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 releasenotes/notes/issue-441-8392549b54b1178d.yaml
diff mbox series

Patch

diff --git a/releasenotes/notes/issue-441-8392549b54b1178d.yaml b/releasenotes/notes/issue-441-8392549b54b1178d.yaml
new file mode 100644
index 0000000..df40f85
--- /dev/null
+++ b/releasenotes/notes/issue-441-8392549b54b1178d.yaml
@@ -0,0 +1,15 @@ 
+---
+features:
+  - |
+    Added notes feature allowing maintainers of a patch to write notes for it so that maintainers
+    can understand why a patch is in any given state or to give any contextual information others
+    may not have. These can also be public so that any user can read them.
+api:
+  - |
+    The API version has been updated to v1.4.
+  - |
+    A new REST API endpoint is available at ``/api/patches/<patch_id>/notes``.
+    This can be used to create a new note or to retrive all notes from the specified patch
+  - |
+    A new REST API endpoint is available at ``/api/patches/<patch_id>/notes/<note_id>``.
+    This can be used to retrieve, update and delete the specified note