DBS Server RESTful API documentation is wrong

[amaltaro]

The documentation itself is available/accessible:
https://cmsweb-testbed.cern.ch/dbs/int/global/DBSReader/

however, most of them simply report:

API description:	A wrapped function.

[amaltaro]

And the python dbsClient documentation is also gone:
https://cms-http-group.web.cern.ch/cms-http-group/apidoc/dbs3/current/

@yuyiguo can you please get it fixed? I'm working on the MicroService implementation - which does a lot of what Unified is doing - and it's very hard to figure out what's the most suitable DBS API to use.

[yuyiguo]

@amaltaro @h4d4

Hi Alan ,

Please refer https://cms-http-group.web.cern.ch/cms-http-group/apidoc/dbs3-client/current/dbs.apis.html#id1 for DBS API doc.

DBS generates document with every new release, but the doc under the http group doc site has not been updated with new DBS doc for long time. I understood that when Lina deploys a new production release, one of the steps is to copy the generated doc to the http group doc site for public view. I don't know why the doc has not been updated and what script used to update it. Lina, could you please comment?

T

[amaltaro]

Thanks, Yuyi. This link works for the dbsClient documentation.

Could you please contact the CMSWEB team and try to fix the documentation for the REST APIs too? It would be extremely useful to have them available again.

[yuyiguo]

OK, I will do it again. I had been contacted with them for N times regarding update DBS document link, but nothing had happened in past years. I will open a new tk and hope the new team will take document seriously.

[yuyiguo]

opened below TK and hope the http group could update the web site.
https://gitlab.cern.ch/cms-http-group/doc/issues/205

[amaltaro]

Yuyi, I have just updated the gitlab ticket for the CMSWEB team. However, now that I read that again, I wonder if the dbsClient and the RESTFUL documentation are made available (deployed) on the same way(?)

If the RESTFUL documentation is under your control, could you please investigate why it's broken here:
https://cmsweb.cern.ch/dbs/prod/global/DBSReader/

[yuyiguo]

@alan,

The document for both Client and RESTFUL APIs are deployed the same way. I don't think https://cmsweb.cern.ch/dbs/prod/global/DBSReader/ ever used as an API doc. The RESTFUL APIs can be found at https://cms-http-group.web.cern.ch/cms-http-group/apidoc/dbs3/3.2.11d/dbs.web.html. However, it is a very old version 3.2.11d, but the current version is 3.12.3.

[amaltaro]

I have always used
https://cmsweb.cern.ch/dbs/prod/global/DBSReader/
for the REST APIs documentation. I believe other projects did the same (Unified, McM, etc).

DBS is a critical service for many groups in CMS! And as you know, at this very moment we are having problems with it and we will likely have to make modifications in WMCore. So, could you please follow this up with Muhammad Imran (CMSWEB operator) and make sure an up-to-date documentation is available?

[yuyiguo]

Alan,

DBS official document site is https://cms-http-group.web.cern.ch/cms-http-group/apidoc/dbs3/. This web site should be updated with everything DBS release. As you can see that I asked this update since Lina time and communicated with Muhammad, but nothing happened so far. This beyonds my power and allowed time. If you like, I would suggested that you ask the level2s to help coordinate this.