Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE]: Improve the OpenAPI documentation #71

Open
JCHacking opened this issue Feb 11, 2024 · 1 comment
Open

[FEATURE]: Improve the OpenAPI documentation #71

JCHacking opened this issue Feb 11, 2024 · 1 comment

Comments

@JCHacking
Copy link
Contributor

Please read our contributor guide before creating an issue.
Also consider discussing your idea on the discussion forum first.

Describe the Feature Request

Improve OpenAPI documentation to improve these aspects:

  • Possible answers (now all according to OpenAPI are 200)
  • Improve if possible some answers or use cases that give unexpected results

Describe Preferred Solution

Modify rest conductor to add better definitions for OpenAPI

@JCHacking
Copy link
Contributor Author

JCHacking commented Feb 11, 2024

Good morning, I am addressing this improvement.
Who should I ask about "strange" behaviors I see? And where? Thanks!!!

For now I comment them here, if it is necessary that I move them to a discussion or mention someone let me know.

  • POST /api/admin/sweep/requeue/194f1b36-0dcf-4829-bff5-49d96107b6fd
    
    STATUS CODE -> 200
    true.194f1b36-0dcf-4829-bff5-49d96107b6fd
    
    Does this answer make sense? Or should we return a 204 in case it is pushed and a 500 in case it is not?
  • POST /api/admin/consistency/verifyAndRepair/194f1b36-0dcf-4829-bff5-49d96107b6fd
    
    STATUS CODE -> 200
    false
    
    Does this answer make sense? Or should we return a 204 in case it is repaired and a 500 in case it is not?
  • POST /api/admin/consistency/verifyAndRepair/test
    
    STATUS CODE -> 500
    {
      "status": 500,
      "message": "Cannot invoke \"com.netflix.conductor.model.WorkflowModel.getStatus()\" because \"workflow\" is null",
      "instance": "2164be719527",
      "retryable": false
    }
    
    Should it be an error more like 422 or 400?
  • GET /api/admin/queues?verbose=true1
    
    STATUS CODE -> 500
    {
      "status": 500,
      "message": "Failed to convert value of type 'java.lang.String' to required type 'boolean'; Invalid boolean value [true1]",
      "instance": "2164be719527",
      "retryable": false
    }
    
    Should it be an error more like 422 or 400?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant