Skip to content

Commit bb8f8b3

Browse files
committed
DOC: Update docs
1 parent 878e0c8 commit bb8f8b3

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

docs/source/asking_questions.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ can be:
2020
`django-twined <https://django-twined.readthedocs.io/en/latest/>`_ or custom logic in your own webserver.
2121

2222
Questions are always asked to a *revision* of a service. You can ask a service a question if you have its
23-
:ref:`SRUID <sruid_definition>`, project name, and the necessary permissions.
23+
:ref:`SRUID <sruid_definition>`, project ID, and the necessary permissions.
2424

2525

2626
Asking a question
@@ -32,7 +32,7 @@ Asking a question
3232
3333
child = Child(
3434
id="my-organisation/my-service:2.1.7",
35-
backend={"name": "GCPPubSubBackend", "project_name": "my-project"},
35+
backend={"name": "GCPPubSubBackend", "project_id": "my-project"},
3636
)
3737
3838
answer, question_uuid = child.ask(
@@ -241,15 +241,15 @@ if these values are in your service configuration file:
241241
"id": "template-child-services/wind-speed-service:2.1.1",
242242
"backend": {
243243
"name": "GCPPubSubBackend",
244-
"project_name": "my-project"
244+
"project_id": "my-project"
245245
}
246246
},
247247
{
248248
"key": "elevation",
249249
"id": "template-child-services/elevation-service:3.1.9",
250250
"backend": {
251251
"name": "GCPPubSubBackend",
252-
"project_name": "my-project"
252+
"project_id": "my-project"
253253
}
254254
}
255255
]
@@ -302,15 +302,15 @@ For example, if the child requires these children in its service configuration:
302302
"id": "template-child-services/wind-speed-service:2.1.1",
303303
"backend": {
304304
"name": "GCPPubSubBackend",
305-
"project_name": "octue-sdk-python"
305+
"project_id": "octue-sdk-python"
306306
},
307307
},
308308
{
309309
"key": "elevation",
310310
"id": "template-child-services/elevation-service:3.1.9",
311311
"backend": {
312312
"name": "GCPPubSubBackend",
313-
"project_name": "octue-sdk-python"
313+
"project_id": "octue-sdk-python"
314314
},
315315
}
316316
]
@@ -327,15 +327,15 @@ then you can override them like this:
327327
"id": "my/own-service:1.0.0",
328328
"backend": {
329329
"name": "GCPPubSubBackend",
330-
"project_name": "octue-sdk-python"
330+
"project_id": "octue-sdk-python"
331331
},
332332
},
333333
{
334334
"key": "elevation",
335335
"id": "organisation/another-service:0.1.0",
336336
"backend": {
337337
"name": "GCPPubSubBackend",
338-
"project_name": "octue-sdk-python"
338+
"project_id": "octue-sdk-python"
339339
},
340340
},
341341
],
@@ -380,7 +380,7 @@ You can specify service registries in two ways:
380380
381381
child = Child(
382382
id="my-organisation/my-service:1.1.0",
383-
backend={"name": "GCPPubSubBackend", "project_name": "my-project"},
383+
backend={"name": "GCPPubSubBackend", "project_id": "my-project"},
384384
service_registries=[
385385
{"name": "my-registry", "endpoint": "blah.com/services"},
386386
]

docs/source/manifest.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Get a Twined service to analyse data for you as part of a larger analysis.
4646
4747
child = Child(
4848
id="octue/wind-speed:2.1.0",
49-
backend={"name": "GCPPubSubBackend", "project_name": "my-project"},
49+
backend={"name": "GCPPubSubBackend", "project_id": "my-project"},
5050
)
5151
5252
answer, question_uuid = child.ask(input_manifest=manifest)

docs/source/testing_services.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ To emulate your children in tests, patch the :mod:`Child <octue.resources.child.
152152
"id": "octue/my-child-service:2.1.0",
153153
"backend": {
154154
"name": "GCPPubSubBackend",
155-
"project_name": "my-project"
155+
"project_id": "my-project"
156156
}
157157
},
158158
]
@@ -232,7 +232,7 @@ child.
232232
233233
child = Child(
234234
id="octue/my-child:2.1.0",
235-
backend={"name": "GCPPubSubBackend", "project_name": "my-project"},
235+
backend={"name": "GCPPubSubBackend", "project_id": "my-project"},
236236
)
237237
238238
result, question_uuid = child.ask(input_values=[1, 2, 3, 4])

docs/source/troubleshooting_services.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,15 @@ your service to fail.
8383
"id": "octue/my-child-service:2.1.0",
8484
"backend": {
8585
"name": "GCPPubSubBackend",
86-
"project_name": "my-project",
86+
"project_id": "my-project",
8787
}
8888
},
8989
{
9090
"key": "another_child",
9191
"id": "octue/another-child-service:2.1.0",
9292
"backend": {
9393
"name": "GCPPubSubBackend",
94-
"project_name": "my-project",
94+
"project_id": "my-project",
9595
}
9696
}
9797
]
@@ -119,7 +119,7 @@ For example:
119119
120120
child = Child(
121121
id="my-organisation/my-service:2.1.0",
122-
backend={"name": "GCPPubSubBackend", "project_name": "my-project"},
122+
backend={"name": "GCPPubSubBackend", "project_id": "my-project"},
123123
)
124124
125125
answer, question_uuid = child.ask(

0 commit comments

Comments
 (0)