/api/collection

PUT /api/collection/graph

Changed on

Do a batch update of Collections Permissions by passing in a modified graph. Will overwrite parts of the graph that are present in the request, and leave the rest unchanged.

If the force query parameter is true, a revision number is not required. The provided graph will be persisted as-is, and has the potential to clobber other writes that happened since the last read.

If the skip_graph query parameter is true, it will only return the current revision, not the entire permissions graph.

put/api/collection/graph

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Query parameters

forceboolean nullable

value must be a valid boolean string ('true' or 'false').

skip-graphboolean nullable

value must be a valid boolean string ('true' or 'false').

Request body

groupsobject required
namespacestring nullable

value must be a non-blank string.

revisioninteger nullable

value must be an integer.

Response

Successful response

revisioninteger nullable

Changes

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • info

      the query request parameter force became optional

    • info

      the query request parameter skip-graph became optional

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added the media type application/json for the response with the status

    • info

      api operation id put-api-collection-graph was added