Sign in

v1

latestOpenAPI 3.1.02026-07-174721.3 KB
Stewardship Actions

Assign a steward to a stewardship

Assigns a user as a steward with the given role. If the user is already an active steward, the role is updated (soft-delete + re-insert). Returns the unchanged stewardship record and the full active stewards list after the operation.

post/stewardships/{id}/assign

Path parameters

idinteger required

Stewardship ID.

Request body

notestring

Optional free-text note for the activity log.

moveToAssessingboolean

If true, atomically transitions the stewardship status to assessing in the same transaction as the assignment. Use for the "Assign & move to Assessing" action to avoid a second round-trip.

Example request

{
  "steward": {
    "userId": "abc123",
    "username": "joanagmaia",
    "displayName": "Joana Maia"
  },
  "actor": {
    "userId": "auth0|abc123",
    "username": "gaspergrom",
    "displayName": "Gašper Grom",
    "avatarUrl": "https://avatars.githubusercontent.com/u/12345"
  }
}

Response

Steward assigned.

Example response

{
  "stewardship": {
    "id": "42",
    "packageId": "1234",
    "version": 1,
    "statusNote": "Contacted maintainer, no response after 30 days."
  },
  "stewards": [
    {
      "id": "7",
      "stewardshipId": "42",
      "userId": "abc123",
      "username": "joanagmaia",
      "displayName": "Joana Maia",
      "assignedBy": "xyz789"
    }
  ]
}