Edit a project

PATCH

/orgs/{org}/projects/{id}

const url = 'https://gitea.com/api/v1/orgs/example/projects/1';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'},
  body: '{"card_type":"example","description":"example","state":"open","title":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://gitea.com/api/v1/orgs/example/projects/1 \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "card_type": "example", "description": "example", "state": "open", "title": "example" }'

Authorizations

Parameters

Path Parameters

org

required

string

Name of the organization

required

integer format: int64

Id of the project

Request Body

application/json

EditProjectOption represents options for editing a project

object

card_type

Card type: “text_only” or “images_and_text”

string

description

string

state

string

Allowed values: open closed

title

string

Responses

200

Project

application/json

Project represents a project.

Projects track issues and pull requests, standalone note cards are not supported.

object

card_type

Card type: “text_only” or “images_and_text”

string

closed_at

string format: date-time

created_at

string format: date-time

creator

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string

created

string format: date-time

description

The user’s description

string

email

string format: email

followers_count

User counts

integer format: int64

following_count

integer format: int64

full_name

The user’s full name

string

html_url

URL to the user’s gitea page

string

The user’s id

integer format: int64

is_admin

Is the user an administrator

boolean

language

User locale

string

last_login

string format: date-time

location

The user’s location

string

login

string

login_name

Identifier of the user, provided by the external authenticator (if configured)

string

default: empty

prohibit_login

Is user login prohibited

boolean

restricted

Is user restricted

boolean

source_id

The ID of the user’s Authentication Source

integer format: int64

starred_repos_count

integer format: int64

visibility

User visibility level option: public, limited, private

string

Allowed values: public limited private

website

The user’s website

string

creator_id

Deprecated: use Creator instead

integer format: int64

description

string

html_url

string

integer format: int64

is_closed

Deprecated: use State instead

boolean

num_closed_issues

integer format: int64

num_issues

integer format: int64

num_open_issues

integer format: int64

owner_id

integer format: int64

repo_id

integer format: int64

state

string

Allowed values: open closed

template_type

Template type: “none”, “basic_kanban” or “bug_triage”

string

title

string

type

Project type: “individual”, “repository” or “organization”

string

updated_at

Null only for legacy rows that carry no update timestamp

string format: date-time

Example

{
  "creator": {
    "login_name": "empty",
    "visibility": "public"
  },
  "state": "open"
}

404

APINotFound is a not found empty response

application/json

422

APIValidationError is error format response related to input validation

application/json

Headers

message

string

url

string