MechaMental
Api reference

Comments

List Comments

GET
/v1/orgs/{org_id}/comments

Query Parameters

resource_type*Resource Type
resource_id*Resource Id
workspace_id*Workspace Id
limit?Limit
Default50
Range1 <= value <= 200
cursor?string|null

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/orgs/{org_id}/comments?resource_type=string&resource_id=string&workspace_id=string"
{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "comments": [
    {
      "id": "string",
      "augmentation_id": "string",
      "resource_type": "string",
      "resource_id": "string",
      "parent_id": "string",
      "content": "string",
      "user_id": "string",
      "user_name": "string",
      "resolved": false,
      "created_at": "string",
      "updated_at": "string",
      "replies": [
        {
          "id": "string",
          "augmentation_id": "string",
          "resource_type": "string",
          "resource_id": "string",
          "parent_id": "string",
          "content": "string",
          "user_id": "string",
          "user_name": "string",
          "resolved": false,
          "created_at": "string",
          "updated_at": "string",
          "replies": []
        }
      ]
    }
  ],
  "comment_counts": {
    "property1": 0,
    "property2": 0
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create Comment

POST
/v1/orgs/{org_id}/comments

Query Parameters

workspace_id*Workspace Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://loading/v1/orgs/{org_id}/comments?workspace_id=string" \  -H "Content-Type: application/json" \  -d '{    "resource_type": "pipeline_step",    "resource_id": "string",    "content": "string"  }'
{
  "id": "string",
  "augmentation_id": "string",
  "resource_type": "string",
  "resource_id": "string",
  "parent_id": "string",
  "content": "string",
  "user_id": "string",
  "user_name": "string",
  "resolved": false,
  "created_at": "string",
  "updated_at": "string",
  "replies": [
    {
      "id": "string",
      "augmentation_id": "string",
      "resource_type": "string",
      "resource_id": "string",
      "parent_id": "string",
      "content": "string",
      "user_id": "string",
      "user_name": "string",
      "resolved": false,
      "created_at": "string",
      "updated_at": "string",
      "replies": []
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List Comments By Augmentation

GET
/v1/orgs/{org_id}/comments/by-augmentation/{augmentation_id}

Path Parameters

augmentation_id*Augmentation Id

Query Parameters

workspace_id*Workspace Id
limit?Limit
Default50
Range1 <= value <= 200
cursor?string|null

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/orgs/{org_id}/comments/by-augmentation/string?workspace_id=string"
{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "comments": [
    {
      "id": "string",
      "augmentation_id": "string",
      "resource_type": "string",
      "resource_id": "string",
      "parent_id": "string",
      "content": "string",
      "user_id": "string",
      "user_name": "string",
      "resolved": false,
      "created_at": "string",
      "updated_at": "string",
      "replies": [
        {
          "id": "string",
          "augmentation_id": "string",
          "resource_type": "string",
          "resource_id": "string",
          "parent_id": "string",
          "content": "string",
          "user_id": "string",
          "user_name": "string",
          "resolved": false,
          "created_at": "string",
          "updated_at": "string",
          "replies": []
        }
      ]
    }
  ],
  "comment_counts": {
    "property1": 0,
    "property2": 0
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get Comment Counts

GET
/v1/orgs/{org_id}/comments/by-augmentation/{augmentation_id}/counts

Path Parameters

augmentation_id*Augmentation Id

Query Parameters

workspace_id*Workspace Id

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/orgs/{org_id}/comments/by-augmentation/string/counts?workspace_id=string"
null
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update Comment

PATCH
/v1/orgs/{org_id}/comments/{comment_id}

Path Parameters

comment_id*Comment Id

Query Parameters

resource_type*Resource Type
resource_id*Resource Id
workspace_id*Workspace Id

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PATCH "https://loading/v1/orgs/{org_id}/comments/string?resource_type=string&resource_id=string&workspace_id=string" \  -H "Content-Type: application/json" \  -d '{    "content": "string"  }'
{
  "id": "string",
  "augmentation_id": "string",
  "resource_type": "string",
  "resource_id": "string",
  "parent_id": "string",
  "content": "string",
  "user_id": "string",
  "user_name": "string",
  "resolved": false,
  "created_at": "string",
  "updated_at": "string",
  "replies": [
    {
      "id": "string",
      "augmentation_id": "string",
      "resource_type": "string",
      "resource_id": "string",
      "parent_id": "string",
      "content": "string",
      "user_id": "string",
      "user_name": "string",
      "resolved": false,
      "created_at": "string",
      "updated_at": "string",
      "replies": []
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Delete Comment

DELETE
/v1/orgs/{org_id}/comments/{comment_id}

Path Parameters

comment_id*Comment Id

Query Parameters

resource_type*Resource Type
resource_id*Resource Id
workspace_id*Workspace Id

Header Parameters

authorization?string|null

Response Body

application/json

curl -X DELETE "https://loading/v1/orgs/{org_id}/comments/string?resource_type=string&resource_id=string&workspace_id=string"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Resolve Comment

PATCH
/v1/orgs/{org_id}/comments/{comment_id}/resolve

Path Parameters

comment_id*Comment Id

Query Parameters

resource_type*Resource Type
resource_id*Resource Id
workspace_id*Workspace Id

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X PATCH "https://loading/v1/orgs/{org_id}/comments/string/resolve?resource_type=string&resource_id=string&workspace_id=string"
{
  "id": "string",
  "augmentation_id": "string",
  "resource_type": "string",
  "resource_id": "string",
  "parent_id": "string",
  "content": "string",
  "user_id": "string",
  "user_name": "string",
  "resolved": false,
  "created_at": "string",
  "updated_at": "string",
  "replies": [
    {
      "id": "string",
      "augmentation_id": "string",
      "resource_type": "string",
      "resource_id": "string",
      "parent_id": "string",
      "content": "string",
      "user_id": "string",
      "user_name": "string",
      "resolved": false,
      "created_at": "string",
      "updated_at": "string",
      "replies": []
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Commands

Previous Page

Commits

Next Page