Skip to main content
POST
/
api
/
v1
/
proposals
Create proposal
curl --request POST \
  --url http://localhost:3000/api/v1/proposals \
  --header 'Content-Type: application/json' \
  --cookie nut-session= \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "priority": "medium",
  "tags": [
    "<string>"
  ],
  "author": {
    "type": "user",
    "id": "<string>",
    "name": "<string>"
  }
}
'
{
  "success": true,
  "data": {
    "proposal": {
      "id": "<string>",
      "title": "<string>",
      "status": "draft",
      "description": "<string>",
      "priority": "low",
      "tags": [
        "<string>"
      ],
      "author": {
        "type": "user",
        "id": "<string>",
        "name": "<string>"
      },
      "changes": [
        {
          "path": "<string>",
          "type": "create",
          "content": "<string>",
          "oldPath": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

nut-session
string
cookie
required

Session cookie authentication

Body

application/json
title
string
required

Proposal title

description
string

Detailed description

priority
enum<string>
default:medium
Available options:
low,
medium,
high,
critical
tags
string[]
author
object

Response

Proposal created

success
boolean
required
data
object