Project

General

Profile

Feature #47615

Feature #40907: mgr/dashboard: REST API improvements

mgr/dashboard: api doc: fix endpoint responses doc generation.

Added by Alfonso Martínez 4 months ago. Updated 4 months ago.

Status:
Resolved
Priority:
Normal
Category:
dashboard/documentation
Target version:
% Done:

100%

Source:
Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

Currently we have these 2 issues:

1) When the documented response is a list, it's shown as a dict.

2) When 2+ responses are documented for 2+ status codes (1 of them not being allowed in any other HTTP method i.e. 202 for GET method), we get an error.

History

#1 Updated by Alfonso Martínez 4 months ago

  • Subject changed from mgr/dashboard: api doc: fix endpoint responses generation. to mgr/dashboard: api doc: fix endpoint responses doc generation.

#2 Updated by Alfonso Martínez 4 months ago

  • Category set to dashboard/documentation
  • Status changed from New to Fix Under Review
  • Pull request ID set to 37375

#3 Updated by Alfonso Martínez 4 months ago

  • Backport deleted (octopus)

#4 Updated by Lenz Grimmer 4 months ago

  • Status changed from Fix Under Review to Resolved

#5 Updated by Alfonso Martínez 4 months ago

  • % Done changed from 0 to 100

Also available in: Atom PDF