API docs and seqences

[sbcgua]

Hi, great library ! Big potential 👍
One question (maybe stupid one) - is there any docs on ADT API ? I mean .e.g I want to create a program or transaction - how do I find which sequence of API calls (in ADT in general and in abap-adt-api in particular) should I call ?

[marcellourbani]

As far as I know there isn't. Closest thing are the tests: they all work (well, they do on my system, I do plan to reorganise them and release a couple of abapgit archives for them) I don't think I will ever find the time and inclination to write a proper documentation. Might do a bare-bones one sometime, but only after the vscode plugin is complete. Don't hold your breath!

…

On Mon, 1 Apr 2019, 23:19 Alexander Tsybulsky, ***@***.***> wrote: Hi, great library ! Big potential 👍 One question (maybe stupid one) - is there any docs on ADT API ? I mean .e.g I want to create a program or transaction - how do I find which sequence of API calls (in ADT in general and in abap-adt-api in particular) should I call ? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#3>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACVvHS-xrc7awA_HHZZwesaPS3TcxGa0ks5vcoX9gaJpZM4cWwHS> .

[marcellourbani]

For instance, test "Create and delete" in disruptive.test.ts hsows the sequence of calls to create an object in a local package.
For non local ones transport management needs to be added, as in "save with transport"

[sbcgua]

Does it mean you've reverse engineered all the current functionality? Wow ! Cool !!

Yeah, the docs could be very helpful :) I found that test, it actually solves my intent for the moment, thanks ! Just wanted to have some broader outlook. E.g. in the code below how do I know the suffix for object type and that I have to append source/main to get the code. But yes, the tests helps anyway, and then debugging and logging will do the rest :) Thanks again for the great library !

    const nodes = await client.nodeContents("DEVC/K", "$ERDL");
    const code = await client.getObjectSource('/sap/bc/adt/programs/programs/zsomeprog/source/main

[marcellourbani]

the Right Way(tm) to do that is using ADTClient.mainInclude() after getting the object structure with objectStructure()

const nodes = await client.nodeContents("DEVC/K", "$ERDL");
const node = nodes.nodes.find(...)
const structure = await client.objectStructure(node.OBJECT_URI)
const code = await client.getObjectSource(client.mainInclude(structure))

But you almost always end up with /source/main anyway

BTW, eclipse logs every call, so RI is quite easy
Will leave this open as I do think it's needed, I just don't have time to sort it