vitaliizghonnik / trello-rest-api-doc-issues

Issues reported in the official Trello REST API documentation
0 stars 0 forks source link

[Discrepancy]: Inconsistency in Trello REST API documentation regarding the content base URL outlook between two allowed view modes #1

Open vitaliizghonnik opened 8 months ago

vitaliizghonnik commented 8 months ago

What is the discrepancy?

Trello has recently introduced a New View of the REST API documentation with a different outlook in the base URL section than it represented in the Classic View. In New View, the aside section shows the method of REST API, the endpoint is in the header, and varieties of URLs are shown in the body section. In this view, the method (GET, POST, etc.) includes the /1 (forward slash symbol and digit -1) in the URL address, which means the version of the API. In Classic View a version of API is placed beyond the method REST API.

Which version of the documentation are you using?

Version - 1

Steps to reproduce

  1. Open URL link
  2. In Classic View on the central section is POST method followed by the endpoint /1/cards/{id}/actions/comments
  3. Scroll up until a generic inline container element is at the top of the resource.
  4. On the right side at the top, click on Switch to new API view
  5. Scroll down until the heading section Add a new comment to a Card with the POST method.
  6. In New View on the right side is an aside section that is represented by the POST method followed by the endpoint /cards/{id}/actions/comments without /1

Expected result

  1. In the Classic View and the New View the method has included the same URLs.

Actual result

Attached screenshots

Classic View

Trello REST API docs - classic view

New View

Trello REST API docs - new view

What is the impact of this discrepancy?

vitaliizghonnik commented 8 months ago

This card has just been reported