Docs: extend REST API

[ltalirz]

fixes #4043

Move the documentation on how to extend the AiiDA REST API to the
"Internal Architecture" section.

[ltalirz]

@giovannipizzi I have edited the original documentation text only very minimally.
I've checked that the example still runs and that the text makes still sense; it could probably be improved further but given the plans to overhaul the REST API, I think it would be a waste of time.

[giovannipizzi]

I agree that it doesn't make sense at this stage to change significantly this.

Beside the comments (mostly formatting), could you also add a new redirect for the old page?

[ltalirz]

Beside the comments (mostly formatting), could you also add a new redirect for the old page?

Thanks, redirect added!

[ramirezfranciscof]

Hi @ltalirz , thanks for the work! I tried to read it thoroughly and made a few comments, could you take a look and tell me what you think?

As an additional general one, could you change the - itemization with *? I know its super nitpicky but its what it says in the guidelines.

[ltalirz]

Hi @ramirezfranciscof thanks for checking the text; I've added a couple of your suggested fixed as well as fixed a broken reference.

Let me know in case you think anything else is necessary - as mentioned above this is a rather specific developer-oriented documentation that will likely become obsolete to some degree once the REST API is touched for the next time.

[ramirezfranciscof]

Let me know in case you think anything else is necessary - as mentioned above this is a rather specific developer-oriented documentation that will likely become obsolete to some degree once the REST API is touched for the next time.

Ah, I see. Sorry if these were too much corrections then: please rebase the work and I'll merge it.

Also, if this is the case, could I ask you to open an issue mentioning that the section is "temporary" and what other sections might be in the same bag? So that we remember in case people make comments to improve these or don't forget anything when the time comes to make the changes.

[ltalirz]

please rebase the work and I'll merge it.

Done!

Also, if this is the case, could I ask you to open an issue mentioning that the section is "temporary" and what other sections might be in the same bag? So that we remember in case people make comments to improve these or don't forget anything when the time comes to make the changes.

I think it's fine - we will remember when changes are made to the REST API.

This piece of documentation has a very limited target group (developers who want to extend the REST API) - if anyone would like to invest time to improve it, they are welcome, but I think it is not a very important part of the docs (e.g. I started editing the REST API without ever reading it).

[ramirezfranciscof]

Ready to go!