Skip to content

Commit 4d6e5bf

Browse files
committed
docs(api): updated projects API docs
It was not covering some recently introduced parameters. See #19867
1 parent 4f00d4a commit 4d6e5bf

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

docs/api.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -941,6 +941,7 @@ Projects
941941
assigned to a workspace
942942
:>json string instructions: :ref:`project-instructions`
943943
:>json string language_aliases: :ref:`project-language_aliases`
944+
:>json string license: :ref:`project-license`
944945
:>json string announcements_url: URL to announcements; see :http:get:`/api/projects/(string:project)/announcements/`
945946

946947
**Example JSON data:**
@@ -961,6 +962,22 @@ Projects
961962

962963
Edit a project by a :http:method:`PATCH` request.
963964

965+
The ``project`` value is the project slug. To avoid using a wrong
966+
identifier, use the project ``url`` returned by :http:get:`/api/projects/`
967+
or :http:get:`/api/projects/(string:project)/`.
968+
969+
The request body accepts project fields such as ``instructions`` and
970+
``license``.
971+
972+
**Example JSON data:**
973+
974+
.. code-block:: json
975+
976+
{
977+
"instructions": "Translate consistently.",
978+
"license": "MIT"
979+
}
980+
964981
Changing ``workspace`` moves the project. Moving a project requires
965982
permission to edit the project and the :guilabel:`Edit workspace settings`
966983
permission for the source and target workspace. The target workspace also
@@ -970,6 +987,10 @@ Projects
970987

971988
:param project: Project URL slug
972989
:type project: string
990+
:param instructions: :ref:`project-instructions`
991+
:type instructions: string
992+
:param license: :ref:`project-license`
993+
:type license: string
973994
:param workspace: Optional workspace UUID, or ``null`` to move the project
974995
out of a workspace
975996
:type workspace: string
@@ -985,6 +1006,10 @@ Projects
9851006

9861007
:param project: Project URL slug
9871008
:type project: string
1009+
:param instructions: :ref:`project-instructions`
1010+
:type instructions: string
1011+
:param license: :ref:`project-license`
1012+
:type license: string
9881013

9891014
.. http:delete:: /api/projects/(string:project)/
9901015

0 commit comments

Comments
 (0)