[Jobs] [Doc] Add note about trailing slash for REST API (ray-project#…

…41561) It's a common mistake to forget the trailing slash in the URL for the REST API request, and the resulting error is not clear. This PR adds a brief reminder in the docs about the slash. Signed-off-by: Archit Kulkarni <[email protected]>
architkulkarni · Dec 5, 2023 · b648853 · b648853
1 parent f0ac970
commit b648853
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/doc/source/cluster/running-applications/job-submission/rest.rst b/doc/source/cluster/running-applications/job-submission/rest.rst
@@ -16,7 +16,7 @@ Continue on for examples, or jump to the :ref:`OpenAPI specification <ray-job-re
  import time
 
  resp = requests.post(
- "http:https://127.0.0.1:8265/api/jobs/",
+ "http:https://127.0.0.1:8265/api/jobs/", # Don't forget the trailing slash!
  json={
  "entrypoint": "echo hello",
  "runtime_env": {},
@@ -72,4 +72,4 @@ OpenAPI Documentation (Beta)
 
 We provide an OpenAPI specification for the Ray Job API. You can use this to generate client libraries for other languages.
 
-View the `Ray Jobs REST API OpenAPI documentation <api.html>`_.
+View the `Ray Jobs REST API OpenAPI documentation <api.html>`_.