PlatformOfTrust / collected-feedback

Feedbacks and Wishlist for Platform of Trust are collected as issues in this repository.
0 stars 1 forks source link

API profile page needs some content curation #7

Closed kyyberi closed 4 years ago

kyyberi commented 4 years ago

Describe the Pain in using this API

I fail to understand:

Indicate the importance in number

(1. Critical, 2. Important, 3. Nice-to-have)

2.

Additional context Add any other context or screenshots about the feature request here.

Näyttökuva 2020-3-30 kello 16 20 39
Nazarah commented 4 years ago

@kyyberi thanks for your issue.

why description field is not by default open but I have to make additional point and click to see what this API is about

This needs to be fixed from the CMS's side. I'll add an issue for the team and prioritize to fix it.

why the version information is as header. Same information is said above (just after the header which says the name of the API)

This can also be removed, although was kept for recognition rather than recall.

why the endpoints are list here? The value is minimal without knowing what the endpoints do and that is in API docs. In addition, another thing to update in dev portal when API changes.

This can be removed as well.

Nazarah commented 4 years ago

@kyyberi Redundant version number and endpoints have been removed from API Profile. About keeping the 1st expand-collapse section open, the issue is in the list of fixes and should soon be implemented. Hence closing this issue.