REST API - documentation vs. real world

Follow

Stephan STEINER

• May 29, 2019 07:31

Could it be possible that the API documentation is outdated? E.g. when I log in, what I get as a result contains more properties than what the documentation lists.

0

• 

  Nicolas VIVIEN

  • May 29, 2019 11:18
  • Edited

  Hello Stephan,

  Yes, that is possible that some recently added fields have not been added to some documentation examples. Also, some fields are used only internally and such not documented publically.

  As some resources may be returned by several APIs, it is quite difficult to maintain up to date this resource documentation everywhere.

  I'll have a look to the login API documentation to complete it if needed. Can you tell me what fields did you observed that were missing from the documentation? After an analysis on my side I found the fields tags, userInfo1 and userInfo2 which are fields added in the previous release and indeed not documented in login API (but documented in enduser and admin APIs).

   

  Best regards,

  Nicolas VIVIEN                                                                    
  Cloud Software Engineer (API Server Team)
  ALE International, Cloud Services Business Unit

  0

  Comment actions Permalink
• 

  Vincent BERDER

  • May 29, 2019 15:18

  Hello Nicolas,

   

  The userInfo1/2 fields are also missing in the get method doc of the Admin API.

   

  BR,

  Vincent.

  0

  Comment actions Permalink
• 

  Nicolas VIVIEN

  • June 03, 2019 13:30
  • Edited

  Thank you Vincent, I also fixed the userInfo fields in the admin API documentation. The fields were in fact documented, but not shown in the JSON example (which can also be right, as the fields are optionals they can be absent in the JSON response). I also fixed the field documentation for isInDefaultCompany which wasn't documented in the data structure (while it is in the data structure).

  The corrections will be in the next version.

   

  Best regards,

  Nicolas VIVIEN
  Cloud Software Engineer (API Server Team)
  ALE International, Cloud Services Business Unit

  0

  Comment actions Permalink

Please sign in to leave a comment.