Drop id field, mention default items (2f8cba0b) · Commits · Fachschaft / Portal

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

+10 −7

Changes for portal/static/docs/api/v0/openapi-spec.yaml: 10 added lines, 7 removed lines.
Original line number	Diff line number	Diff line
		@@ -25,11 +25,20 @@ paths:
		type: array
		items:
		$ref: "#/components/schemas/AgendaItem"
		examples:
		a_short_agenda:
		value:
		- name: "Tagesordnung"
		- name: "Gremienberichte"
		- name: "Posteingang und Kummerkasten"
		- name: "Sommerfest: Planen (irgendwann noch offizielle Einladung)"
		- name: "Sommer-Coliwochenende: Veranstalten"
		- name: "Sonstiges"
		description: Successful response, returns a list of items
		operationId: getTheAgendaItems
		summary: List all items on the agenda
		description: \|
		This returns all items currently on the agenda for a Fachschaftssitzung. The items are directly sourced from the todo tool _Taiga_ ([fsco.li/todo](https://fsco.li/todo)).
		This returns all items currently on the agenda for a Fachschaftssitzung. A few of the standard items are auto-generated, the rest is directly sourced from the todo tool _Taiga_ ([fsco.li/todo](https://fsco.li/todo)).

		### Which Fachschaftssitzung?

		@@ -124,19 +133,13 @@ components:
		title: Item on an agenda
		description: "An item on an agenda. It has a name and an id."
		required:
		- id
		- name
		type: object
		properties:
		id:
		description: Id of the item, as provided by the Taiga todo tool.
		type: integer
		readOnly: true
		name:
		description: Human-readable name of the item.
		type: string
		example:
		id: 349
		name: "Sommer-Coliwochendende: Veranstalten"
		ApplicationVersion:
		title: ApplicationVersion