Verified Commit f2be5ab1 authored by Jakob Moser's avatar Jakob Moser
Browse files

Rename AgendaItem to Task in API docs

parent 04c0aea4
Loading
Loading
Loading
Loading
+8 −8
Changes for portal/static/docs/api/v0/openapi-spec.yaml: 8 added lines, 8 removed lines.
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ paths:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/AgendaItem"
                                    $ref: "#/components/schemas/Task"
                            examples:
                                a_short_agenda:
                                    $ref: "#/components/examples/a_short_agenda"
@@ -64,7 +64,7 @@ paths:
                        schema:
                            type: array
                            items:
                                $ref: "#/components/schemas/AgendaItem"
                                $ref: "#/components/schemas/Task"
                        examples:
                            minimal_patch:
                                value:
@@ -95,7 +95,7 @@ paths:
                            schema:
                                type: array
                                items:
                                    $ref: "#/components/schemas/AgendaItem"
                                    $ref: "#/components/schemas/Task"
                            examples:
                                a_shorter_agenda:
                                    $ref: "#/components/examples/a_shorter_agenda"
@@ -202,18 +202,18 @@ paths:
security: []
components:
    schemas:
        AgendaItem:
            title: Item on an agenda
            description: "An item on an agenda. It has a name and might be linked to a user story in Taiga."
        Task:
            title: Task
            description: "A task in a task list. It has a name and might be linked to a user story in Taiga."
            required:
                - name
            type: object
            properties:
                name:
                    description: Human-readable name of the item.
                    description: Human-readable name of the task.
                    type: string
                taiga:
                    description: Additional metadata for the user story as provided by Taiga, if the item corresponds to one.
                    description: Additional metadata for the user story as provided by Taiga, if the task corresponds to one.
                    type: object
                    required:
                        - id