crates/hub-api/ts/index.d.ts at v0.3.1 · andymccall/oxygenhub

◆ v0.3.1 oxygenhub / crates / hub-api / ts / index.d.ts

8.9 KiB · last changed Runners: the queue on Admin → Runners, and the runner API (refs #41, part 4) 1 month ago source blame history raw

// Generated by `cargo run -p hub-api --bin hub-api-typescript`; do not edit.
// Types of the OxygenHub JSON API (hub spec §12.1).

export type Visibility = "public" | "internal" | "private";

export type Repository = {
  clone_url: string;
  created_ms: number;
  default_bookmark: string;
  description: string;
  name: string;
  owner: string;
  updated_ms: number;
  visibility: Visibility;
};

export type Bookmark = {
  changes: number;
  default: boolean;
  heads: string[];
  name: string;
};

export type Tag = {
  heads: string[];
  message: string;
  name: string;
  signer?: string | null;
};

export type Author = {
  account?: string | null;
  email: string;
  key: string;
  name: string;
  note?: string | null;
};

export type Signature = {
  status: "unsigned";
} | {
  key: string;
  revoked: boolean;
  sealed: boolean;
  status: "valid";
} | {
  reason: string;
  status: "invalid";
};

export type ChangeSummary = {
  author: Author;
  deps: string[];
  hash: string;
  head: boolean;
  message: string;
  signature: Signature;
  when_ms: number;
};

export type Problem = {
  detail: string;
  status: number;
  title: string;
};

export type Approval = {
  account: string;
  key?: string | null;
  sealed: boolean;
};

export type Landed = {
  by: string;
  via: string;
  when_ms: number;
};

export type ProposalSource = {
  bookmark: string;
  kind: "bookmark";
} | {
  bookmark: string;
  kind: "fork";
  name: string;
  owner: string;
} | {
  hashes: string[];
  kind: "changes";
};

export type ProposalState = "draft" | "open" | "landed" | "closed";

export type Proposal = {
  approvals: Approval[];
  author: string;
  blockers: string[];
  body: string;
  changes: ChangeSummary[];
  conflicted: boolean;
  created_ms: number;
  landable: boolean;
  landed?: Landed | null;
  number: number;
  projected_heads: string[];
  projected_state?: string | null;
  repository_url: string;
  requested_reviewers?: string[];
  source: ProposalSource;
  source_url?: string | null;
  state: ProposalState;
  target: string;
  title: string;
  updated_ms: number;
  url: string;
};

export type Label = {
  colour: string;
  description: string;
  name: string;
};

export type Issue = {
  assignees: string[];
  author: string;
  body: string;
  closed_ms?: number | null;
  comments: number;
  created_ms: number;
  labels: Label[];
  locked: boolean;
  milestone?: string | null;
  number: number;
  pinned: boolean;
  reason: string;
  state: string;
  title: string;
  updated_ms: number;
  url: string;
};

export type Milestone = {
  closed: number;
  description: string;
  due_ms?: number | null;
  open: number;
  state: string;
  title: string;
};

export type Atom = {
  change: string;
  index: number;
};

export type Comment = {
  anchor?: Atom | null;
  author: string;
  body: string;
  created_ms: number;
  id: number;
  line?: number | null;
  path?: string | null;
  resolved: boolean;
};

export type ProposalFile = {
  added: number;
  from?: string | null;
  kind: string;
  path: string;
  removed: number;
};

export type Notification = {
  actor: string;
  at_ms: number;
  id: number;
  kind: string;
  read: boolean;
  title: string;
  url: string;
};

export type Inbox = {
  items: Notification[];
  unread: number;
};

export type Review = {
  author: string;
  body: string;
  created_ms: number;
  id: number;
  sealed: boolean;
  verdict: string;
};

export type TreeEntry = {
  conflicted: boolean;
  exec: boolean;
  kind: string;
  name: string;
  path: string;
  size?: number | null;
};

export type BlameLine = {
  author: string;
  change: string;
  index: number;
  line: number;
  text: string;
  when_ms: number;
};

export type FileChange = {
  added: number;
  from?: string | null;
  kind: string;
  path: string;
  removed: number;
};

export type ChangeDetail = {
  body: string;
  change: ChangeSummary;
  dependents: string[];
  files: FileChange[];
  in_bookmarks: string[];
  in_tags: string[];
};

export type History = {
  changes: ChangeSummary[];
  heads: string[];
  offset: number;
  reference: string;
  total: number;
};

export type Conflict = {
  bookmark: string;
  contributors: string[];
  kind: string;
  path: string;
};

export type Push = {
  at_ms: number;
  changes: number;
  heads: number;
  new_state: string;
  ok: boolean;
  old_state: string;
  pusher: string;
  reason: string;
  reference: string;
};

export type Policy = {
  expires_ms: number;
  root_threshold: number;
  roots: string[];
  rules: Rule[];
  serial: number;
};

export type Rule = {
  allow_conflicts: boolean;
  keys: string[];
  pattern: string;
  require: string;
  threshold: number;
};

export type Trust = {
  hub_key: string;
  invalid: string[];
  policy?: Policy | null;
  sealed: number;
  signed: number;
  unsigned: number;
};

export type Hook = {
  active: boolean;
  created_ms: number;
  events: string;
  id: number;
  url: string;
};

export type NewHook = {
  events?: string;
  secret: string;
  url: string;
};

export type CheckStatus = "queued" | "running" | "passed" | "failed" | "cancelled" | "skipped";

export type Check = {
  finished_ms?: number | null;
  name: string;
  reporter: string;
  seal?: string | null;
  started_ms: number;
  state: string;
  status: CheckStatus;
  summary: string;
  url: string;
};

export type NewCheck = {
  name: string;
  seal?: string | null;
  state: string;
  status: CheckStatus;
  summary?: string;
  url?: string;
};

export type User = {
  created_ms: number;
  display_name: string;
  is_admin: boolean;
  keys: string[];
  username: string;
};

export type Organisation = {
  description: string;
  display_name: string;
  members: string[];
  name: string;
};

export type NewRepository = {
  description?: string;
  name: string;
  owner: string;
  visibility?: Visibility;
};

export type NewIssue = {
  assignees?: string[];
  body?: string;
  labels?: string[];
  milestone?: string | null;
  title: string;
};

export type IssueEdit = {
  assignees?: string[] | null;
  body?: string | null;
  labels?: string[] | null;
  milestone?: string | null;
  title?: string | null;
};

export type NewLabel = {
  colour?: string | null;
  description?: string;
  name: string;
};

export type RequiredChecks = {
  names: string[];
};

export type Project = {
  closed: boolean;
  description: string;
  number: number;
  owner: string;
  public: boolean;
  title: string;
  updated_ms: number;
  url: string;
};

export type ProjectCard = {
  id: number;
  kind: string;
  reference: string;
  state: string;
  title: string;
};

export type ProjectColumn = {
  cards: ProjectCard[];
  id: number;
  name: string;
};

export type Board = {
  columns: ProjectColumn[];
  project: Project;
};

export type NewProject = {
  description?: string;
  private?: boolean;
  title: string;
};

export type ProjectEdit = {
  closed?: boolean | null;
  description?: string | null;
  private?: boolean | null;
  title?: string | null;
};

export type NewCard = {
  column?: string | null;
  note?: string;
  reference?: string;
};

export type CardMove = {
  column: string;
};

export type NewComment = {
  body: string;
  line?: number | null;
  path?: string | null;
};

export type NewProposal = {
  body?: string;
  draft?: boolean;
  source: string;
  target: string;
  title: string;
};

export type NewReview = {
  body?: string;
  verdict: string;
};

export type IssueStateChange = {
  reason?: string;
  state: string;
};

export type WebhookEnvelope = {
  actor: string;
  at_ms: number;
  data: unknown;
  delivery: string;
  event: string;
  repository?: Repository | null;
};

export type ProposalEvent = {
  check?: Check | null;
  kind: string;
  number: number;
};

export type AssetBuild = {
  artifact: string;
  job: string;
  receipt?: string | null;
  receipt_url?: string | null;
  run: number;
  run_url: string;
  signer?: string | null;
};

export type ReleaseAsset = {
  built_by?: AssetBuild | null;
  content_type: string;
  downloads: number;
  hash: string;
  name: string;
  size: number;
  url: string;
};

export type Release = {
  archives: string[];
  assets: ReleaseAsset[];
  author: string;
  created_ms: number;
  heads: string[];
  latest: boolean;
  notes: string;
  prerelease: boolean;
  signer?: string | null;
  tag: string;
  title: string;
  url: string;
};

export type FlowJob = {
  depends_on: string[];
  error: string;
  exit_code?: number | null;
  finished_ms?: number | null;
  log_lines: number;
  name: string;
  runner: string;
  started_ms?: number | null;
  status: string;
};

export type FlowRun = {
  actor: string;
  bookmark: string;
  created_ms: number;
  error: string;
  finished_ms?: number | null;
  heads: string[];
  jobs?: FlowJob[];
  number: number;
  pipeline_hash: string;
  queue_position?: number | null;
  state: string;
  status: string;
  trigger: string;
  url: string;
};

export type FlowLogLine = {
  seq: number;
  stream: string;
  t: number;
  text: string;
};

export type NewRelease = {
  notes?: string | null;
  prerelease?: boolean;
  tag: string;
  title: string;
};


`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

b64e2537 Andy McCall 1 month ago ↶	1	// Generated by `cargo run -p hub-api --bin hub-api-typescript`; do not edit.
8d2caf12 Andy McCall 1 month ago ↶	2	// Types of the OxygenHub JSON API (hub spec §12.1).
b64e2537 Andy McCall 1 month ago ↶	3
	4	export type Visibility = "public" \| "internal" \| "private";
	5
	6	export type Repository = {
	7	clone_url: string;
	8	created_ms: number;
	9	default_bookmark: string;
	10	description: string;
	11	name: string;
	12	owner: string;
	13	updated_ms: number;
	14	visibility: Visibility;
	15	};
	16
	17	export type Bookmark = {
	18	changes: number;
	19	default: boolean;
	20	heads: string[];
	21	name: string;
	22	};
	23
	24	export type Tag = {
	25	heads: string[];
	26	message: string;
	27	name: string;
	28	signer?: string \| null;
	29	};
	30
	31	export type Author = {
	32	account?: string \| null;
	33	email: string;
	34	key: string;
	35	name: string;
bf1ab345 Andy McCall 1 month ago ↶	36	note?: string \| null;
b64e2537 Andy McCall 1 month ago ↶	37	};
	38
	39	export type Signature = {
	40	status: "unsigned";
	41	} \| {
	42	key: string;
	43	revoked: boolean;
	44	sealed: boolean;
	45	status: "valid";
	46	} \| {
	47	reason: string;
	48	status: "invalid";
	49	};
	50
	51	export type ChangeSummary = {
	52	author: Author;
	53	deps: string[];
	54	hash: string;
	55	head: boolean;
	56	message: string;
	57	signature: Signature;
	58	when_ms: number;
	59	};
	60
	61	export type Problem = {
	62	detail: string;
	63	status: number;
	64	title: string;
	65	};
	66
	67	export type Approval = {
	68	account: string;
	69	key?: string \| null;
	70	sealed: boolean;
	71	};
	72
b66e70b7 Andy McCall 1 month ago ↶	73	export type Landed = {
	74	by: string;
	75	via: string;
	76	when_ms: number;
	77	};
	78
b64e2537 Andy McCall 1 month ago ↶	79	export type ProposalSource = {
	80	bookmark: string;
	81	kind: "bookmark";
	82	} \| {
	83	bookmark: string;
	84	kind: "fork";
	85	name: string;
	86	owner: string;
	87	} \| {
	88	hashes: string[];
	89	kind: "changes";
	90	};
	91
	92	export type ProposalState = "draft" \| "open" \| "landed" \| "closed";
	93
	94	export type Proposal = {
	95	approvals: Approval[];
	96	author: string;
	97	blockers: string[];
	98	body: string;
	99	changes: ChangeSummary[];
	100	conflicted: boolean;
	101	created_ms: number;
	102	landable: boolean;
b66e70b7 Andy McCall 1 month ago ↶	103	landed?: Landed \| null;
b64e2537 Andy McCall 1 month ago ↶	104	number: number;
	105	projected_heads: string[];
	106	projected_state?: string \| null;
	107	repository_url: string;
b66e70b7 Andy McCall 1 month ago ↶	108	requested_reviewers?: string[];
b64e2537 Andy McCall 1 month ago ↶	109	source: ProposalSource;
	110	source_url?: string \| null;
	111	state: ProposalState;
	112	target: string;
	113	title: string;
	114	updated_ms: number;
	115	url: string;
	116	};
	117
	118	export type Label = {
	119	colour: string;
	120	description: string;
	121	name: string;
	122	};
	123
	124	export type Issue = {
	125	assignees: string[];
	126	author: string;
	127	body: string;
	128	closed_ms?: number \| null;
	129	comments: number;
	130	created_ms: number;
	131	labels: Label[];
	132	locked: boolean;
	133	milestone?: string \| null;
	134	number: number;
	135	pinned: boolean;
	136	reason: string;
	137	state: string;
	138	title: string;
	139	updated_ms: number;
	140	url: string;
	141	};
	142
	143	export type Milestone = {
	144	closed: number;
	145	description: string;
	146	due_ms?: number \| null;
	147	open: number;
	148	state: string;
	149	title: string;
	150	};
	151
	152	export type Atom = {
	153	change: string;
	154	index: number;
	155	};
	156
	157	export type Comment = {
9bc6b472 Andy McCall 1 month ago ↶	158	anchor?: Atom \| null;
b64e2537 Andy McCall 1 month ago ↶	159	author: string;
	160	body: string;
	161	created_ms: number;
	162	id: number;
c0fac31d Andy McCall 1 month ago ↶	163	line?: number \| null;
b64e2537 Andy McCall 1 month ago ↶	164	path?: string \| null;
	165	resolved: boolean;
	166	};
	167
3f02e5ea Andy McCall 1 month ago ↶	168	export type ProposalFile = {
	169	added: number;
	170	from?: string \| null;
	171	kind: string;
	172	path: string;
	173	removed: number;
	174	};
	175
42a0ba4b Andy McCall 1 month ago ↶	176	export type Notification = {
	177	actor: string;
	178	at_ms: number;
	179	id: number;
	180	kind: string;
	181	read: boolean;
	182	title: string;
	183	url: string;
	184	};
	185
	186	export type Inbox = {
	187	items: Notification[];
	188	unread: number;
	189	};
	190
b64e2537 Andy McCall 1 month ago ↶	191	export type Review = {
	192	author: string;
	193	body: string;
	194	created_ms: number;
	195	id: number;
	196	sealed: boolean;
	197	verdict: string;
	198	};
	199
	200	export type TreeEntry = {
	201	conflicted: boolean;
	202	exec: boolean;
	203	kind: string;
	204	name: string;
	205	path: string;
	206	size?: number \| null;
	207	};
	208
	209	export type BlameLine = {
	210	author: string;
	211	change: string;
	212	index: number;
	213	line: number;
	214	text: string;
	215	when_ms: number;
	216	};
	217
	218	export type FileChange = {
	219	added: number;
	220	from?: string \| null;
	221	kind: string;
	222	path: string;
	223	removed: number;
	224	};
	225
	226	export type ChangeDetail = {
	227	body: string;
	228	change: ChangeSummary;
	229	dependents: string[];
	230	files: FileChange[];
	231	in_bookmarks: string[];
	232	in_tags: string[];
	233	};
	234
	235	export type History = {
	236	changes: ChangeSummary[];
	237	heads: string[];
	238	offset: number;
	239	reference: string;
	240	total: number;
	241	};
	242
	243	export type Conflict = {
	244	bookmark: string;
	245	contributors: string[];
	246	kind: string;
	247	path: string;
	248	};
	249
	250	export type Push = {
	251	at_ms: number;
	252	changes: number;
	253	heads: number;
	254	new_state: string;
255	ok: boolean;
256	old_state: string;
257	pusher: string;
258	reason: string;
259	reference: string;
260	};
261
262	export type Policy = {
263	expires_ms: number;
264	root_threshold: number;
265	roots: string[];
266	rules: Rule[];
267	serial: number;
268	};
269
270	export type Rule = {
271	allow_conflicts: boolean;
272	keys: string[];
273	pattern: string;
274	require: string;
275	threshold: number;
276	};
277
278	export type Trust = {
279	hub_key: string;
280	invalid: string[];
9bc6b472 Andy McCall 1 month ago ↶	281	policy?: Policy \| null;
b64e2537 Andy McCall 1 month ago ↶	282	sealed: number;
	283	signed: number;
	284	unsigned: number;
	285	};
	286
	287	export type Hook = {
	288	active: boolean;
	289	created_ms: number;
	290	events: string;
	291	id: number;
	292	url: string;
	293	};
	294
	295	export type NewHook = {
	296	events?: string;
	297	secret: string;
	298	url: string;
	299	};
	300
	301	export type CheckStatus = "queued" \| "running" \| "passed" \| "failed" \| "cancelled" \| "skipped";
	302
	303	export type Check = {
	304	finished_ms?: number \| null;
	305	name: string;
	306	reporter: string;
	307	seal?: string \| null;
	308	started_ms: number;
	309	state: string;
	310	status: CheckStatus;
	311	summary: string;
	312	url: string;
	313	};
	314
	315	export type NewCheck = {
	316	name: string;
	317	seal?: string \| null;
	318	state: string;
	319	status: CheckStatus;
	320	summary?: string;
	321	url?: string;
	322	};
	323
	324	export type User = {
	325	created_ms: number;
	326	display_name: string;
	327	is_admin: boolean;
	328	keys: string[];
	329	username: string;
	330	};
	331
	332	export type Organisation = {
	333	description: string;
	334	display_name: string;
	335	members: string[];
	336	name: string;
	337	};
	338
	339	export type NewRepository = {
	340	description?: string;
	341	name: string;
	342	owner: string;
	343	visibility?: Visibility;
	344	};
	345
346	export type NewIssue = {
76f262e1 Andy McCall 1 month ago ↶	347	assignees?: string[];
b64e2537 Andy McCall 1 month ago ↶	348	body?: string;
76f262e1 Andy McCall 1 month ago ↶	349	labels?: string[];
76f262e1 Andy McCall 1 month ago ↶	350	milestone?: string \| null;
b64e2537 Andy McCall 1 month ago ↶	351	title: string;
76f262e1 Andy McCall 1 month ago ↶	352	};
	353
	354	export type IssueEdit = {
	355	assignees?: string[] \| null;
	356	body?: string \| null;
	357	labels?: string[] \| null;
	358	milestone?: string \| null;
	359	title?: string \| null;
	360	};
	361
	362	export type NewLabel = {
	363	colour?: string \| null;
	364	description?: string;
	365	name: string;
b64e2537 Andy McCall 1 month ago ↶	366	};
b64e2537 Andy McCall 1 month ago ↶	367
961c10be Andy McCall 1 month ago ↶	368	export type RequiredChecks = {
	369	names: string[];
	370	};
	371
ef20fdc1 Andy McCall 1 month ago ↶	372	export type Project = {
	373	closed: boolean;
	374	description: string;
	375	number: number;
	376	owner: string;
	377	public: boolean;
	378	title: string;
	379	updated_ms: number;
	380	url: string;
	381	};
	382
	383	export type ProjectCard = {
	384	id: number;
	385	kind: string;
	386	reference: string;
	387	state: string;
	388	title: string;
	389	};
	390
	391	export type ProjectColumn = {
	392	cards: ProjectCard[];
	393	id: number;
	394	name: string;
	395	};
	396
	397	export type Board = {
	398	columns: ProjectColumn[];
	399	project: Project;
	400	};
	401
	402	export type NewProject = {
	403	description?: string;
	404	private?: boolean;
	405	title: string;
	406	};
	407
	408	export type ProjectEdit = {
	409	closed?: boolean \| null;
	410	description?: string \| null;
	411	private?: boolean \| null;
	412	title?: string \| null;
	413	};
	414
	415	export type NewCard = {
	416	column?: string \| null;
	417	note?: string;
	418	reference?: string;
	419	};
	420
	421	export type CardMove = {
	422	column: string;
	423	};
	424
b64e2537 Andy McCall 1 month ago ↶	425	export type NewComment = {
b64e2537 Andy McCall 1 month ago ↶	426	body: string;
3f4b0ea6 Andy McCall 1 month ago ↶	427	line?: number \| null;
3f4b0ea6 Andy McCall 1 month ago ↶	428	path?: string \| null;
b64e2537 Andy McCall 1 month ago ↶	429	};
	430
	431	export type NewProposal = {
	432	body?: string;
	433	draft?: boolean;
	434	source: string;
	435	target: string;
	436	title: string;
	437	};
	438
	439	export type NewReview = {
	440	body?: string;
	441	verdict: string;
	442	};
	443
	444	export type IssueStateChange = {
	445	reason?: string;
	446	state: string;
	447	};
	448
	449	export type WebhookEnvelope = {
	450	actor: string;
	451	at_ms: number;
	452	data: unknown;
	453	delivery: string;
	454	event: string;
9bc6b472 Andy McCall 1 month ago ↶	455	repository?: Repository \| null;
b64e2537 Andy McCall 1 month ago ↶	456	};
	457
	458	export type ProposalEvent = {
9bc6b472 Andy McCall 1 month ago ↶	459	check?: Check \| null;
b64e2537 Andy McCall 1 month ago ↶	460	kind: string;
b64e2537 Andy McCall 1 month ago ↶	461	number: number;
bf1ab345 Andy McCall 1 month ago ↶	462	};
	463
	464	export type AssetBuild = {
	465	artifact: string;
	466	job: string;
	467	receipt?: string \| null;
	468	receipt_url?: string \| null;
	469	run: number;
	470	run_url: string;
	471	signer?: string \| null;
b64e2537 Andy McCall 1 month ago ↶	472	};
b64e2537 Andy McCall 1 month ago ↶	473
3f4b0ea6 Andy McCall 1 month ago ↶	474	export type ReleaseAsset = {
bf1ab345 Andy McCall 1 month ago ↶	475	built_by?: AssetBuild \| null;
3f4b0ea6 Andy McCall 1 month ago ↶	476	content_type: string;
	477	downloads: number;
	478	hash: string;
	479	name: string;
	480	size: number;
	481	url: string;
	482	};
	483
	484	export type Release = {
	485	archives: string[];
	486	assets: ReleaseAsset[];
	487	author: string;
	488	created_ms: number;
	489	heads: string[];
	490	latest: boolean;
	491	notes: string;
	492	prerelease: boolean;
	493	signer?: string \| null;
	494	tag: string;
	495	title: string;
bf1ab345 Andy McCall 1 month ago ↶	496	url: string;
	497	};
	498
	499	export type FlowJob = {
	500	depends_on: string[];
	501	error: string;
	502	exit_code?: number \| null;
	503	finished_ms?: number \| null;
	504	log_lines: number;
	505	name: string;
	506	runner: string;
	507	started_ms?: number \| null;
	508	status: string;
	509	};
	510
	511	export type FlowRun = {
	512	actor: string;
	513	bookmark: string;
	514	created_ms: number;
	515	error: string;
	516	finished_ms?: number \| null;
	517	heads: string[];
	518	jobs?: FlowJob[];
	519	number: number;
	520	pipeline_hash: string;
	521	queue_position?: number \| null;
	522	state: string;
	523	status: string;
	524	trigger: string;
3f4b0ea6 Andy McCall 1 month ago ↶	525	url: string;
bf1ab345 Andy McCall 1 month ago ↶	526	};
	527
	528	export type FlowLogLine = {
	529	seq: number;
	530	stream: string;
	531	t: number;
	532	text: string;
3f4b0ea6 Andy McCall 1 month ago ↶	533	};
	534
	535	export type NewRelease = {
	536	notes?: string \| null;
	537	prerelease?: boolean;
	538	tag: string;
	539	title: string;
	540	};
	541

Keyboard