Add Taiga reference to API spec (2597e320) · Commits · Fachschaft / Portal

portal/static/docs/api/v0/openapi-spec.yaml

+26 −2

Changes for portal/static/docs/api/v0/openapi-spec.yaml: 26 added lines, 2 removed lines.
Original line number	Diff line number	Diff line
		@@ -2,7 +2,7 @@
		openapi: 3.0.2
		info:
		title: FS Coli Portal
		version: 0.0.0
		version: 0.1.0
		description: API endpoints related to the work of the Fachschaft Computerlinguistik
		license:
		name: MIT License
		@@ -32,9 +32,17 @@ paths:
		- name: "Gremienberichte"
		- name: "Posteingang und Kummerkasten"
		- name: "Sommerfest: Planen (irgendwann noch offizielle Einladung)"
		taiga:
		id: 235
		status: 42
		- name: "Sommer-Coliwochenende: Veranstalten"
		taiga:
		id: 213
		status: 42
		- name: "Sonstiges"
		description: Successful response, returns a list of items
		"401":
		$ref: "#/components/responses/UnauthorizedError"
		operationId: getTheAgendaItems
		summary: List all items on the agenda
		description: \|
		@@ -132,7 +140,7 @@ components:
		schemas:
		AgendaItem:
		title: Item on an agenda
		description: "An item on an agenda. It has a name and an id."
		description: "An item on an agenda. It has a name and might be linked to a user story in Taiga."
		required:
		- name
		type: object
		@@ -140,8 +148,24 @@ components:
		name:
		description: Human-readable name of the item.
		type: string
		taiga:
		description: Additional metadata for the user story as provided by Taiga, if the item corresponds to one.
		type: object
		required:
		- id
		- status
		properties:
		id:
		description: Numerical id of the user story in Taiga
		type: integer
		status:
		description: Numerical id of the status (e.g. 42 means “for next meeting”, 41 means “to do”)
		type: integer
		example:
		name: "Sommer-Coliwochendende: Veranstalten"
		taiga:
		id: 213
		status: 42
		ApplicationVersion:
		title: ApplicationVersion
		description: Version details about the application