sodafoundation / delfin

delfin is the SODA Infrastructure Manager project which provides unified, intelligent and scalable resource management, alert and performance monitoring
https://sodafoundation.io/
Apache License 2.0
202 stars 355 forks source link

Inconsistent swagger description with implementation (Alerts) #1022

Open te-koyanagi opened 6 months ago

te-koyanagi commented 6 months ago

Issue/Feature Description: Found an inconsistentency in the swagger description with implementation (openapi-spec/swagger.yaml) about Alerts.

Why this issue to fixed / feature is needed(give scenarios or use cases): It must be correct for better user experience as no API document exists other than this swagger description.

How to reproduce, in case of a bug: Following API works as expected, but not in the swagger.yaml.

$ curl -s -X GET http://192.168.231.101:31000/v1/storages/014a38ed-c60e-4994-9f5a-fc7b7f0a5d4d/alerts | jq .
{
  "alerts": [
    {
      "alert_id": 65766686728,
      "alert_name": "CA Certificate Has Expired",
      "severity": "Critical",
      "category": "Fault",
      "type": "NotSpecified",
      "sequence_number": 21168209,
      "occur_time": 1698715016000,
      "description": "The (CA certificate of Call Home authentication, use (N/A)) has expired, and a new one must be imported and activated.",
      "recovery_advice": "Generate and import a valid CA certificate.",
      "resource_type": "Storage",
      "location": "CertificateType=8,Deadline=2023-10-30,use=N/A",
      "storage_id": "014a38ed-c60e-4994-9f5a-fc7b7f0a5d4d",
      "storage_name": "OceanStor",
      "vendor": "Huawei",
      "model": "dorado01",
      "serial_number": "2102352KRP10K1000001"
    }
  ]
}

Other Notes / Environment Information: (Please give the env information, log link or any useful information for this issue)

te-koyanagi commented 6 months ago

See the following document for the test configuration: https://docs.google.com/document/d/1WesXmZV0eRDgG2cjg2myqd5BK1t-Eg36O0IzkA6BTto/edit?usp=sharing