Josep Piguillem
e598f76e1c
A project can ask that tickets reach a DONE status only with their checklist ticked (settings.checklistBeforeDone, off by default; absent when saving means unchanged). Members get a 422 telling how many steps are left; owners and admins may still close it. Settings has the switch and the ticket's checklist says when the project asks for it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
10359 lines
328 KiB
TypeScript
10359 lines
328 KiB
TypeScript
/**
|
|
* This file was auto-generated by openapi-typescript.
|
|
* Do not make direct changes to the file.
|
|
*/
|
|
|
|
export interface paths {
|
|
"/api/health": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** API and databases status */
|
|
get: operations["HealthController_check"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/auth/config": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** How to sign in with Pireon (null when not configured) */
|
|
get: operations["AuthController_config"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/auth/token": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Exchange a grant for Pireon tokens (proxy of Pireon /oauth/token)
|
|
* @description For browsers (Pireon has no CORS) and Swagger UI: adds the client secret server-side. Apps with their own Pireon OAuth client can get tokens from Pireon directly; any valid Pireon access token is accepted by this API.
|
|
*/
|
|
post: operations["AuthController_token"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/users/me": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** The user behind the access token */
|
|
get: operations["UsersController_me"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/users": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/**
|
|
* Search Pireon users (to assign tickets or add members)
|
|
* @description Needs the `users:read` scope in the access token.
|
|
*/
|
|
get: operations["UsersController_search"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/users/{id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** A Pireon user */
|
|
get: operations["UsersController_findOne"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/webhooks/pireon": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Pireon events (called by Pireon, not by apps)
|
|
* @description `user.deactivated` closes the user's sessions; `token.revoked` forgets the token. Disabled unless PIREON_WEBHOOK_SECRET or PIREON_PASSWORD_WEBHOOK_SECRET is set.
|
|
*/
|
|
post: operations["PireonWebhookController_receive"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/calendar/{file}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/**
|
|
* A calendar to subscribe to (`{token}.ics`, no session)
|
|
* @description Unfinished tickets with a due date (assigned or followed), planned and running sprints, and planned releases with a date, as all-day events.
|
|
*/
|
|
get: operations["CalendarController_ics"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/me/calendar": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** My calendar URL, if I made one */
|
|
get: operations["CalendarController_mine"];
|
|
put?: never;
|
|
/** A new secret calendar URL (the previous one stops working) */
|
|
post: operations["CalendarController_create"];
|
|
/** My calendar URL stops working */
|
|
delete: operations["CalendarController_revoke"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Projects where I am a member */
|
|
get: operations["ProjectsController_mine"];
|
|
put?: never;
|
|
/** Create a project (you become its owner) */
|
|
post: operations["ProjectsController_create"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** A project with its members and settings */
|
|
get: operations["ProjectsController_findOne"];
|
|
put?: never;
|
|
post?: never;
|
|
/**
|
|
* Delete a project (owner only)
|
|
* @description Deletes the project and, right after (asynchronously, through a saga), its tickets, comments and releases; links from tickets of other projects are removed and the key becomes free. Cannot be undone from the API. `confirm` must be the project key.
|
|
*/
|
|
delete: operations["ProjectsController_remove"];
|
|
options?: never;
|
|
head?: never;
|
|
/** Rename, describe or make public/private a project (owner/admin) */
|
|
patch: operations["ProjectsController_update"];
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/settings": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
/**
|
|
* Statuses, transitions, ticket types and areas (owner/admin)
|
|
* @description Replaces the whole configuration (send what GET /projects/{project} returns, changed). Values can be added, renamed, reordered or archived, never removed: tickets and statistics keep referring to them.
|
|
*/
|
|
put: operations["ProjectsController_updateSettings"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/board": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Kanban board: one column per status */
|
|
get: operations["ProjectsController_board"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/stats": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Tracking dashboard: counts by status, type, person… */
|
|
get: operations["ProjectsController_stats"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/analytics": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/**
|
|
* Statistics of the last `days` days
|
|
* @description Created vs resolved per week, cumulative flow per day, cycle and lead time, throughput per person and QA pass/fail.
|
|
*/
|
|
get: operations["ProjectsController_analytics"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/insights": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/**
|
|
* The dashboard
|
|
* @description Sprint under way (pace against time), overdue, due-soon, blocked and stuck tickets, aging of the work under way against the p85 cycle time, and average days in each in-progress and QA status.
|
|
*/
|
|
get: operations["ProjectsController_insights"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/activity": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Activity feed (newest first) */
|
|
get: operations["ProjectsController_activity"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/members": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Add a Pireon user to the project (owner/admin)
|
|
* @description The user must exist and be active in Pireon.
|
|
*/
|
|
post: operations["ProjectsController_addMember"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/members/{userId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
/** Remove a member (owner/admin, or yourself to leave) */
|
|
delete: operations["ProjectsController_removeMember"];
|
|
options?: never;
|
|
head?: never;
|
|
/** Change a member's role (owner/admin) */
|
|
patch: operations["ProjectsController_changeMemberRole"];
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/watch": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
/**
|
|
* Follow a ticket (members, viewers included)
|
|
* @description Followers are told when it moves, is reassigned or gets a comment. Commenting follows it too.
|
|
*/
|
|
put: operations["IssuesController_watch"];
|
|
post?: never;
|
|
/** Stop following a ticket */
|
|
delete: operations["IssuesController_unwatch"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/me/issues": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/**
|
|
* My work: tickets across all my projects
|
|
* @description Assigned to me by default; with assignedToMe=false, any ticket of my projects (e.g. waiting for QA).
|
|
*/
|
|
get: operations["IssuesController_mine"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/issues": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Search the tickets of a project */
|
|
get: operations["IssuesController_search"];
|
|
put?: never;
|
|
/**
|
|
* Create a ticket
|
|
* @description Starts in the project's first active TODO-category status (BACKLOG by default). The response carries its key (e.g. WEB-13).
|
|
*/
|
|
post: operations["IssuesController_create"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/epics": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/**
|
|
* Epics: top-level tickets that group others
|
|
* @description With the progress of the tickets hanging from each one (done or cancelled, and story points).
|
|
*/
|
|
get: operations["IssuesController_epics"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** A ticket */
|
|
get: operations["IssuesController_findOne"];
|
|
put?: never;
|
|
post?: never;
|
|
/**
|
|
* Move the ticket to the trash
|
|
* @description Whoever opened it, or an owner/admin. Hidden everywhere; restore it within 30 days or it is deleted for good.
|
|
*/
|
|
delete: operations["IssuesController_trash"];
|
|
options?: never;
|
|
head?: never;
|
|
/** Edit title, description, type, priority, area, labels… */
|
|
patch: operations["IssuesController_update"];
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/status": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
/**
|
|
* Move the ticket through the workflow (incl. QA)
|
|
* @description Only the transitions in `allowedTransitions` are accepted (422 otherwise). QA_FAILED and CANCELLED need a reason.
|
|
*/
|
|
put: operations["IssuesController_changeStatus"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/assignee": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
/** Assign to a project member (null to unassign) */
|
|
put: operations["IssuesController_assign"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/release": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
/** Put the ticket in a planned release (null takes it out) */
|
|
put: operations["IssuesController_setRelease"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/restore": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/** Bring the ticket back from the trash */
|
|
post: operations["IssuesController_restore"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/vote": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
/**
|
|
* Vote for the ticket
|
|
* @description Anyone signed in, on a public project (that is the point: the people it is for say what they want); members on a private one. Voting twice changes nothing.
|
|
*/
|
|
put: operations["IssuesController_vote"];
|
|
post?: never;
|
|
/** Take back my vote for the ticket */
|
|
delete: operations["IssuesController_unvote"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/duplicate": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Duplicate the ticket
|
|
* @description Copies what it says (type, title, description, area, priority, labels, Figma, estimate, dates, parent and checklist steps, unticked), not where it stands: the copy starts in the first status, unassigned, out of sprints and releases, without comments or files. The result carries its key.
|
|
*/
|
|
post: operations["IssuesController_duplicate"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/trash": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** The project's tickets in the trash, newest first */
|
|
get: operations["IssuesController_trashed"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/bulk": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* The same change on up to 100 tickets
|
|
* @description Each ticket goes through the normal rules (permissions, workflow, open sprints and releases) and may refuse on its own; the answer says which.
|
|
*/
|
|
post: operations["IssuesController_bulkUpdate"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/parent": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
/**
|
|
* Place the ticket under an epic or another ticket
|
|
* @description Same project, three levels at most (epic → ticket → subtask), no loops. null takes it back to the top.
|
|
*/
|
|
put: operations["IssuesController_setParent"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/rank": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
/**
|
|
* Move the ticket in the backlog
|
|
* @description Between the ticket that ends up above it and the one below (either may be left out for the top or the bottom). Board columns follow the same order.
|
|
*/
|
|
put: operations["IssuesController_rank"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/checklist": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/** Add a step to the ticket's checklist */
|
|
post: operations["IssuesController_addChecklistItem"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/checklist/{item}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
/** Remove a checklist step */
|
|
delete: operations["IssuesController_removeChecklistItem"];
|
|
options?: never;
|
|
head?: never;
|
|
/** Reword, tick or untick a checklist step */
|
|
patch: operations["IssuesController_updateChecklistItem"];
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/links": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Relate tickets (FE ↔ BE ↔ QA)
|
|
* @description e.g. WEB-3 DEPENDS_ON API-7, WEB-9 TESTS WEB-3. May cross projects.
|
|
*/
|
|
post: operations["IssuesController_link"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/links/{type}/{target}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
/** Remove a relation */
|
|
delete: operations["IssuesController_unlink"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/comments": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Comments of the ticket (oldest first) */
|
|
get: operations["IssuesController_listComments"];
|
|
put?: never;
|
|
/** Comment on the ticket, or answer a comment (replyTo) */
|
|
post: operations["IssuesController_addComment"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/history": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** History of the ticket (newest first) */
|
|
get: operations["IssuesController_history"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/attachments": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Attach a file to a ticket (members)
|
|
* @description Multipart with the file as `file` and, optionally, `commentId` to place it under a comment. Up to ATTACHMENTS_MAX_MB megabytes (25 by default) and 50 files per ticket.
|
|
*/
|
|
post: operations["AttachmentsController_attach"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/attachments/{attachmentId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Download one of a ticket's files */
|
|
get: operations["AttachmentsController_download"];
|
|
put?: never;
|
|
post?: never;
|
|
/** Remove a file (whoever uploaded it, or an owner/admin) */
|
|
delete: operations["AttachmentsController_remove"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/comments/{commentId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
/** Delete a comment (author or project admin) */
|
|
delete: operations["CommentsController_delete"];
|
|
options?: never;
|
|
head?: never;
|
|
/** Edit a comment (author only) */
|
|
patch: operations["CommentsController_edit"];
|
|
trace?: never;
|
|
};
|
|
"/api/comments/{commentId}/reactions": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* React to a comment, or take the reaction back (members)
|
|
* @description One of 👍 👎 😄 🎉 😕 ❤️ 🚀 👀; repeating it changes nothing.
|
|
*/
|
|
post: operations["CommentsController_react"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/me/releases": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Planned releases of all my projects, soonest target date first */
|
|
get: operations["ReleasesController_upcoming"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/releases": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Releases of a project */
|
|
get: operations["ReleasesController_list"];
|
|
put?: never;
|
|
/** Plan a release (owner/admin) */
|
|
post: operations["ReleasesController_create"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/releases/{releaseId}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** A release */
|
|
get: operations["ReleasesController_findOne"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
/** Rename, describe or move the target date */
|
|
patch: operations["ReleasesController_update"];
|
|
trace?: never;
|
|
};
|
|
"/api/releases/{releaseId}/progress": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Finished tickets out of the total */
|
|
get: operations["ReleasesController_progress"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/releases/{releaseId}/burnup": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Burnup: tickets in the release and finished ones, day by day */
|
|
get: operations["ReleasesController_burnup"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/releases/{releaseId}/issues": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Tickets included in the release */
|
|
get: operations["ReleasesController_issuesOf"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/releases/{releaseId}/publish": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Ship the release
|
|
* @description Fails (422) while it has unfinished tickets unless `force` is true.
|
|
*/
|
|
post: operations["ReleasesController_publish"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/releases/{releaseId}/notes": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
/**
|
|
* Write the release notes (Markdown)
|
|
* @description Also after the release ships; not once archived.
|
|
*/
|
|
put: operations["ReleasesController_writeNotes"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/releases/{releaseId}/notes/draft": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/**
|
|
* A Markdown draft of the notes from the finished tickets
|
|
* @description Grouped by type; nothing is saved.
|
|
*/
|
|
get: operations["ReleasesController_notesDraft"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/releases/{releaseId}/archive": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Archive a planned release
|
|
* @description Its unfinished tickets move to `moveTo` (an open release of the same project) or leave it.
|
|
*/
|
|
post: operations["ReleasesController_archive"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/explore/projects": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/**
|
|
* Public projects (no token needed)
|
|
* @description Their board, tickets, comments, releases, activity and statistics can be read without a token too.
|
|
*/
|
|
get: operations["ExploreController_publicProjects"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/explore/projects/{project}/showcase": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/**
|
|
* A public project's showcase (no token needed)
|
|
* @description For public websites: epics with their dates and progress, the latest releases (with the notes of shipped ones), the sprint under way and open tickets labelled good-first-issue. Paths point into the web app.
|
|
*/
|
|
get: operations["ExploreController_showcase"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/explore/projects/{project}/proposals": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Report a bug or propose an idea (no token needed)
|
|
* @description For public projects that take proposals. It becomes a ticket labelled `propuesta`, opened by TaskStream in the first status (Bug or Feature), signed with `author` if given. Five per address every 15 minutes.
|
|
*/
|
|
post: operations["ExploreController_propose"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/me/notifications": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** My notifications, newest first */
|
|
get: operations["NotificationsController_mine"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/me/notifications/read": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/** Mark notifications as read (all of them without `ids`) */
|
|
post: operations["NotificationsController_markRead"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/me/notification-settings": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Whether I get copies by e-mail */
|
|
get: operations["NotificationsController_settings"];
|
|
/** Turn e-mail copies on or off */
|
|
put: operations["NotificationsController_updateSettings"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/me/push-subscriptions": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/** Push on this device (a browser's Web Push subscription) */
|
|
post: operations["NotificationsController_subscribePush"];
|
|
/** Push off on this device */
|
|
delete: operations["NotificationsController_unsubscribePush"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/filters": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** My views of the project's board, then the shared ones */
|
|
get: operations["SavedFiltersController_list"];
|
|
put?: never;
|
|
/**
|
|
* Save board filters under a name
|
|
* @description Project members only. `shared` makes it visible to the whole project (not for viewers).
|
|
*/
|
|
post: operations["SavedFiltersController_save"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/filters/{id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
/** Delete a saved view (whoever saved it, or an admin if shared) */
|
|
delete: operations["SavedFiltersController_delete"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/me/views": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** My saved views of my work, across my projects (by name) */
|
|
get: operations["SavedFiltersController_myViews"];
|
|
put?: never;
|
|
/**
|
|
* Save a view of my work under a name
|
|
* @description Run it with GET /api/me/issues and the same criteria (project, priority, bugsOnly, overdue…).
|
|
*/
|
|
post: operations["SavedFiltersController_saveMyView"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/me/views/{id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
/** Delete one of my views */
|
|
delete: operations["SavedFiltersController_deleteMyView"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/sprints": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/**
|
|
* A project's sprints
|
|
* @description The one under way, the planned ones, then the closed ones.
|
|
*/
|
|
get: operations["SprintsController_list"];
|
|
put?: never;
|
|
/** Plan a sprint (owners and admins) */
|
|
post: operations["SprintsController_create"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sprints/{sprint}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** A sprint */
|
|
get: operations["SprintsController_findOne"];
|
|
put?: never;
|
|
post?: never;
|
|
/**
|
|
* Delete a sprint that never started
|
|
* @description Its tickets go back to the backlog.
|
|
*/
|
|
delete: operations["SprintsController_delete"];
|
|
options?: never;
|
|
head?: never;
|
|
/** Rename, re-date or change the goal (not once closed) */
|
|
patch: operations["SprintsController_update"];
|
|
trace?: never;
|
|
};
|
|
"/api/sprints/{sprint}/start": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/** Start a planned sprint (only one under way per project) */
|
|
post: operations["SprintsController_start"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sprints/{sprint}/close": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Close the sprint under way
|
|
* @description Unfinished tickets move to `carryOverTo` (another open sprint) or back to the backlog; finished ones stay as its record.
|
|
*/
|
|
post: operations["SprintsController_close"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sprints/{sprint}/progress": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Finished tickets and points */
|
|
get: operations["SprintsController_progress"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sprints/{sprint}/burndown": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Open tickets and points, day by day, against the ideal line */
|
|
get: operations["SprintsController_burndown"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sprints/{sprint}/issues": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Tickets in the sprint, in backlog order */
|
|
get: operations["SprintsController_issuesOf"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/issues/{issue}/sprint": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
/** Put the ticket in a sprint (null: the backlog) */
|
|
put: operations["SprintsController_setIssueSprint"];
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/git-integration": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** The project's repositories and the webhook URL they share (secrets, for admins) */
|
|
get: operations["GitController_integration"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/git-integration/repositories": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Add a repository, with its own secret (owners and admins)
|
|
* @description Turns the integration on with the first one. Every repository uses the same webhook URL; its secret tells them apart.
|
|
*/
|
|
post: operations["GitController_addRepository"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/git-integration/repositories/{repository}/secret": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/** Give a repository a new secret (the old one stops working) */
|
|
post: operations["GitController_rotateSecret"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/git-integration/repositories/{repository}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
/** Remove a repository: its webhooks are refused, what it linked stays */
|
|
delete: operations["GitController_removeRepository"];
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/webhooks/git/{project}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Webhook for GitHub, Gitea or GitLab (called by the Git host)
|
|
* @description Push and pull/merge request events from any repository of the project; the secret it signs with says which (GitHub and Gitea: HMAC-SHA256 of the body; GitLab: X-Gitlab-Token). Other events are acknowledged and ignored.
|
|
*/
|
|
post: operations["GitController_receive"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/webhook-events": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Event names a webhook can subscribe to */
|
|
get: operations["WebhooksController_events"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/webhooks": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** The project's webhooks (owners and admins) */
|
|
get: operations["WebhooksController_list"];
|
|
put?: never;
|
|
/**
|
|
* Add a webhook
|
|
* @description The answer carries the secret, the only time it is shown.
|
|
*/
|
|
post: operations["WebhooksController_create"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/outgoing-webhooks/{webhook}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
post?: never;
|
|
/** Delete a webhook */
|
|
delete: operations["WebhooksController_delete"];
|
|
options?: never;
|
|
head?: never;
|
|
/** Change the URL or the events, pause or resume */
|
|
patch: operations["WebhooksController_update"];
|
|
trace?: never;
|
|
};
|
|
"/api/outgoing-webhooks/{webhook}/test": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/** Send a ping now and tell how it went */
|
|
post: operations["WebhooksController_test"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/export.csv": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/**
|
|
* Every ticket of the project as CSV
|
|
* @description UTF-8 with BOM. Cells that a spreadsheet would run as a formula start with a quote mark.
|
|
*/
|
|
get: operations["TransferController_exportCsv"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/projects/{project}/import": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
get?: never;
|
|
put?: never;
|
|
/**
|
|
* Create tickets from a CSV (owners and admins)
|
|
* @description TaskStream export or Jira CSV export, up to 5 MB and 2000 rows. Types, statuses and people are matched by id or name; the rest falls back with a warning. With dryRun=true nothing is created.
|
|
*/
|
|
post: operations["TransferController_importCsv"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
}
|
|
export type webhooks = Record<string, never>;
|
|
export interface components {
|
|
schemas: {
|
|
AuthorizationConfigDto: {
|
|
/** @example https://oauth.pireon.dev/oauth/authorize */
|
|
authorizeUrl: string;
|
|
/** @description Public id of the authorization_code client ("Sign in with Pireon"); null when only email + password is configured */
|
|
clientId: string | null;
|
|
/**
|
|
* @example [
|
|
* "users:read"
|
|
* ]
|
|
*/
|
|
scopes: string[];
|
|
/** @description Whether email + password sign-in is allowed */
|
|
passwordGrant: boolean;
|
|
};
|
|
IssueTokenDto: {
|
|
/** @enum {string} */
|
|
grant_type: "authorization_code" | "password" | "refresh_token";
|
|
/** @description authorization_code: code returned by Pireon */
|
|
code?: string;
|
|
/** @description authorization_code: PKCE verifier */
|
|
code_verifier?: string;
|
|
/** @description authorization_code: redirect URI used to authorize */
|
|
redirect_uri?: string;
|
|
/** @description password: Pireon email */
|
|
username?: string;
|
|
/** @description password: Pireon password */
|
|
password?: string;
|
|
/** @description refresh_token */
|
|
refresh_token?: string;
|
|
};
|
|
TokenResponseDto: {
|
|
access_token: string;
|
|
refresh_token: string | null;
|
|
/** @description Seconds */
|
|
expires_in: number;
|
|
/** @example Bearer */
|
|
token_type: string;
|
|
};
|
|
MeDto: {
|
|
/** @description Pireon user id */
|
|
id: string;
|
|
name: string;
|
|
email: string;
|
|
isActive: boolean;
|
|
/** @description Global roles in Pireon */
|
|
roles: string[];
|
|
/** @description Roles inside the task-stream OAuth client */
|
|
appRoles: string[];
|
|
};
|
|
ApiErrorDto: {
|
|
/** @example 404 */
|
|
statusCode: number;
|
|
/**
|
|
* @description Domain error code
|
|
* @enum {string}
|
|
*/
|
|
code?: "NOT_FOUND" | "FORBIDDEN" | "VALIDATION" | "CONFLICT" | "BUSINESS_RULE";
|
|
/**
|
|
* @description Human message (a list of messages for invalid input)
|
|
* @example Issue not found
|
|
*/
|
|
message: string | string[];
|
|
};
|
|
UserDto: {
|
|
/** @description Pireon user id */
|
|
id: string;
|
|
name: string;
|
|
email: string;
|
|
isActive: boolean;
|
|
};
|
|
CalendarFeedDto: {
|
|
/** @description Secret of the calendar URL: GET /api/calendar/{token}.ics (iCalendar, no session) */
|
|
token: string;
|
|
createdAt: string;
|
|
};
|
|
UserRefDto: {
|
|
/** @description Pireon user id */
|
|
id: string;
|
|
name: string;
|
|
};
|
|
/** @enum {string} */
|
|
ProjectRole: "OWNER" | "ADMIN" | "MEMBER" | "VIEWER";
|
|
ProjectMemberDto: {
|
|
user: components["schemas"]["UserRefDto"];
|
|
role: components["schemas"]["ProjectRole"];
|
|
};
|
|
/** @enum {string} */
|
|
StatusCategory: "TODO" | "IN_PROGRESS" | "QA" | "DONE" | "CANCELLED";
|
|
/** @enum {string} */
|
|
SettingColor: "slate" | "stone" | "violet" | "blue" | "sky" | "teal" | "green" | "amber" | "orange" | "red" | "pink";
|
|
WorkflowStatusDto: {
|
|
/**
|
|
* @description Stable id on tickets
|
|
* @example IN_REVIEW
|
|
*/
|
|
id: string;
|
|
/** @example En revisión */
|
|
name: string;
|
|
category: components["schemas"]["StatusCategory"];
|
|
color: components["schemas"]["SettingColor"];
|
|
/** @description Entering it needs a reason */
|
|
requiresReason: boolean;
|
|
/** @description No new tickets or transitions into it */
|
|
archived: boolean;
|
|
/** @description Work-in-progress limit (a warning, not a lock) */
|
|
wipLimit: number | null;
|
|
};
|
|
StatusTransitionsDto: {
|
|
/** @example IN_QA */
|
|
from: string;
|
|
/**
|
|
* @example [
|
|
* "DONE",
|
|
* "QA_FAILED"
|
|
* ]
|
|
*/
|
|
to: string[];
|
|
};
|
|
/** @enum {string} */
|
|
TypeIcon: "bug" | "feature" | "palette" | "task" | "qa" | "flag" | "star-fill" | "rocket" | "document" | "light-bulb" | "key" | "support";
|
|
IssueTemplateDto: {
|
|
description: string | null;
|
|
checklist: string[];
|
|
};
|
|
IssueTypeOptionDto: {
|
|
/** @example BUG */
|
|
id: string;
|
|
/** @example Bug */
|
|
name: string;
|
|
icon: components["schemas"]["TypeIcon"];
|
|
color: components["schemas"]["SettingColor"];
|
|
archived: boolean;
|
|
/** @description What a new ticket of the type starts with */
|
|
template?: components["schemas"]["IssueTemplateDto"];
|
|
};
|
|
AreaOptionDto: {
|
|
/** @example FRONTEND */
|
|
id: string;
|
|
/** @example Frontend */
|
|
name: string;
|
|
archived: boolean;
|
|
};
|
|
/**
|
|
* @description DATE values are YYYY-MM-DD
|
|
* @enum {string}
|
|
*/
|
|
CustomFieldType: "TEXT" | "NUMBER" | "DATE" | "SELECT";
|
|
CustomFieldDefinitionDto: {
|
|
/** @example BROWSER */
|
|
id: string;
|
|
/** @example Navegador */
|
|
name: string;
|
|
/** @description DATE values are YYYY-MM-DD */
|
|
type: components["schemas"]["CustomFieldType"];
|
|
/** @description The choices of a SELECT field */
|
|
options: string[];
|
|
archived: boolean;
|
|
};
|
|
ProjectSettingsDto: {
|
|
/** @description In board order */
|
|
statuses: components["schemas"]["WorkflowStatusDto"][];
|
|
transitions: components["schemas"]["StatusTransitionsDto"][];
|
|
issueTypes: components["schemas"]["IssueTypeOptionDto"][];
|
|
areas: components["schemas"]["AreaOptionDto"][];
|
|
customFields: components["schemas"]["CustomFieldDefinitionDto"][];
|
|
/** @description Definition of done: tickets reach DONE only with their checklist ticked */
|
|
checklistBeforeDone: boolean;
|
|
};
|
|
ProjectDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/**
|
|
* @description Prefix of the ticket keys
|
|
* @example WEB
|
|
*/
|
|
key: string;
|
|
/** @example Checkout revamp */
|
|
name: string;
|
|
description: string | null;
|
|
/** @description Readable by anyone, also without a token */
|
|
isPublic: boolean;
|
|
/** @description Takes bug reports and ideas from anyone (POST /api/explore/projects/{project}/proposals) while public */
|
|
acceptsProposals: boolean;
|
|
owner: components["schemas"]["UserRefDto"];
|
|
members: components["schemas"]["ProjectMemberDto"][];
|
|
settings: components["schemas"]["ProjectSettingsDto"];
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
/** Format: date-time */
|
|
updatedAt: string;
|
|
/** @description Version of the aggregate (event count) */
|
|
version: number;
|
|
};
|
|
CreateProjectDto: {
|
|
/**
|
|
* @description 2-10 letters/digits starting with a letter → tickets WEB-1, WEB-2…
|
|
* @example WEB
|
|
*/
|
|
key: string;
|
|
/** @example Checkout revamp */
|
|
name: string;
|
|
description?: string | null;
|
|
/**
|
|
* @description Anyone can read it without signing in (board, tickets, comments, releases, activity, statistics)
|
|
* @default false
|
|
*/
|
|
isPublic: boolean;
|
|
/**
|
|
* @description A project you own or administer (id or key) to start from: its statuses, transitions, types, areas, custom fields and automation rules are copied
|
|
* @example API
|
|
*/
|
|
template?: string | null;
|
|
};
|
|
CommandResultDto: {
|
|
/** @description Id of the aggregate written */
|
|
id: string;
|
|
/**
|
|
* @description Human key when one was assigned (project or issue)
|
|
* @example WEB-13
|
|
*/
|
|
key?: string;
|
|
/** @description Version after the write. Writes are acknowledged at once and the read model catches up asynchronously: a GET may briefly return the previous version (or 404 right after a create). */
|
|
version: number;
|
|
};
|
|
UpdateProjectDto: {
|
|
/** @example Checkout revamp */
|
|
name?: string;
|
|
description?: string | null;
|
|
/**
|
|
* @description Anyone can read it without signing in (board, tickets, comments, releases, activity, statistics)
|
|
* @default false
|
|
*/
|
|
isPublic: boolean;
|
|
/** @description Take bug reports and ideas from anyone through the public form (while public) */
|
|
acceptsProposals?: boolean;
|
|
};
|
|
WorkflowStatusBodyDto: {
|
|
/**
|
|
* @description Never change an existing id
|
|
* @example IN_REVIEW
|
|
*/
|
|
id: string;
|
|
/** @example En revisión */
|
|
name: string;
|
|
category: components["schemas"]["StatusCategory"];
|
|
color: components["schemas"]["SettingColor"];
|
|
/** @default false */
|
|
requiresReason: boolean;
|
|
/** @default false */
|
|
archived: boolean;
|
|
/** @description Work-in-progress limit (null: none) */
|
|
wipLimit?: number | null;
|
|
};
|
|
StatusTransitionsBodyDto: {
|
|
/** @example IN_QA */
|
|
from: string;
|
|
/**
|
|
* @example [
|
|
* "DONE",
|
|
* "QA_FAILED"
|
|
* ]
|
|
*/
|
|
to: string[];
|
|
};
|
|
IssueTemplateBodyDto: {
|
|
description?: string | null;
|
|
checklist?: string[];
|
|
};
|
|
IssueTypeOptionBodyDto: {
|
|
/** @example SPIKE */
|
|
id: string;
|
|
/** @example Spike */
|
|
name: string;
|
|
icon: components["schemas"]["TypeIcon"];
|
|
color: components["schemas"]["SettingColor"];
|
|
/** @default false */
|
|
archived: boolean;
|
|
/** @description What a new ticket of the type starts with */
|
|
template?: components["schemas"]["IssueTemplateBodyDto"] | null;
|
|
};
|
|
AreaOptionBodyDto: {
|
|
/** @example DATA */
|
|
id: string;
|
|
/** @example Datos */
|
|
name: string;
|
|
/** @default false */
|
|
archived: boolean;
|
|
};
|
|
CustomFieldDefinitionBodyDto: {
|
|
/** @example BROWSER */
|
|
id: string;
|
|
/** @example Navegador */
|
|
name: string;
|
|
/** @description Cannot change once the field exists. DATE: YYYY-MM-DD */
|
|
type: components["schemas"]["CustomFieldType"];
|
|
/**
|
|
* @description The choices of a SELECT field
|
|
* @example [
|
|
* "Chrome",
|
|
* "Safari",
|
|
* "Firefox"
|
|
* ]
|
|
*/
|
|
options?: string[];
|
|
/** @default false */
|
|
archived: boolean;
|
|
};
|
|
ProjectSettingsBodyDto: {
|
|
/** @description In board order. Values cannot be removed: archive them instead. */
|
|
statuses: components["schemas"]["WorkflowStatusBodyDto"][];
|
|
transitions: components["schemas"]["StatusTransitionsBodyDto"][];
|
|
issueTypes: components["schemas"]["IssueTypeOptionBodyDto"][];
|
|
areas: components["schemas"]["AreaOptionBodyDto"][];
|
|
/** @description Absent: unchanged. Fields cannot be removed: archive them. */
|
|
customFields?: components["schemas"]["CustomFieldDefinitionBodyDto"][];
|
|
/** @description Definition of done: tickets reach a DONE status only with their checklist ticked (owners and admins may override). Absent: unchanged */
|
|
checklistBeforeDone?: boolean;
|
|
};
|
|
/** @enum {string} */
|
|
IssuePriority: "LOWEST" | "LOW" | "MEDIUM" | "HIGH" | "CRITICAL";
|
|
ReleaseRefDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @example v1.4.0 */
|
|
name: string;
|
|
};
|
|
SprintRefDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @example Sprint 14 */
|
|
name: string;
|
|
};
|
|
/** @enum {string} */
|
|
IssueLinkType: "BLOCKS" | "DEPENDS_ON" | "TESTS" | "DUPLICATES" | "RELATES_TO";
|
|
/**
|
|
* @description OUTWARD: this issue → other. INWARD: other → this issue.
|
|
* @enum {string}
|
|
*/
|
|
LinkDirection: "OUTWARD" | "INWARD";
|
|
IssueLinkDto: {
|
|
type: components["schemas"]["IssueLinkType"];
|
|
/** @description OUTWARD: this issue → other. INWARD: other → this issue. */
|
|
direction: components["schemas"]["LinkDirection"];
|
|
/** Format: uuid */
|
|
issueId: string;
|
|
/** @example WEB-3 */
|
|
issueKey: string;
|
|
};
|
|
AttachmentDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @example captura-login.png */
|
|
fileName: string;
|
|
/** @example image/png */
|
|
mimeType: string;
|
|
/**
|
|
* @description Bytes
|
|
* @example 48213
|
|
*/
|
|
size: number;
|
|
uploadedBy: components["schemas"]["UserRefDto"];
|
|
/** Format: date-time */
|
|
uploadedAt: string;
|
|
/**
|
|
* Format: uuid
|
|
* @description The comment it was attached to, if any
|
|
*/
|
|
commentId: string | null;
|
|
};
|
|
IssueParentDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @example WEB-3 */
|
|
key: string;
|
|
/** @example Pago con tarjeta */
|
|
title: string;
|
|
};
|
|
ChecklistItemDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @example Actualizar el changelog */
|
|
text: string;
|
|
done: boolean;
|
|
};
|
|
/** @enum {string} */
|
|
DevLinkKind: "COMMIT" | "BRANCH" | "PULL_REQUEST";
|
|
/** @enum {string} */
|
|
DevLinkState: "OPEN" | "MERGED" | "CLOSED";
|
|
DevLinkDto: {
|
|
kind: components["schemas"]["DevLinkKind"];
|
|
url: string;
|
|
title: string;
|
|
/** @description Short SHA, branch or PR number */
|
|
ref: string;
|
|
state: components["schemas"]["DevLinkState"] | null;
|
|
/** @example gitea */
|
|
provider: string;
|
|
/**
|
|
* @description The project's name for the repository it came from
|
|
* @example api
|
|
*/
|
|
repository: string | null;
|
|
author: string | null;
|
|
/** Format: date-time */
|
|
at: string;
|
|
};
|
|
IssueDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
projectId: string;
|
|
/** @example WEB */
|
|
projectKey: string;
|
|
/** @example 12 */
|
|
number: number;
|
|
/**
|
|
* @description Human key
|
|
* @example WEB-12
|
|
*/
|
|
key: string;
|
|
/**
|
|
* @description A ticket type id
|
|
* @example BUG
|
|
*/
|
|
type: string;
|
|
/** @example FRONTEND */
|
|
area: string | null;
|
|
title: string;
|
|
description: string | null;
|
|
/**
|
|
* @description A status id
|
|
* @example IN_PROGRESS
|
|
*/
|
|
status: string;
|
|
statusCategory: components["schemas"]["StatusCategory"];
|
|
/** @description Statuses this ticket can move to next (project's workflow) */
|
|
allowedTransitions: string[];
|
|
priority: components["schemas"]["IssuePriority"];
|
|
reporter: components["schemas"]["UserRefDto"];
|
|
assignee: components["schemas"]["UserRefDto"] | null;
|
|
release: components["schemas"]["ReleaseRefDto"] | null;
|
|
sprint: components["schemas"]["SprintRefDto"] | null;
|
|
labels: string[];
|
|
/** @description Figma frame */
|
|
figmaUrl: string | null;
|
|
storyPoints: number | null;
|
|
/**
|
|
* Format: date
|
|
* @description When work should start (roadmap)
|
|
*/
|
|
startDate: string | null;
|
|
/** Format: date */
|
|
dueDate: string | null;
|
|
/**
|
|
* @description Custom field id → value (only those set)
|
|
* @example {
|
|
* "BROWSER": "Safari"
|
|
* }
|
|
*/
|
|
customFields: {
|
|
[key: string]: string;
|
|
};
|
|
links: components["schemas"]["IssueLinkDto"][];
|
|
attachments: components["schemas"]["AttachmentDto"][];
|
|
/** @description People following it */
|
|
watchers: components["schemas"]["UserRefDto"][];
|
|
/** @description The epic or ticket this one breaks down */
|
|
parent: components["schemas"]["IssueParentDto"] | null;
|
|
/** @description Open tickets it waits for: the ones that block it and the ones it depends on */
|
|
blockedBy: components["schemas"]["IssueParentDto"][];
|
|
/** @description How many want it done */
|
|
votes: number;
|
|
/** @description Whether I voted for it (false without a token) */
|
|
voted: boolean;
|
|
/** @description Place in the backlog and its board column (ascending, as text) */
|
|
rank: string;
|
|
checklist: components["schemas"]["ChecklistItemDto"][];
|
|
/**
|
|
* Format: date-time
|
|
* @description In the trash since then; null when it is not
|
|
*/
|
|
trashedAt: string | null;
|
|
/** @description Commits, branches and pull requests that mention it */
|
|
devLinks: components["schemas"]["DevLinkDto"][];
|
|
commentCount: number;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
/** Format: date-time */
|
|
updatedAt: string;
|
|
version: number;
|
|
};
|
|
BoardColumnDto: {
|
|
/** @example IN_PROGRESS */
|
|
status: string;
|
|
issues: components["schemas"]["IssueDto"][];
|
|
/** @description Tickets in the column (may exceed `issues`) */
|
|
total: number;
|
|
};
|
|
CountByStatusDto: {
|
|
/**
|
|
* @description Status id
|
|
* @example IN_PROGRESS
|
|
*/
|
|
key: string;
|
|
count: number;
|
|
};
|
|
CountByKeyDto: {
|
|
/** @description Type, priority or area ("NONE" = unset) */
|
|
key: string;
|
|
count: number;
|
|
};
|
|
CountByAssigneeDto: {
|
|
/** @description Null = unassigned */
|
|
user: components["schemas"]["UserRefDto"] | null;
|
|
count: number;
|
|
};
|
|
ProjectStatsDto: {
|
|
total: number;
|
|
/** @description Not done nor cancelled */
|
|
open: number;
|
|
byStatus: components["schemas"]["CountByStatusDto"][];
|
|
byType: components["schemas"]["CountByKeyDto"][];
|
|
byPriority: components["schemas"]["CountByKeyDto"][];
|
|
byArea: components["schemas"]["CountByKeyDto"][];
|
|
/** @description Open tickets per person */
|
|
byAssignee: components["schemas"]["CountByAssigneeDto"][];
|
|
};
|
|
CreatedResolvedDto: {
|
|
/**
|
|
* Format: date
|
|
* @description Monday of the week
|
|
*/
|
|
week: string;
|
|
created: number;
|
|
resolved: number;
|
|
};
|
|
FlowSeriesDto: {
|
|
/** @example IN_PROGRESS */
|
|
status: string;
|
|
/** @description One value per date */
|
|
counts: number[];
|
|
};
|
|
CumulativeFlowDto: {
|
|
dates: string[];
|
|
series: components["schemas"]["FlowSeriesDto"][];
|
|
};
|
|
DurationStatsDto: {
|
|
count: number;
|
|
averageDays: number | null;
|
|
/** @description 85% of tickets take at most this long */
|
|
p85Days: number | null;
|
|
};
|
|
ThroughputDto: {
|
|
/** Format: date */
|
|
week: string;
|
|
user: components["schemas"]["UserRefDto"] | null;
|
|
count: number;
|
|
};
|
|
QaStatsDto: {
|
|
/** @description Left QA to a done status */
|
|
passed: number;
|
|
/** @description Left QA back to work */
|
|
failed: number;
|
|
failureRate: number | null;
|
|
};
|
|
ProjectAnalyticsDto: {
|
|
/** Format: date-time */
|
|
from: string;
|
|
/** Format: date-time */
|
|
to: string;
|
|
createdVsResolved: components["schemas"]["CreatedResolvedDto"][];
|
|
/** @description Tickets in each status at the end of every day */
|
|
cumulativeFlow: components["schemas"]["CumulativeFlowDto"];
|
|
/** @description Start of work → done */
|
|
cycleTime: components["schemas"]["DurationStatsDto"];
|
|
/** @description Creation → done */
|
|
leadTime: components["schemas"]["DurationStatsDto"];
|
|
throughput: components["schemas"]["ThroughputDto"][];
|
|
qa: components["schemas"]["QaStatsDto"];
|
|
};
|
|
SprintPulseDto: {
|
|
/** Format: uuid */
|
|
sprintId: string;
|
|
name: string;
|
|
/** Format: date */
|
|
startDate: string;
|
|
/** Format: date */
|
|
endDate: string;
|
|
totalDays: number;
|
|
/** @description Days left after today */
|
|
daysLeft: number;
|
|
tickets: number;
|
|
doneTickets: number;
|
|
points: number;
|
|
donePoints: number;
|
|
pacePerDay: number | null;
|
|
neededPerDay: number | null;
|
|
/** @description At this pace, what is open would not be closed */
|
|
behind: boolean;
|
|
};
|
|
InsightIssueDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @example WEB-12 */
|
|
key: string;
|
|
title: string;
|
|
/** @description Status id */
|
|
status: string;
|
|
assignee: components["schemas"]["UserRefDto"] | null;
|
|
/** @description Days in its status (aging, stuck) or past / to its due date */
|
|
days: number;
|
|
/** Format: date */
|
|
dueDate: string | null;
|
|
};
|
|
RisksDto: {
|
|
overdue: components["schemas"]["InsightIssueDto"][];
|
|
overdueCount: number;
|
|
/** @description Due within 7 days */
|
|
dueSoon: components["schemas"]["InsightIssueDto"][];
|
|
dueSoonCount: number;
|
|
blocked: components["schemas"]["InsightIssueDto"][];
|
|
blockedCount: number;
|
|
stuck: components["schemas"]["InsightIssueDto"][];
|
|
stuckCount: number;
|
|
stuckDays: number;
|
|
};
|
|
AgingDto: {
|
|
issues: components["schemas"]["InsightIssueDto"][];
|
|
/** @description p85 cycle time of the last 90 days */
|
|
thresholdDays: number | null;
|
|
};
|
|
StatusTimeDto: {
|
|
status: string;
|
|
averageDays: number | null;
|
|
samples: number;
|
|
open: number;
|
|
wipLimit: number | null;
|
|
overLimit: boolean;
|
|
};
|
|
ReleaseForecastDto: {
|
|
/** Format: uuid */
|
|
releaseId: string;
|
|
name: string;
|
|
/** Format: date */
|
|
targetDate: string | null;
|
|
total: number;
|
|
finished: number;
|
|
/**
|
|
* Format: date
|
|
* @description Half of the simulated futures finish by then
|
|
*/
|
|
likelyDate: string | null;
|
|
/**
|
|
* Format: date
|
|
* @description 85% finish by then
|
|
*/
|
|
safeDate: string | null;
|
|
/** @enum {string} */
|
|
verdict: "DONE" | "NO_DATE" | "UNKNOWN" | "ON_TRACK" | "AT_RISK" | "LATE";
|
|
};
|
|
ChangesSinceDto: {
|
|
since: string;
|
|
created: components["schemas"]["InsightIssueDto"][];
|
|
createdCount: number;
|
|
finished: components["schemas"]["InsightIssueDto"][];
|
|
finishedCount: number;
|
|
/** @description Sent back from QA */
|
|
returned: components["schemas"]["InsightIssueDto"][];
|
|
returnedCount: number;
|
|
/** @description Times you were mentioned here */
|
|
mentions: number;
|
|
};
|
|
TeamLoadDto: {
|
|
user: components["schemas"]["UserRefDto"];
|
|
openTickets: number;
|
|
openPoints: number;
|
|
blocked: number;
|
|
/** @description Points closed per sprint, last three closed sprints */
|
|
pointsPerSprint: number | null;
|
|
overloaded: boolean;
|
|
};
|
|
BacklogHealthDto: {
|
|
open: number;
|
|
unestimated: number;
|
|
noArea: number;
|
|
unassigned: number;
|
|
stale: number;
|
|
staleDays: number;
|
|
};
|
|
PriorityCountDto: {
|
|
priority: components["schemas"]["IssuePriority"];
|
|
count: number;
|
|
};
|
|
BugWeekDto: {
|
|
/**
|
|
* Format: date
|
|
* @description Monday (UTC)
|
|
*/
|
|
week: string;
|
|
created: number;
|
|
closed: number;
|
|
};
|
|
QaByAreaDto: {
|
|
/** @description Null: no area */
|
|
area: string | null;
|
|
returned: number;
|
|
passed: number;
|
|
};
|
|
EscapedBugsDto: {
|
|
/** Format: uuid */
|
|
releaseId: string;
|
|
name: string;
|
|
releasedAt: string;
|
|
/** @description Bugs reported in the 14 days after */
|
|
bugs: number;
|
|
};
|
|
QualityDto: {
|
|
openBugsByPriority: components["schemas"]["PriorityCountDto"][];
|
|
/** @description Last 8 weeks, oldest first */
|
|
bugWeeks: components["schemas"]["BugWeekDto"][];
|
|
qaByArea: components["schemas"]["QaByAreaDto"][];
|
|
escaped: components["schemas"]["EscapedBugsDto"][];
|
|
};
|
|
OptionCountDto: {
|
|
value: string;
|
|
count: number;
|
|
};
|
|
FieldBreakdownDto: {
|
|
fieldId: string;
|
|
counts: components["schemas"]["OptionCountDto"][];
|
|
/** @description Open tickets with no value */
|
|
none: number;
|
|
};
|
|
ProjectInsightsDto: {
|
|
generatedAt: string;
|
|
sprint: components["schemas"]["SprintPulseDto"] | null;
|
|
risks: components["schemas"]["RisksDto"];
|
|
aging: components["schemas"]["AgingDto"];
|
|
bottlenecks: components["schemas"]["StatusTimeDto"][];
|
|
releases: components["schemas"]["ReleaseForecastDto"][];
|
|
/** @description Only when asked with `since` */
|
|
changes: components["schemas"]["ChangesSinceDto"] | null;
|
|
team: components["schemas"]["TeamLoadDto"][];
|
|
backlog: components["schemas"]["BacklogHealthDto"];
|
|
quality: components["schemas"]["QualityDto"];
|
|
/** @description One per active list custom field */
|
|
fields: components["schemas"]["FieldBreakdownDto"][];
|
|
};
|
|
ActivityDto: {
|
|
id: string;
|
|
/** @example IssueStatusChanged */
|
|
type: string;
|
|
/** Format: uuid */
|
|
projectId: string;
|
|
issueId: string | null;
|
|
/** @example WEB-12 */
|
|
issueKey: string | null;
|
|
actor: components["schemas"]["UserRefDto"];
|
|
/** @example Ana movió WEB-12 de En curso a En revisión */
|
|
summary: string;
|
|
/** Format: date-time */
|
|
occurredAt: string;
|
|
};
|
|
AddMemberDto: {
|
|
/** @description Pireon user id (see GET /users) */
|
|
userId: string;
|
|
/** @default MEMBER */
|
|
role: components["schemas"]["ProjectRole"];
|
|
};
|
|
ChangeMemberRoleDto: {
|
|
role: components["schemas"]["ProjectRole"];
|
|
};
|
|
IssuePageDto: {
|
|
items: components["schemas"]["IssueDto"][];
|
|
/** @description Total matches (for pagination) */
|
|
total: number;
|
|
};
|
|
/** @enum {string} */
|
|
IssueSort: "RECENT" | "RANK";
|
|
CreateIssueDto: {
|
|
description?: string | null;
|
|
/**
|
|
* @description An area id of the project's settings
|
|
* @example FRONTEND
|
|
*/
|
|
area?: string | null;
|
|
priority?: components["schemas"]["IssuePriority"];
|
|
labels?: string[];
|
|
/** @description Figma frame (https) for UI changes */
|
|
figmaUrl?: string | null;
|
|
storyPoints?: number | null;
|
|
/**
|
|
* Format: date
|
|
* @description When work should start (roadmap)
|
|
*/
|
|
startDate?: string | null;
|
|
/** Format: date */
|
|
dueDate?: string | null;
|
|
/**
|
|
* @description Custom field id → value. Only the fields to change; null or '' clears one
|
|
* @example {
|
|
* "BROWSER": "Safari"
|
|
* }
|
|
*/
|
|
customFields?: {
|
|
[key: string]: string | null;
|
|
};
|
|
/**
|
|
* @description A ticket type id of the project's settings
|
|
* @example BUG
|
|
*/
|
|
type: string;
|
|
/** @example El botón de pagar no responde en Safari */
|
|
title: string;
|
|
/** @description Pireon user id */
|
|
assigneeId?: string | null;
|
|
/** Format: uuid */
|
|
releaseId?: string | null;
|
|
/**
|
|
* @description Epic or ticket of the same project the new one breaks down (id or key)
|
|
* @example WEB-3
|
|
*/
|
|
parent?: string | null;
|
|
};
|
|
ChildProgressDto: {
|
|
total: number;
|
|
/** @description Done or cancelled */
|
|
finished: number;
|
|
percent: number;
|
|
storyPoints: number;
|
|
finishedStoryPoints: number;
|
|
};
|
|
EpicDto: {
|
|
issue: components["schemas"]["IssueDto"];
|
|
progress: components["schemas"]["ChildProgressDto"];
|
|
};
|
|
UpdateIssueDto: {
|
|
description?: string | null;
|
|
/**
|
|
* @description An area id of the project's settings
|
|
* @example FRONTEND
|
|
*/
|
|
area?: string | null;
|
|
priority?: components["schemas"]["IssuePriority"];
|
|
labels?: string[];
|
|
/** @description Figma frame (https) for UI changes */
|
|
figmaUrl?: string | null;
|
|
storyPoints?: number | null;
|
|
/**
|
|
* Format: date
|
|
* @description When work should start (roadmap)
|
|
*/
|
|
startDate?: string | null;
|
|
/** Format: date */
|
|
dueDate?: string | null;
|
|
/**
|
|
* @description Custom field id → value. Only the fields to change; null or '' clears one
|
|
* @example {
|
|
* "BROWSER": "Safari"
|
|
* }
|
|
*/
|
|
customFields?: {
|
|
[key: string]: string | null;
|
|
};
|
|
/**
|
|
* @description A ticket type id
|
|
* @example FEATURE
|
|
*/
|
|
type?: string;
|
|
title?: string;
|
|
};
|
|
ChangeStatusDto: {
|
|
/**
|
|
* @description A status id of the project's settings, among the ticket's allowedTransitions
|
|
* @example IN_REVIEW
|
|
*/
|
|
status: string;
|
|
/** @description Required by statuses with requiresReason (e.g. QA_FAILED) */
|
|
reason?: string | null;
|
|
};
|
|
AssignIssueDto: {
|
|
/** @description Pireon user id of a project member, or null to unassign */
|
|
assigneeId: string | null;
|
|
};
|
|
SetIssueReleaseDto: {
|
|
/**
|
|
* Format: uuid
|
|
* @description Planned release, or null to take the ticket out
|
|
*/
|
|
releaseId: string | null;
|
|
};
|
|
BulkUpdateIssuesDto: {
|
|
issueIds: string[];
|
|
/** @example IN_PROGRESS */
|
|
status?: string;
|
|
/** @description Unassign everything */
|
|
unassign?: boolean;
|
|
/** @description Pireon user id of a member */
|
|
assigneeId?: string;
|
|
/** @description Back to the backlog */
|
|
noSprint?: boolean;
|
|
/** Format: uuid */
|
|
sprintId?: string;
|
|
/** @description Out of their release */
|
|
noRelease?: boolean;
|
|
/** Format: uuid */
|
|
releaseId?: string;
|
|
priority?: components["schemas"]["IssuePriority"];
|
|
addLabels?: string[];
|
|
};
|
|
BulkIssueResultDto: {
|
|
/** Format: uuid */
|
|
issueId: string;
|
|
ok: boolean;
|
|
error: string | null;
|
|
};
|
|
BulkResultDto: {
|
|
updated: number;
|
|
results: components["schemas"]["BulkIssueResultDto"][];
|
|
};
|
|
SetIssueParentDto: {
|
|
/**
|
|
* @description Epic or ticket of the same project (id or key), or null to take it back to the top
|
|
* @example WEB-3
|
|
*/
|
|
parent: string | null;
|
|
};
|
|
RankIssueDto: {
|
|
/**
|
|
* @description The ticket that ends up right above (id or key; null: the top)
|
|
* @example WEB-4
|
|
*/
|
|
above?: string | null;
|
|
/**
|
|
* @description The ticket that ends up right below (id or key; null: the bottom)
|
|
* @example WEB-9
|
|
*/
|
|
below?: string | null;
|
|
};
|
|
ChecklistItemBodyDto: {
|
|
/** @example Actualizar el changelog */
|
|
text: string;
|
|
};
|
|
UpdateChecklistItemDto: {
|
|
text?: string;
|
|
done?: boolean;
|
|
};
|
|
LinkIssueDto: {
|
|
type: components["schemas"]["IssueLinkType"];
|
|
/**
|
|
* @description Other ticket: id or key
|
|
* @example API-3
|
|
*/
|
|
targetIssue: string;
|
|
};
|
|
CommentReactionDto: {
|
|
/** @example 👍 */
|
|
emoji: string;
|
|
users: components["schemas"]["UserRefDto"][];
|
|
};
|
|
CommentDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
issueId: string;
|
|
author: components["schemas"]["UserRefDto"];
|
|
/** @description Empty on a deleted comment kept for its replies */
|
|
body: string;
|
|
/**
|
|
* Format: uuid
|
|
* @description The top-level comment it answers; null for a top-level one
|
|
*/
|
|
replyTo: string | null;
|
|
/** @description Deleted, but kept (without its text) while it has replies */
|
|
deleted: boolean;
|
|
/** @description In the order they are offered; only the ones somebody chose */
|
|
reactions: components["schemas"]["CommentReactionDto"][];
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
/** Format: date-time */
|
|
editedAt: string | null;
|
|
version: number;
|
|
};
|
|
CommentPageDto: {
|
|
items: components["schemas"]["CommentDto"][];
|
|
total: number;
|
|
};
|
|
AddCommentDto: {
|
|
/** @example Reproducido en Safari 17. */
|
|
body: string;
|
|
/**
|
|
* Format: uuid
|
|
* @description Comment it answers (one level: answering a reply joins its thread)
|
|
*/
|
|
replyTo?: string;
|
|
};
|
|
AttachFileDto: {
|
|
/**
|
|
* Format: binary
|
|
* @description The file
|
|
*/
|
|
file: string;
|
|
/**
|
|
* Format: uuid
|
|
* @description One of the ticket's comments, to show the file under it
|
|
*/
|
|
commentId?: string;
|
|
};
|
|
AttachmentResultDto: {
|
|
/** @description Id of the aggregate written */
|
|
id: string;
|
|
/**
|
|
* @description Human key when one was assigned (project or issue)
|
|
* @example WEB-13
|
|
*/
|
|
key?: string;
|
|
/** @description Version after the write. Writes are acknowledged at once and the read model catches up asynchronously: a GET may briefly return the previous version (or 404 right after a create). */
|
|
version: number;
|
|
/**
|
|
* Format: uuid
|
|
* @description The new file; `` shows an image inside a description or comment
|
|
*/
|
|
attachmentId: string;
|
|
};
|
|
CommentBodyDto: {
|
|
/** @example Reproducido en Safari 17. */
|
|
body: string;
|
|
};
|
|
ReactToCommentDto: {
|
|
/**
|
|
* @example 👍
|
|
* @enum {string}
|
|
*/
|
|
emoji: "👍" | "👎" | "😄" | "🎉" | "😕" | "❤️" | "🚀" | "👀";
|
|
/** @description true adds the reaction, false takes it back */
|
|
on: boolean;
|
|
};
|
|
/** @enum {string} */
|
|
ReleaseStatus: "PLANNED" | "RELEASED" | "ARCHIVED";
|
|
ReleaseDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
projectId: string;
|
|
/** @example v1.4.0 */
|
|
name: string;
|
|
description: string | null;
|
|
/** Format: date */
|
|
targetDate: string | null;
|
|
status: components["schemas"]["ReleaseStatus"];
|
|
/** Format: date-time */
|
|
releasedAt: string | null;
|
|
/** @description What shipped, told for people (Markdown) */
|
|
notes: string | null;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
version: number;
|
|
};
|
|
CreateReleaseDto: {
|
|
/** @example v1.4.0 */
|
|
name: string;
|
|
description?: string | null;
|
|
/**
|
|
* Format: date
|
|
* @example 2026-11-14
|
|
*/
|
|
targetDate?: string | null;
|
|
};
|
|
UpdateReleaseDto: {
|
|
/** @example v1.4.0 */
|
|
name?: string;
|
|
description?: string | null;
|
|
/**
|
|
* Format: date
|
|
* @example 2026-11-14
|
|
*/
|
|
targetDate?: string | null;
|
|
};
|
|
ReleaseProgressDto: {
|
|
total: number;
|
|
finished: number;
|
|
percent: number;
|
|
byStatus: components["schemas"]["CountByStatusDto"][];
|
|
};
|
|
ReleaseBurnupDto: {
|
|
/** Format: uuid */
|
|
releaseId: string;
|
|
/** Format: date */
|
|
targetDate: string | null;
|
|
dates: string[];
|
|
/** @description Tickets in the release (not cancelled) */
|
|
scope: number[];
|
|
done: number[];
|
|
};
|
|
PublishReleaseDto: {
|
|
/**
|
|
* @description Publish even with unfinished tickets
|
|
* @default false
|
|
*/
|
|
force: boolean;
|
|
};
|
|
ReleaseNotesDto: {
|
|
/** @description Markdown; null removes the notes */
|
|
notes: string | null;
|
|
};
|
|
ReleaseNotesDraftDto: {
|
|
/**
|
|
* @example ## v1.4.0
|
|
*
|
|
* ### Novedades
|
|
*
|
|
* - Pago con tarjeta (WEB-1)
|
|
*/
|
|
markdown: string;
|
|
};
|
|
ArchiveReleaseDto: {
|
|
/**
|
|
* Format: uuid
|
|
* @description Open release of the same project that takes its unfinished tickets; null or absent: they leave it
|
|
*/
|
|
moveTo?: string | null;
|
|
};
|
|
ShowcaseProjectDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @example WEB */
|
|
key: string;
|
|
name: string;
|
|
description: string | null;
|
|
};
|
|
ShowcaseSprintDto: {
|
|
name: string;
|
|
goal: string | null;
|
|
/** Format: date */
|
|
startDate: string;
|
|
/** Format: date */
|
|
endDate: string;
|
|
percent: number;
|
|
};
|
|
ShowcaseEpicDto: {
|
|
key: string;
|
|
title: string;
|
|
/** Format: date */
|
|
startDate: string | null;
|
|
/** Format: date */
|
|
dueDate: string | null;
|
|
percent: number;
|
|
done: boolean;
|
|
/** @description How many want it */
|
|
votes: number;
|
|
/**
|
|
* @description In the web app
|
|
* @example /p/WEB/issues/WEB-3
|
|
*/
|
|
path: string;
|
|
};
|
|
ShowcaseReleaseDto: {
|
|
name: string;
|
|
status: components["schemas"]["ReleaseStatus"];
|
|
targetDate: string | null;
|
|
releasedAt: string | null;
|
|
percent: number;
|
|
/** @description Shipped ones only */
|
|
notes: string | null;
|
|
};
|
|
ShowcaseIssueDto: {
|
|
key: string;
|
|
title: string;
|
|
/** @description A ticket type id */
|
|
type: string;
|
|
/** @example /p/WEB/issues/WEB-9 */
|
|
path: string;
|
|
};
|
|
ShowcaseProposalDto: {
|
|
key: string;
|
|
title: string;
|
|
/** @description A ticket type id */
|
|
type: string;
|
|
/** @example /p/WEB/issues/WEB-9 */
|
|
path: string;
|
|
/** @description How many want it */
|
|
votes: number;
|
|
};
|
|
ShowcaseProposalsDto: {
|
|
/** @description Whether it takes bug reports and ideas now */
|
|
open: boolean;
|
|
/**
|
|
* @description The form in the web app, while it takes them
|
|
* @example /p/WEB/proponer
|
|
*/
|
|
path: string | null;
|
|
/** @description Open proposals, most voted first */
|
|
top: components["schemas"]["ShowcaseProposalDto"][];
|
|
};
|
|
ShowcaseDto: {
|
|
project: components["schemas"]["ShowcaseProjectDto"];
|
|
activeSprint: components["schemas"]["ShowcaseSprintDto"] | null;
|
|
roadmap: components["schemas"]["ShowcaseEpicDto"][];
|
|
releases: components["schemas"]["ShowcaseReleaseDto"][];
|
|
/** @description Open tickets labelled good-first-issue */
|
|
goodFirst: components["schemas"]["ShowcaseIssueDto"][];
|
|
proposals: components["schemas"]["ShowcaseProposalsDto"];
|
|
};
|
|
ProposalDto: {
|
|
/**
|
|
* @description A bug report or an idea
|
|
* @enum {string}
|
|
*/
|
|
kind: "BUG" | "IDEA";
|
|
title: string;
|
|
/** @description What happens, or what they would like (Markdown) */
|
|
description?: string;
|
|
/** @description How they sign it; shown in the ticket (no e-mail: it would be public) */
|
|
author?: string;
|
|
/** @description Leave empty: a field only bots fill in */
|
|
website?: string;
|
|
};
|
|
ProposalResultDto: {
|
|
/**
|
|
* @description The ticket it became
|
|
* @example WEB-42
|
|
*/
|
|
key: string | null;
|
|
/**
|
|
* @description Where to see it in the web app
|
|
* @example /p/WEB/issues/WEB-42
|
|
*/
|
|
path: string | null;
|
|
};
|
|
/** @enum {string} */
|
|
NotificationKind: "ASSIGNED" | "STATUS_CHANGED" | "QA_FAILED" | "COMMENTED" | "MENTIONED" | "REPLIED" | "PROPOSED" | "WATCHED" | "ADDED_TO_PROJECT" | "REMINDER";
|
|
NotificationDto: {
|
|
id: string;
|
|
kind: components["schemas"]["NotificationKind"];
|
|
/** Format: uuid */
|
|
projectId: string;
|
|
/** @example WEB */
|
|
projectKey: string;
|
|
/** Format: uuid */
|
|
issueId: string | null;
|
|
/** @example WEB-12 */
|
|
issueKey: string | null;
|
|
actor: components["schemas"]["UserRefDto"];
|
|
/** @example Ana te asignó WEB-12: Login roto en Safari */
|
|
summary: string;
|
|
/**
|
|
* Format: date-time
|
|
* @description Null: unread
|
|
*/
|
|
readAt: string | null;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
};
|
|
MyNotificationsDto: {
|
|
items: components["schemas"]["NotificationDto"][];
|
|
/** @description All my unread ones, not just these */
|
|
unread: number;
|
|
};
|
|
MarkNotificationsReadDto: {
|
|
/** @description Omit to mark all of them */
|
|
ids?: string[];
|
|
};
|
|
NotificationSettingsResponseDto: {
|
|
/** @description Copies by e-mail */
|
|
email: boolean;
|
|
/** @description Whether this installation can send e-mail */
|
|
emailAvailable: boolean;
|
|
/** @description VAPID public key to subscribe a device to push with; null: no push here */
|
|
pushPublicKey: string | null;
|
|
};
|
|
NotificationSettingsDto: {
|
|
/** @description Copies by e-mail */
|
|
email: boolean;
|
|
};
|
|
PushSubscriptionDto: {
|
|
/** @description The push service URL (PushSubscription.endpoint) */
|
|
endpoint: string;
|
|
/** @description keys.p256dh of the subscription */
|
|
p256dh: string;
|
|
/** @description keys.auth of the subscription */
|
|
auth: string;
|
|
};
|
|
PushEndpointDto: {
|
|
/** @description The endpoint of the device to turn off */
|
|
endpoint: string;
|
|
};
|
|
SavedFilterCriteriaResponseDto: {
|
|
types?: string[];
|
|
areas?: string[];
|
|
priorities?: components["schemas"]["IssuePriority"][];
|
|
assigneeId?: string | null;
|
|
unassigned?: boolean;
|
|
/** Format: uuid */
|
|
releaseId?: string | null;
|
|
labels?: string[];
|
|
search?: string | null;
|
|
};
|
|
SavedFilterDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
projectId: string;
|
|
owner: components["schemas"]["UserRefDto"];
|
|
/** @example Bugs críticos de frontend */
|
|
name: string;
|
|
/** @description Visible to the whole project */
|
|
shared: boolean;
|
|
criteria: components["schemas"]["SavedFilterCriteriaResponseDto"];
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
};
|
|
SavedFilterCriteriaDto: {
|
|
/** @description Ticket type ids */
|
|
types?: string[];
|
|
/** @description Area ids */
|
|
areas?: string[];
|
|
priorities?: components["schemas"]["IssuePriority"][];
|
|
/** @description Pireon user id */
|
|
assigneeId?: string | null;
|
|
unassigned?: boolean;
|
|
/** Format: uuid */
|
|
releaseId?: string | null;
|
|
labels?: string[];
|
|
search?: string | null;
|
|
};
|
|
SaveFilterDto: {
|
|
/** @example Bugs críticos de frontend */
|
|
name: string;
|
|
/**
|
|
* @description Visible to the whole project (members, not viewers, share)
|
|
* @default false
|
|
*/
|
|
shared: Record<string, never>;
|
|
criteria: components["schemas"]["SavedFilterCriteriaDto"];
|
|
};
|
|
SavedFilterIdDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
};
|
|
MyViewCriteriaResponseDto: {
|
|
projectIds?: string[];
|
|
assignedToMe?: boolean;
|
|
watching?: boolean;
|
|
categories?: components["schemas"]["StatusCategory"][];
|
|
priorities?: components["schemas"]["IssuePriority"][];
|
|
bugsOnly?: boolean;
|
|
overdue?: boolean;
|
|
search?: string;
|
|
};
|
|
MyViewDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @example Bugs críticos de todos mis proyectos */
|
|
name: string;
|
|
criteria: components["schemas"]["MyViewCriteriaResponseDto"];
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
};
|
|
MyViewCriteriaDto: {
|
|
/** @description Only these of my projects (empty: all) */
|
|
projectIds?: string[];
|
|
assignedToMe?: boolean;
|
|
/** @description Only the tickets I follow */
|
|
watching?: boolean;
|
|
categories?: components["schemas"]["StatusCategory"][];
|
|
priorities?: components["schemas"]["IssuePriority"][];
|
|
/** @description Only types with the bug icon */
|
|
bugsOnly?: boolean;
|
|
/** @description Only open tickets past due */
|
|
overdue?: boolean;
|
|
search?: string;
|
|
};
|
|
SaveMyViewDto: {
|
|
/** @example Bugs críticos de todos mis proyectos */
|
|
name: string;
|
|
criteria: components["schemas"]["MyViewCriteriaDto"];
|
|
};
|
|
/** @enum {string} */
|
|
SprintStatus: "PLANNED" | "ACTIVE" | "CLOSED";
|
|
SprintDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
projectId: string;
|
|
/** @example Sprint 14 */
|
|
name: string;
|
|
goal: string | null;
|
|
/** Format: date */
|
|
startDate: string;
|
|
/**
|
|
* Format: date
|
|
* @description Last day, included
|
|
*/
|
|
endDate: string;
|
|
status: components["schemas"]["SprintStatus"];
|
|
/** Format: date-time */
|
|
startedAt: string | null;
|
|
/** Format: date-time */
|
|
closedAt: string | null;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
version: number;
|
|
};
|
|
CreateSprintDto: {
|
|
/** @example Sprint 14 */
|
|
name: string;
|
|
/** @example Pagos con tarjeta en producción */
|
|
goal?: string | null;
|
|
/**
|
|
* Format: date
|
|
* @example 2026-10-12
|
|
*/
|
|
startDate: string;
|
|
/**
|
|
* Format: date
|
|
* @description Last day, included
|
|
* @example 2026-10-23
|
|
*/
|
|
endDate: string;
|
|
};
|
|
UpdateSprintDto: {
|
|
/** @example Sprint 14 */
|
|
name?: string;
|
|
/** @example Pagos con tarjeta en producción */
|
|
goal?: string | null;
|
|
/**
|
|
* Format: date
|
|
* @example 2026-10-12
|
|
*/
|
|
startDate?: string;
|
|
/**
|
|
* Format: date
|
|
* @description Last day, included
|
|
* @example 2026-10-23
|
|
*/
|
|
endDate?: string;
|
|
};
|
|
CloseSprintDto: {
|
|
/**
|
|
* Format: uuid
|
|
* @description Open sprint of the same project that takes the unfinished tickets; null or absent: back to the backlog
|
|
*/
|
|
carryOverTo?: string | null;
|
|
};
|
|
SprintProgressDto: {
|
|
total: number;
|
|
/** @description Done or cancelled */
|
|
finished: number;
|
|
percent: number;
|
|
storyPoints: number;
|
|
finishedStoryPoints: number;
|
|
};
|
|
SprintBurndownDto: {
|
|
/** Format: uuid */
|
|
sprintId: string;
|
|
dates: string[];
|
|
/** @description Tickets in the sprint (null: days to come) */
|
|
scope: number[] | null;
|
|
remaining: number[] | null;
|
|
remainingPoints: number[] | null;
|
|
ideal: number[];
|
|
};
|
|
SetIssueSprintDto: {
|
|
/**
|
|
* Format: uuid
|
|
* @description Open sprint of the project, or null for the backlog
|
|
*/
|
|
sprintId: string | null;
|
|
};
|
|
GitRepositoryDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @example api */
|
|
name: string;
|
|
/** @description Webhook secret of this repository; only owners and admins see it */
|
|
secret: string | null;
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
};
|
|
GitIntegrationDto: {
|
|
/** @description On while there is at least one repository */
|
|
enabled: boolean;
|
|
/**
|
|
* @description The same for every repository of the project
|
|
* @example /api/webhooks/git/3f2c…
|
|
*/
|
|
webhookPath: string;
|
|
repositories: components["schemas"]["GitRepositoryDto"][];
|
|
};
|
|
AddGitRepositoryDto: {
|
|
/**
|
|
* @description The project's name for it (api, web, admin…); unique
|
|
* @example api
|
|
*/
|
|
name: string;
|
|
};
|
|
GitDeliveryResultDto: {
|
|
/** @description Tickets that got something new */
|
|
recorded: number;
|
|
};
|
|
WebhookDeliveryDto: {
|
|
/** Format: date-time */
|
|
at: string;
|
|
/** @example issue.created */
|
|
event: string;
|
|
/** @description HTTP status */
|
|
status: number | null;
|
|
ok: boolean;
|
|
error: string | null;
|
|
};
|
|
WebhookDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** Format: uuid */
|
|
projectId: string;
|
|
url: string;
|
|
events: string[];
|
|
active: boolean;
|
|
createdBy: components["schemas"]["UserRefDto"];
|
|
/** Format: date-time */
|
|
createdAt: string;
|
|
lastDelivery: components["schemas"]["WebhookDeliveryDto"] | null;
|
|
};
|
|
CreateWebhookDto: {
|
|
/** @example https://chat.example.org/hooks/taskstream */
|
|
url: string;
|
|
/**
|
|
* @description Event names (GET /api/webhook-events), family.* or *
|
|
* @example [
|
|
* "issue.status_changed",
|
|
* "release.*"
|
|
* ]
|
|
*/
|
|
events: string[];
|
|
};
|
|
WebhookCreatedDto: {
|
|
/** Format: uuid */
|
|
id: string;
|
|
/** @description Signs every delivery. Shown only now. */
|
|
secret: string;
|
|
};
|
|
UpdateWebhookDto: {
|
|
/** @example https://chat.example.org/hooks/taskstream */
|
|
url?: string;
|
|
/**
|
|
* @description Event names (GET /api/webhook-events), family.* or *
|
|
* @example [
|
|
* "issue.status_changed",
|
|
* "release.*"
|
|
* ]
|
|
*/
|
|
events?: string[];
|
|
/** @description Paused webhooks get nothing */
|
|
active?: boolean;
|
|
};
|
|
ImportLineDto: {
|
|
/** @description Line of the file (the header is 1) */
|
|
line: number;
|
|
reason?: string;
|
|
message?: string;
|
|
};
|
|
ImportReportDto: {
|
|
/** @enum {string} */
|
|
format: "taskstream" | "jira";
|
|
/** @description Nothing was created: a preview */
|
|
dryRun: boolean;
|
|
/** @description Rows that become tickets */
|
|
rows: number;
|
|
created: number;
|
|
/**
|
|
* @example [
|
|
* "WEB-41",
|
|
* "WEB-42"
|
|
* ]
|
|
*/
|
|
keys: string[];
|
|
skipped: components["schemas"]["ImportLineDto"][];
|
|
warnings: components["schemas"]["ImportLineDto"][];
|
|
};
|
|
};
|
|
responses: never;
|
|
parameters: never;
|
|
requestBodies: never;
|
|
headers: never;
|
|
pathItems: never;
|
|
}
|
|
export type $defs = Record<string, never>;
|
|
export interface operations {
|
|
HealthController_check: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": unknown;
|
|
};
|
|
};
|
|
/** @description A database is down */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
AuthController_config: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["AuthorizationConfigDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
AuthController_token: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["IssueTokenDto"];
|
|
"application/x-www-form-urlencoded": components["schemas"]["IssueTokenDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["TokenResponseDto"];
|
|
};
|
|
};
|
|
/** @description Pireon rejected the grant */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
UsersController_me: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["MeDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
UsersController_search: {
|
|
parameters: {
|
|
query?: {
|
|
/** @description Name or email */
|
|
search?: string;
|
|
limit?: number;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["UserDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
UsersController_findOne: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["UserDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
PireonWebhookController_receive: {
|
|
parameters: {
|
|
query?: never;
|
|
header: {
|
|
"x-webhook-signature": string;
|
|
/** @description HMAC-SHA256 of the raw body with the secret of the Pireon client that registered the webhook (hex) */
|
|
"X-Webhook-Signature": string;
|
|
};
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Processed */
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
/** @description Missing or invalid signature */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
CalendarController_ics: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
file: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
CalendarController_mine: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CalendarFeedDto"];
|
|
};
|
|
};
|
|
/** @description I have none */
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
CalendarController_create: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CalendarFeedDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
CalendarController_revoke: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_mine: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ProjectDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_create: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateProjectDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_findOne: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ProjectDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_remove: {
|
|
parameters: {
|
|
query: {
|
|
/** @description The project key, to confirm the deletion */
|
|
confirm: string;
|
|
};
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_update: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["UpdateProjectDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_updateSettings: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ProjectSettingsBodyDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_board: {
|
|
parameters: {
|
|
query?: {
|
|
/** @description Only this release */
|
|
releaseId?: string;
|
|
/** @description Only this person (Pireon user id) */
|
|
assigneeId?: string;
|
|
/** @description An area id */
|
|
area?: string;
|
|
/** @description Ticket type ids */
|
|
type?: string[];
|
|
priority?: components["schemas"]["IssuePriority"][];
|
|
label?: string[];
|
|
/** @description Matches key, title or description */
|
|
search?: string;
|
|
/** @description Only tickets without assignee */
|
|
unassigned?: boolean;
|
|
/** @description Only this sprint */
|
|
sprintId?: string;
|
|
perColumn?: number;
|
|
};
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["BoardColumnDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_stats: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ProjectStatsDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_analytics: {
|
|
parameters: {
|
|
query?: {
|
|
days?: number;
|
|
};
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ProjectAnalyticsDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_insights: {
|
|
parameters: {
|
|
query?: {
|
|
/** @description ISO instant (e.g. your last visit): the answer also tells what changed after it */
|
|
since?: string;
|
|
};
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ProjectInsightsDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_activity: {
|
|
parameters: {
|
|
query?: {
|
|
/** @description Only this ticket */
|
|
issueId?: string;
|
|
limit?: number;
|
|
/** @description Cursor: entries older than this date */
|
|
before?: string;
|
|
};
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ActivityDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_addMember: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["AddMemberDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_removeMember: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
userId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ProjectsController_changeMemberRole: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
userId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ChangeMemberRoleDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_watch: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_unwatch: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_mine: {
|
|
parameters: {
|
|
query?: {
|
|
limit?: number;
|
|
offset?: number;
|
|
/** @description true: tickets assigned to me. false: any ticket of my projects (e.g. ?assignedToMe=false&category=QA) */
|
|
assignedToMe?: boolean;
|
|
/** @description Only the tickets I follow (with assignedToMe=false, whoever they are assigned to) */
|
|
watching?: boolean;
|
|
/** @description Status ids. Repeat the parameter or separate with commas */
|
|
status?: string[];
|
|
/** @description Whatever each project calls its statuses */
|
|
category?: components["schemas"]["StatusCategory"][];
|
|
/** @description Matches key, title or description */
|
|
search?: string;
|
|
/** @description Only these of my projects (ids). Repeat or separate with commas */
|
|
project?: string[];
|
|
priority?: components["schemas"]["IssuePriority"][];
|
|
/** @description Only types with the bug icon */
|
|
bugsOnly?: boolean;
|
|
/** @description Only open tickets past their due date */
|
|
overdue?: boolean;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["IssuePageDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_search: {
|
|
parameters: {
|
|
query?: {
|
|
limit?: number;
|
|
offset?: number;
|
|
/** @description Status ids. Repeat the parameter or separate with commas */
|
|
status?: string[];
|
|
category?: components["schemas"]["StatusCategory"][];
|
|
/** @description Ticket type ids */
|
|
type?: string[];
|
|
/** @description Area ids */
|
|
area?: string[];
|
|
priority?: components["schemas"]["IssuePriority"][];
|
|
/** @description Pireon user id */
|
|
assigneeId?: string;
|
|
/** @description Only tickets without assignee */
|
|
unassigned?: boolean;
|
|
releaseId?: string;
|
|
label?: string[];
|
|
/** @description Only the tickets hanging from this one (id or key) */
|
|
parent?: string;
|
|
/** @description Only this sprint */
|
|
sprintId?: string;
|
|
/** @description Only tickets in no sprint */
|
|
noSprint?: boolean;
|
|
/** @description Only the tickets I follow (none without a token) */
|
|
watching?: boolean;
|
|
/** @description Due on or after this day */
|
|
dueFrom?: string;
|
|
/** @description Due on or before this day */
|
|
dueTo?: string;
|
|
/** @description Only tickets nobody estimated */
|
|
noEstimate?: boolean;
|
|
/** @description Only tickets with no area */
|
|
noArea?: boolean;
|
|
/** @description Only tickets not updated since this instant (ISO) */
|
|
updatedBefore?: string;
|
|
/** @description Custom values the tickets must hold, as FIELD:value. Repeat the parameter for several */
|
|
field?: string[];
|
|
/** @description RECENT (default): last updated first. RANK: backlog order. */
|
|
sort?: components["schemas"]["IssueSort"];
|
|
/** @description Matches key, title or description */
|
|
search?: string;
|
|
};
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["IssuePageDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_create: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateIssueDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_epics: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["EpicDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_findOne: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["IssueDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_trash: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_update: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["UpdateIssueDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_changeStatus: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ChangeStatusDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_assign: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["AssignIssueDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_setRelease: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["SetIssueReleaseDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_restore: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_vote: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_unvote: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_duplicate: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_trashed: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["IssueDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_bulkUpdate: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["BulkUpdateIssuesDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["BulkResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_setParent: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["SetIssueParentDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_rank: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["RankIssueDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_addChecklistItem: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ChecklistItemBodyDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_removeChecklistItem: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
item: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_updateChecklistItem: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
item: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["UpdateChecklistItemDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_link: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["LinkIssueDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_unlink: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
type: components["schemas"]["IssueLinkType"];
|
|
/** @description Other ticket: id or key */
|
|
target: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_listComments: {
|
|
parameters: {
|
|
query?: {
|
|
limit?: number;
|
|
offset?: number;
|
|
};
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommentPageDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_addComment: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["AddCommentDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
IssuesController_history: {
|
|
parameters: {
|
|
query?: {
|
|
limit?: number;
|
|
offset?: number;
|
|
};
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ActivityDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
AttachmentsController_attach: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"multipart/form-data": components["schemas"]["AttachFileDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["AttachmentResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
AttachmentsController_download: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
attachmentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description The file */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/octet-stream": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/octet-stream": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/octet-stream": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/octet-stream": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
AttachmentsController_remove: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
attachmentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
CommentsController_delete: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
commentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
CommentsController_edit: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
commentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CommentBodyDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
CommentsController_react: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
commentId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ReactToCommentDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ReleasesController_upcoming: {
|
|
parameters: {
|
|
query?: {
|
|
limit?: number;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ReleaseDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ReleasesController_list: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ReleaseDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ReleasesController_create: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateReleaseDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ReleasesController_findOne: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
releaseId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ReleaseDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ReleasesController_update: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
releaseId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["UpdateReleaseDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ReleasesController_progress: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
releaseId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ReleaseProgressDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ReleasesController_burnup: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
releaseId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ReleaseBurnupDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ReleasesController_issuesOf: {
|
|
parameters: {
|
|
query?: {
|
|
limit?: number;
|
|
offset?: number;
|
|
};
|
|
header?: never;
|
|
path: {
|
|
releaseId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["IssuePageDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ReleasesController_publish: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
releaseId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["PublishReleaseDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ReleasesController_writeNotes: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
releaseId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ReleaseNotesDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ReleasesController_notesDraft: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
releaseId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ReleaseNotesDraftDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ReleasesController_archive: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
releaseId: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ArchiveReleaseDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ExploreController_publicProjects: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ProjectDto"][];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
ExploreController_showcase: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ShowcaseDto"];
|
|
};
|
|
};
|
|
/** @description Not a public project */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
ExploreController_propose: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ProposalDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ProposalResultDto"];
|
|
};
|
|
};
|
|
/** @description It does not take proposals */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
/** @description Not a public project */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
/** @description Too many from this address */
|
|
429: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
NotificationsController_mine: {
|
|
parameters: {
|
|
query?: {
|
|
/** @description Only unread ones */
|
|
unreadOnly?: boolean;
|
|
limit?: number;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["MyNotificationsDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
NotificationsController_markRead: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["MarkNotificationsReadDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Done */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
NotificationsController_settings: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["NotificationSettingsResponseDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
NotificationsController_updateSettings: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["NotificationSettingsDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["NotificationSettingsResponseDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
NotificationsController_subscribePush: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["PushSubscriptionDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
NotificationsController_unsubscribePush: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["PushEndpointDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
SavedFiltersController_list: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SavedFilterDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SavedFiltersController_save: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["SaveFilterDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SavedFilterIdDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SavedFiltersController_delete: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SavedFiltersController_myViews: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["MyViewDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SavedFiltersController_saveMyView: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["SaveMyViewDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SavedFilterIdDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SavedFiltersController_deleteMyView: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SprintsController_list: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SprintDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SprintsController_create: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateSprintDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SprintsController_findOne: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
sprint: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SprintDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SprintsController_delete: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
sprint: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SprintsController_update: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
sprint: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["UpdateSprintDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SprintsController_start: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
sprint: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SprintsController_close: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
sprint: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CloseSprintDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SprintsController_progress: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
sprint: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SprintProgressDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SprintsController_burndown: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
sprint: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SprintBurndownDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SprintsController_issuesOf: {
|
|
parameters: {
|
|
query?: {
|
|
limit?: number;
|
|
offset?: number;
|
|
};
|
|
header?: never;
|
|
path: {
|
|
sprint: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["IssuePageDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
SprintsController_setIssueSprint: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Ticket id or key */
|
|
issue: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["SetIssueSprintDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["CommandResultDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
GitController_integration: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["GitIntegrationDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
GitController_addRepository: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["AddGitRepositoryDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["GitRepositoryDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
GitController_rotateSecret: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
/** @description Repository id */
|
|
repository: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["GitRepositoryDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
GitController_removeRepository: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
/** @description Repository id */
|
|
repository: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
GitController_receive: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["GitDeliveryResultDto"];
|
|
};
|
|
};
|
|
/** @description Unknown project, integration off or bad signature */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
};
|
|
};
|
|
WebhooksController_events: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": string[];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
WebhooksController_list: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["WebhookDto"][];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
WebhooksController_create: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateWebhookDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["WebhookCreatedDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
WebhooksController_delete: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
webhook: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
204: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
WebhooksController_update: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
webhook: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["UpdateWebhookDto"];
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["WebhookDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
WebhooksController_test: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
webhook: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["WebhookDeliveryDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
TransferController_exportCsv: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description The CSV file */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content?: never;
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"text/csv": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"text/csv": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"text/csv": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"text/csv": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
TransferController_importCsv: {
|
|
parameters: {
|
|
query?: {
|
|
/** @description Only tell what would be created */
|
|
dryRun?: boolean;
|
|
};
|
|
header?: never;
|
|
path: {
|
|
/** @description Project id or key */
|
|
project: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"multipart/form-data": {
|
|
/** Format: binary */
|
|
file: string;
|
|
};
|
|
};
|
|
};
|
|
responses: {
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ImportReportDto"];
|
|
};
|
|
};
|
|
/** @description Invalid input */
|
|
400: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Missing or rejected Pireon token */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not a member of the project (or not allowed) */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Not found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Someone changed it at the same time: retry */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
/** @description Business rule (e.g. a transition the workflow forbids) */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ApiErrorDto"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
}
|