The script can be run something like this: /cloudstack/tools/apidoc$ ./build-apidoc.sh 4.19.0.0 ../../client/target/cloud-client-ui-4.19.0.0.jar ../../client/target/cloud-client-ui-4.19.0.0.jar ./target
Which as Wei mentioned is what is done when you build apidoc Thanks ________________________________ From: Wei ZHOU <ustcweiz...@gmail.com> Sent: June 14, 2024 10:21 AM To: dev@cloudstack.apache.org <dev@cloudstack.apache.org> Subject: Re: Endpoint response is different than the docs Hi, you can run "mvn -P developer,systemvm clean install -pl tools/apidoc/" the api doc can be found at tools/apidoc/target/xmldoc/apis/ The api parameters and responses come from the java classes. -Wei On Fri, Jun 14, 2024 at 4:11 PM Ahmed Awlaqi <ahmed.awl...@sue.nl.invalid> wrote: > > Thanks, is there a docs on how to use this script? I see some variables I > need to pass but not sure what they are. > > On Thu, 13 Jun 2024 at 16:03, Pearl d'Silva <pearl.dsi...@shapeblue.com> > wrote: > > > The build-apidoc.sh script: > > https://github.com/apache/cloudstack/blob/main/tools/apidoc/build-apidoc.sh > > is responsible for generating the API docs. > > > > Regards. > > > > > > > > ________________________________ > > From: Ahmed Awlaqi <ahmed.awl...@sue.nl.INVALID> > > Sent: June 13, 2024 9:39 AM > > To: dev@cloudstack.apache.org <dev@cloudstack.apache.org> > > Subject: Re: Endpoint response is different than the docs > > > > Hi, > > > > I will try to submit a PR for it but do you where I can find the code that > > generates the API docs to test it. > > > > On Thu, Jun 13, 2024 at 2:40 PM Pearl d'Silva <pearl.dsi...@shapeblue.com> > > wrote: > > > > > Hi, > > > > > > There does seem to be a difference in the API command definition and the > > > actual response generated. You may either raise an issue at > > > https://github.com/apache/cloudstack/issues or could also contribute > > > towards a fix. The issue seems to be at: > > > > > > > > > > > https://github.com/apache/cloudstack/blob/main/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/heuristics/RemoveSecondaryStorageSelectorCmd.java#L30 > > > vs > > > > > > > > https://github.com/apache/cloudstack/blob/main/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/heuristics/RemoveSecondaryStorageSelectorCmd.java#L43 > > > > > > > > > Thanks, > > > Pearl > > > > > > > > > > > > > > > ________________________________ > > > From: Ahmed Awlaqi <ahmed.awl...@sue.nl.INVALID> > > > Sent: June 13, 2024 8:04 AM > > > To: dev@cloudstack.apache.org <dev@cloudstack.apache.org> > > > Subject: Endpoint response is different than the docs > > > > > > Hi, > > > > > > I faced a problem where the endpoint response is different from what is > > > written in the docs the endpoint is `removeSecondaryStorageSelector` in > > > here > > > > > > > > https://cloudstack.apache.org/api/apidocs-4.19/apis/removeSecondaryStorageSelector.html > > > we see the response tags but actually non of them are actually returned > > and > > > I get `{"success":true}`. > > > > > > -- > > > <https://www.multistax.com> > > > > > > -- > > > The information in this message is confidential, and only intended for > > the > > > addressee(s). If you are not the person to whom this message is > > addressed, > > > you are hereby notified that any disclosure, reproduction, distribution > > or > > > use of this message is strictly prohibited. If you received this in > > error, > > > please inform the sender and delete the message without copying or > > opening > > > it. > > > > > > > -- > > <https://www.multistax.com> > > > > -- > > The information in this message is confidential, and only intended for the > > addressee(s). If you are not the person to whom this message is addressed, > > you are hereby notified that any disclosure, reproduction, distribution or > > use of this message is strictly prohibited. If you received this in error, > > please inform the sender and delete the message without copying or opening > > it. > > > > -- > <https://www.multistax.com> > > -- > The information in this message is confidential, and only intended for the > addressee(s). If you are not the person to whom this message is addressed, > you are hereby notified that any disclosure, reproduction, distribution or > use of this message is strictly prohibited. If you received this in error, > please inform the sender and delete the message without copying or opening > it.
