Skip to content
This repository has been archived by the owner on Mar 14, 2024. It is now read-only.

Commit

Permalink
docs(report): update report api spec
Browse files Browse the repository at this point in the history
  • Loading branch information
tomwwinter committed Jan 31, 2024
1 parent 17dc9e7 commit 16a2389
Showing 1 changed file with 33 additions and 12 deletions.
45 changes: 33 additions & 12 deletions docs/Report API.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ info:
title: Aam Digital - Report API
description: |-
todo
version: 1.0.0-draft.2
version: 1.0.0-draft.3
servers:
- url: https://dev.aam-digital.com/api/v1
tags:
Expand All @@ -23,13 +23,13 @@ paths:
type: array
items:
$ref: '#/components/schemas/Report'
# post:
# tags:
# - report
# summary: Create a new Report
# responses:
# default:
# description: response
# post:
# tags:
# - report
# summary: Create a new Report
# responses:
# default:
# description: response

/report/{reportId}:
get:
Expand Down Expand Up @@ -88,6 +88,25 @@ paths:
type: string
example: "ReportCalculation"

/report-calculation/report/{reportId}:
get:
tags:
- report
summary: Return all report calculations for a report
parameters:
- in: path
name: reportId
schema:
type: string
required: true
responses:
200:
description: Successful report data response
content:
application/json:
schema:
$ref: '#/components/schemas/ReportCalculation'

/report-calculation/{calculationId}:
get:
tags:
Expand All @@ -105,7 +124,9 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportCalculation'
type: array
items:
$ref: '#/components/schemas/ReportCalculation'

/report-calculation/{calculationId}/data:
get:
Expand Down Expand Up @@ -142,9 +163,9 @@ components:
name:
type: string
example: report_all_course_members
# last_run:
# type: string
# format: date
# last_run:
# type: string
# format: date
calculationPending:
type: boolean
schema:
Expand Down

0 comments on commit 16a2389

Please sign in to comment.