docs(api): add release links API docs

nejch · nejch · commit 36d65f03db25 · 2021-02-21T12:45:12.000+01:00
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
@@ -37,6 +37,7 @@ API examples
    gl_objects/pipelines_and_jobs
    gl_objects/projects
    gl_objects/protected_branches
+   gl_objects/releases
    gl_objects/runners
    gl_objects/remote_mirrors
    gl_objects/repositories
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -702,39 +702,6 @@ Delete project push rules::
 
     pr.delete()
 
-Project releases
-================
-
-Reference
----------
-
-* v4 API:
-
-  + :class:`gitlab.v4.objects.ProjectRelease`
-  + :class:`gitlab.v4.objects.ProjectReleaseManager`
-  + :attr:`gitlab.v4.objects.Project.releases`
-
-* Gitlab API: https://docs.gitlab.com/ee/api/releases/index.html
-
-Examples
---------
-
-Get a list of releases from a project::
-
-    release = project.releases.list()
-
-Get a single release::
-
-    release = project.releases.get('v1.2.3')
-
-Create a release for a project tag::
-
-    release = project.releases.create({'name':'Demo Release', 'tag_name':'v1.2.3', 'description':'release notes go here'})
-
-Delete a release::
-
-    release = p.releases.delete('v1.2.3')
-
 Project protected tags
 ======================
 
diff --git a/docs/gl_objects/releases.rst b/docs/gl_objects/releases.rst
@@ -0,0 +1,77 @@
+########
+Releases
+########
+
+Project releases
+================
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectRelease`
+  + :class:`gitlab.v4.objects.ProjectReleaseManager`
+  + :attr:`gitlab.v4.objects.Project.releases`
+
+* Gitlab API: https://docs.gitlab.com/ee/api/releases/index.html
+
+Examples
+--------
+
+Get a list of releases from a project::
+
+    release = project.releases.list()
+
+Get a single release::
+
+    release = project.releases.get('v1.2.3')
+
+Create a release for a project tag::
+
+    release = project.releases.create({'name':'Demo Release', 'tag_name':'v1.2.3', 'description':'release notes go here'})
+
+Delete a release::
+
+    # via its tag name from project attributes
+    release = project.releases.delete('v1.2.3')
+
+    # delete object directly
+    release.delete()
+
+Project release links
+=====================
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectReleaseLink`
+  + :class:`gitlab.v4.objects.ProjectReleaseLinkManager`
+  + :attr:`gitlab.v4.objects.ProjectRelease.links`
+
+* Gitlab API: https://docs.gitlab.com/ee/api/releases/links.html
+
+Examples
+--------
+
+Get a list of releases from a project::
+
+    links = release.links.list()
+
+Get a single release link::
+
+    link = release.links.get(1)
+
+Create a release link for a release::
+
+    link = release.links.create({"url": "https://example.com/asset", "name": "asset"})
+
+Delete a release link::
+
+    # via its ID from release attributes
+    release.links.delete(1)
+
+    # delete object directly
+    link.delete()
