diff --git a/docs/developing/reference/api.txt b/docs/developing/reference/api.txt index f584a8fb..f2bd5e66 100644 --- a/docs/developing/reference/api.txt +++ b/docs/developing/reference/api.txt @@ -495,9 +495,15 @@ Resources } } -.. http:put:: /resources/{uuid:resouce instance id} +.. http:put:: /resources/{uuid: graph id}/{uuid:resource instance id} - updates a single resource instance + .. note:: + Instead of identifying a graph by a UUID, one can also identify a graph by by a slug identifier. + To get or set the slug for the graph, navigate to the root node of the :ref:`Graph Designer`. A request using a slug identifier for a graph looks like: + ``PUT /resources/{string: graph slug}/{uuid:resource instance id}`` + + + Updates a single resource instance :query format: {"json-ld", "arches-json"} :query indent: number of spaces to indent json output @@ -508,7 +514,7 @@ Resources .. code-block:: none - curl -H "Authorization: Bearer {token}" -X PUT -d {data in json-ld format} http://localhost:8000/resources/{resource instance id} + curl -H "Authorization: Bearer {token}" -X PUT -d {data in json-ld format} http://localhost:8000/resources/{graph id}/{resource instance id} curl -H "Authorization: Bearer zo41Q1IMgAW30xOroiCUxjv3yci8Os" -X PUT \ -d '{