Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qwiet comments API

The text threads (with individual comments ordered by time) attached to findings.[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/9829310-49dbc330-9cb4-4dac-9257-a9cc79b1103c?action=collection%2Ffork&collection-url=entityId%3D9829310-49dbc330-9cb4-4dac-9257-a9cc79b1103c%26entityType%3Dcollection%26workspaceId%3Da63f69cc-5c31-4f2b-8d28-b647f83b9e97)

Qwiet comments API is one of 27 APIs that Qwiet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include comments. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 3 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 4.0.0.

Requests are made against a single base URL, https://app.shiftleft.io/api/v4.

3 operations 2 paths 4 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.0
Base URL
https://app.shiftleft.io/api/v4
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Qwiet comments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken).

  • BearerToken — Use of the Qwiet API requires an access token, which is available via the Qwiet Dashboard (either under [Account Settings](https://app.shiftleft.io/user/profil…

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

comments 3

The text threads (with individual comments ordered by time) attached to findings. [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/98…

POST
/orgs/{orgID}/apps/{appID}/findings/{findingID}/comments
Create app finding comment
CreateAppFindingComment 3 params body → 200default
GET
/orgs/{orgID}/apps/{appID}/findings/{findingID}/comments
List app finding comments
ListAppFindingComments 3 params → 200default
GET
/orgs/{orgID}/apps/{appID}/findings/{findingID}/comments/{commentID}
Read specific comment for a finding
ReadOneAppFindingComment 4 params → 200default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Comment (7 properties), Error (4 properties), CommentRequest (1 property), SuccessResponse (1 property). Each schema is shown below with its type and property counts.

Error
object
4 properties 3 required
SuccessResponse
object
1 property 1 required
CommentRequest
object
1 property
Comment
object
7 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qwiet-comments-api-openapi.yml Raw ↑

Other APIs Qwiet publishes across the network.

Qwiet alerting API
Qwiet analyze API
Qwiet app_groups API
Qwiet app_labels API
Qwiet apps API
Qwiet autofix API
Qwiet azureboard API
Qwiet branches API
Qwiet compounds API
Qwiet findings API
Qwiet org_backup API
Qwiet orgs API