Updated and polished the "Torii Endpoints" topic

[yamkovoy]

Changes

• Updated and polished the Torii Endpoints topic:
  • Added intro;
  • Streamlined the structure of the entries (operations);
  • Clarified wording;
  • Added context and cross-references, etc;
  • Added responses;
  • Added several TODO reminders for future updates.
• Fixed and/or removed dead links in the related topics (e.g., Advanced > Metrics).

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
iroha-2-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 31, 2024 5:20pm

[0x009922]

LGTM!

Torii endpoints now seem to be more structured and detailed. For me, as a developer, it became clearer.

However, there are a lot of inaccurate details as well.

[yamkovoy]

Changes

• Addressed comments by @0x009922;
• Added requested TODO reminders;
• Added several notes on Iroha features/flags;
• Added Schema and Pending Transactions operations;
• Other minor changes.

Notes & Questions

• In the guide/advanced/metrics.md topic, the How to use metrics subtopic still has the instructions. I couldn't leave it empty, nor could I roll it back to the previous version, since the config file mentioned in it no longer exists.

  @0x009922, any advice on what information should we place there until PR [docs]: New configuration reference #397 is ready to be merged?

• In both guide/advanced/metrics.md and reference/torii-endpoints.md topics, @0x009922 pointed out in his comments some inaccurate bits of information on how to configure metrics and Torii API. Since I gathered the instructions that I placed there from the exisiting Configure Iroha topics (i.e., Peer Configuration, Client Configuration, etc.), I am struggling to understand what exactly was inaccurate. I expected there to be inconsistencies that I was hoping could be resolved within this PR, however, as I understand your comments, the added instructions were completely off the mark.

  @0x009922, is it some misunderstanding from my part or have there been some significant changes that are yet to be documented?
  Please, do not take this question as offensive, since I'm merely trying to understand my mistake and help us achieve the best possible result that can only be found in cooperation.

[0x009922]

@yamkovoy, I am totally fine with your questions, and I can see that my comments might look unclear.

The configuration sections you have provided are inaccurate primarily because the whole config system is currently under overhaul by me. I do not provide you any information yet about how to document it properly, and ask you just to leave TODO marks so that I can pick it up later and fill the gaps.

Thus, it would be totally fine in scope of this PR to leave TODO marks instead of trying to cover configuration topics, IMO.

If it would mean to leave the whole Metrics topic empty - so be it.

Please wait until I prepare the configuration reference which will be the foundation in future. (#397)

[0x009922]

LGTM.

High attention to detail. In some places even a little bit too much (imo), but it's fine.