Reports

List all report manifests

get/api/reports

Response

A list of report manifests

manifestUrlstring

namestring required

displayNamestring required

descriptionstring required

versionstring required

authorstring required

publisherstring required

licensestring required

repositorystring required

bugsstring required

categoriesstring[] required

keywordsstring[] required

configurationobject required

Configuration settings for the report

Example response

[
  {
    "manifestUrl": "https://raw.githubusercontent.com/givepraise/reports/main/reports/disperse-dist-straight-curve-with-ceiling/manifest.json",
    "name": "simple-report",
    "displayName": "Simple Report",
    "description": "A simple report.",
    "version": "1.2.3",
    "author": "General Magic",
    "publisher": "general-magic",
    "license": "MIT",
    "repository": "https://github.com/givepraise/reports",
    "bugs": "https://github.com/givepraise/reports/issues",
    "categories": [
      "Basic reports",
      "Praise receiver reports"
    ],
    "keywords": [
      "toplist"
    ]
  }
]

Changes

Changed in 9 of the 50 revisions of this API.916

Aug 23, 2023990e717b779e1See the full diff
- ○
  endpoint added
  endpoint-added
Aug 23, 2023abdaebb919d21See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 56 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 11, 2023c25702ffb0c911See the full diff
- ▲
  added ConfigurationValueDto to the items/configuration/additionalProperties/ response property oneOf list for the response status 200
  response-property-one-of-added
- ○
  removed SettingDto from the items/configuration/additionalProperties/ response property oneOf list for the response status 200
  response-property-one-of-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 11, 202300d037b830a5511See the full diff
- ▲
  the response property items/configuration/additionalProperties/oneOf[SettingDto]/items became optional for the status 200
  response-property-became-optional
- ▲
  the response property items/configuration/additionalProperties/oneOf[SettingDto]/markdownDescription became optional for the status 200
  response-property-became-optional
- ▲
  the response property items/configuration/additionalProperties/oneOf[SettingDto]/order became optional for the status 200
  response-property-became-optional
- ▲
  response property items/configuration/additionalProperties/oneOf[SettingDto]/default list-of-types was widened by adding types array boolean number and string to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the items/configuration/additionalProperties/oneOf[SettingDto]/items response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ●
  removed the optional property items/configuration/additionalProperties/oneOf[SettingDto]/items/type from the response with the 200 status
  response-optional-property-removed
- ○
  added SettingItemsDto to the items/configuration/additionalProperties/oneOf[SettingDto]/items response property allOf list for the response status 200
  response-property-all-of-added
Jul 21, 2023c85720c5fc9e1See the full diff
- ○
  added the optional property items/manifestUrl to the response with the 200 status
  response-optional-property-added
Apr 27, 2023e14b4c818c531See the full diff
- ○
  endpoint added
  endpoint-added
Apr 21, 2023d74e83d48d621See the full diff
- ○
  endpoint added
  endpoint-added
Mar 31, 2023af4ea0086c6f1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 24, 200285037159b3441See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history