danger-api

Submit a project observation

Changed on

Submit a Project Observation to the PyPI team for review.

post/danger-api/projects/{name}/observations

Request

  • The document declares no server URL.
  • Auth
    • HTTP bearer
    • or HTTP token
    • or HTTP basic

Path parameters

namestring required
Example:project-name

The name of the Project

Request body

kind'is_malware' | 'is_spam' | 'is_dependency_confusion' | 'something_else' required

The kind of observation

inspector_urlstring

A link to notable source code using our Inspector service. Required if kind=is_malware

summarystring required

A brief summary of the observation

Example request

{
  "kind": "is_malware",
  "summary": "This project is distributing malware"
}

Response

Observation submitted

projectstring
thanksstring

Example response

{
  "project": "project-name",
  "thanks": "for the observation"
}

Changes

    • info

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

    • info

      added the non-success response with the status