[GitHub] [dolphinscheduler] kyoty opened a new issue #5758: [Improvement][APIDoc] There are some problems in the api documentation that need to be improved

Tue, 06 Jul 2021 21:34:44 -0700 


kyoty opened a new issue #5758:
URL: https://github.com/apache/dolphinscheduler/issues/5758


    ### 1. Some catagory names are directly displayed as variable names, 
lacking correct descriptions in Chinese and English
   
   
![image](https://user-images.githubusercontent.com/52202080/124699395-4c2d1280-df1d-11eb-8950-6a5b99535af5.png)
  
   
   
    ### 2. Some interface descriptions are directly displayed as variable 
names, which is not friendly  
   
   
![image](https://user-images.githubusercontent.com/52202080/124699462-65ce5a00-df1d-11eb-8429-96c1b16b2b4d.png)
  
   
    ### 3. Many request parameters are actually necessary, but the page of api 
doc display as unnecessary, which will mislead developers and increase the cost 
to use.
   
   
![image](https://user-images.githubusercontent.com/52202080/124699902-4d127400-df1e-11eb-8ca5-d0f0d69c1a7e.png)
    
   
    ### 4. API has multiple different styles, which are not friendly and easy 
to confuse.
    
   
![image](https://user-images.githubusercontent.com/52202080/124699527-8991a000-df1d-11eb-962a-69d229bf96cc.png)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to