Project

General

Profile

Actions
Copy link

Task #2411

closed

Swagger documentation for Authentication has wrong example

Added by Alena Peterová over 3 years ago. Updated over 3 years ago.

Status:
Closed
Priority:
Low
Assignee:
Radek Tomiška
Category:
Documentation
Target version:
10.5.0
Start date:
07/29/2020
Due date:
% Done:

100%

Estimated time:
Owner:

Description

The swagger documentation for the Authentication endpoint (https://demo.czechidm.com/idm/swagger-ui.html?urls.primaryName=core#/Authentication) has wrong structure - the "password" parameter should be single valued. The given example doesn't work:

It should be only:

{
  "password": "string",
  "username": "admin" 
}

Files

loginDto.png (6.17 KB) loginDto.png Alena Peterová, 07/29/2020 01:33 PM
Actions
Copy link
 #1

Updated by Radek Tomiška over 3 years ago

  • Assignee changed from Ondřej Kopr to Radek Tomiška

Swagger documentation is generated automatically from "GuardedString" data type this way, we will see, what we can do here.

Actions
Copy link
 #2

Updated by Radek Tomiška over 3 years ago

  • Status changed from New to Needs feedback
  • Assignee changed from Radek Tomiška to Alena Peterová
  • Target version set to 10.5.0
  • % Done changed from 0 to 90

I fixed data type definition for "GuardedString" in swagger documentation, commit:
https://github.com/bcvsolutions/CzechIdMng/commit/f52496d48c08bb2033f7eafbfdf6f7531b0c16ae

Could you provide me a feedback, please?

Actions
Copy link
 #3

Updated by Radek Tomiška over 3 years ago

  • Assignee changed from Alena Peterová to Vít Švanda
Actions
Copy link
 #4

Updated by Vít Švanda over 3 years ago

  • Status changed from Needs feedback to Resolved
  • Assignee changed from Vít Švanda to Radek Tomiška
  • % Done changed from 90 to 100

I did review. LGTM

Actions
Copy link
 #5

Updated by Radek Tomiška over 3 years ago

  • Status changed from Resolved to Closed
Actions
Copy link

Also available in: Atom PDF