Skip to content

Commit acc6498

Browse files
committed
Revert "Add Compute scope details to docs"
This mostly reverts commit 6976248. After discussion internally, this is best left documented only in the OpenAPI docs.
1 parent 6976248 commit acc6498

File tree

1 file changed

+0
-43
lines changed

1 file changed

+0
-43
lines changed

docs/reference/client.rst

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -7,47 +7,6 @@ the main interface to the web services, most users will want the higher-level
77

88
For usage examples and explanations, please see the :doc:`../sdk/client_user_guide`.
99

10-
Accessing the Compute web services API requires the Globus Auth scope string:
11-
12-
.. code-block:: text
13-
14-
https://auth.globus.org/scopes/facd7ccc-c5f4-42aa-916b-a0e270e2c2a9/all
15-
16-
If using the Compute |Client|, this scope is automatically handled. But for those
17-
doing manual interactions, the scope identifier is
18-
``58ce1893-b1fe-4753-a697-7138ceb95adb``:
19-
20-
.. code-block:: console
21-
:emphasize-lines: 22
22-
23-
$ globus api auth get /v2/api/scopes -Q 'scope_strings=https://auth.globus.org/scopes/facd7ccc-c5f4-42aa-916b-a0e270e2c2a9/all' | jq
24-
{
25-
"scopes": [
26-
{
27-
"dependent_scopes": [
28-
{
29-
"scope": "69a73d8f-cd45-4e37-bb3b-43678424aeb7",
30-
"optional": false,
31-
"requires_refresh_token": true
32-
},
33-
{
34-
"scope": "73320ffe-4cb4-4b25-a0a3-83d53d59ce4f",
35-
"optional": false,
36-
"requires_refresh_token": false
37-
}
38-
],
39-
"scope_string": "https://auth.globus.org/scopes/facd7ccc-c5f4-42aa-916b-a0e270e2c2a9/all",
40-
"client": "facd7ccc-c5f4-42aa-916b-a0e270e2c2a9",
41-
"advertised": true,
42-
"description": "Register compute endpoints and run functions",
43-
"required_domains": [],
44-
"id": "58ce1893-b1fe-4753-a697-7138ceb95adb",
45-
"allows_refresh_token": true,
46-
"name": "Manage Globus Compute"
47-
}
48-
]
49-
}
50-
5110
----
5211

5312
.. autoclass:: globus_compute_sdk.Client
@@ -66,8 +25,6 @@ doing manual interactions, the scope identifier is
6625
:members:
6726
:member-order: bysource
6827

69-
7028
.. |Client| replace:: :class:`Client <globus_compute_sdk.sdk.client.Client>`
71-
.. |Executor| replace:: :class:`Executor <globus_compute_sdk.sdk.executor.Executor>`
7229

7330
.. _Compute web services API: https://compute.api.globus.org/redoc

0 commit comments

Comments
 (0)