v1/audits

An audit is a check of the entire repository to ensure that it is intact. This is typically described as testing the fixity of all of the repository’s content.

GET /v1/audits

List all audits. No pagination is provided in this version.

Request Headers:  

• Authorization – Bearer token

Response Headers:  

• Content-Type – application/json

Response JSON Array of Objects:  

• id (int) – The audit’s id
• successes (int) – The number of successful events thus far in this audit.
• failures (int) – The number of failed events thus far in this audit.
• packages (int) – The total number of packages in this audit.
• updated_at (date) – Datetime when the object was last changed

Response JSON Object:  

• user (string) – Owning user’s username

Status Codes:

• 200 OK – Success
• 401 Unauthorized – Unauthenticated

POST /v1/audits

Audit the system; the logical audit is represented by the created resource.

Request Headers:  

• Authorization – Bearer token

Status Codes:

• 201 Created – Includes Location header with url to resource, /audits/id.
• 401 Unauthorized – Unauthenticated
• 403 Forbidden – User is not an administrator.

GET /v1/audits/(id)

Show a specific audit. The audit may be completed, or it may still be in progress; compare the total count of successful and failed events against the count of packages being audited to determine if the audit is complete.

Response Headers:  

• Content-Type – application/json

Response JSON Object:  

• id (int) – The audit’s id
• user (string) – Owning user’s username
• successes (array) – An array of successful events.
• failures (array) – An array of failed events.
• packages (int) – The total number of packages in this audit.
• updated_at (date) – Datetime when the object was last changed

Status Codes:

• 200 OK – Success
• 401 Unauthorized – Unauthenticated
• 403 Forbidden – User does not own the resource, and is not an admin.
• 404 Not Found – Not found