Update public documentation to move away from the query services

Description

In Synapse Python client version 1.9.0, we removed the public facing functions that uses the query services. We are going to replace the implementation of synapse list in version 1.9.1. We missed synapse get -q option. brought to my attention that there are public documentation on different projects in Synapse that instructs users to use synapse get -q. For example: https://www.synapse.org/#!Synapse:syn2942337/wiki/401927

At the very least, we should notify all project admins that has these instructions to update their instructions to use File View queries. I am creating this issue to brought into the discussion.

Environment

None

Activity

Show:
Kimyen Truong
October 26, 2018, 9:46 PM

After discussion with Meredith, there is no easy way for us to find all of these wikis.

Meredith Slota
October 26, 2018, 10:50 PM

I DID just use search while logged in as an admin and was able to find quite a few:

https://www.synapse.org/#!Synapse:syn2942337/wiki/401927 -
https://www.synapse.org/#!Synapse:syn7080714/wiki/470472 - or ?
https://www.synapse.org/#!Synapse:syn3241074/wiki/232981 -
https://www.synapse.org/#!Synapse:syn7248578/wiki/410081 -

There are more, but it turns out that searching the wiki for this worked: https://www.synapse.org/#!Search:%22synapse%20get%20-q%22

Xindi Guo
October 29, 2018, 10:19 PM

The command on https://www.synapse.org/#!Synapse:syn7248578/wiki/410081 is actually for a file view, so it does work.

Kimyen Truong
December 13, 2018, 2:05 AM

I think we have done what this ticket was created for: find the wikis and notified the owners. So I am closing the ticket. Please re-open if there is something else that needs to be done here.

Assignee

Meredith Slota

Reporter

Kimyen Truong

Labels

Validator

Kimyen Truong

Development Area

None

Release Version History

None

Fix versions

Priority

Major
Configure