EditMilestone

com.worxbend.codeberg4s.issues.EditMilestone
See theEditMilestone companion object
final case class EditMilestone(title: Option[String], description: Option[String], dueOn: Option[Instant], state: Option[IssueStateChange])

What PATCH /repos/{owner}/{repo}/milestones/{id} may be told — Forgejo's EditMilestoneOption.

'''Derived from spec/swagger.v1.json''', which declares the same four properties as CreateMilestoneOption and marks none required. No golden capture of this request exists.

'''Only what is set is sent''', which is the whole contract of a PATCH: an unset field contributes no JSON key and the instance leaves that property alone. There is no way to '''clear''' a deadline through this endpoint — Forgejo declares no unset_due_on flag, unlike EditIssue.withoutDueDate — so a milestone's deadline can be changed but not removed, and that is the API's limitation rather than this type's.

An EditMilestone.Empty sent as-is is a well-formed request that changes nothing.

Value parameters

state

the lifecycle transition to apply; see IssueStateChange, shared with issues because it is the same transition

title

the new milestone name; a plain String for the reason CreateMilestone gives

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

Closes the milestone.

Closes the milestone.

Attributes

def describedAs(text: String): EditMilestone

Replaces the description.

Replaces the description.

Attributes

def dueBy(moment: Instant): EditMilestone

Moves the deadline; see the class note on why it cannot be cleared.

Moves the deadline; see the class note on why it cannot be cleared.

Attributes

def renamedTo(text: String): EditMilestone

Renames the milestone.

Renames the milestone.

Attributes

Reopens the milestone.

Reopens the milestone.

Attributes

Inherited methods

def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product