Skip to content

Commit

Permalink
Update links from Apiary to docs site (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
yanokwa authored Mar 11, 2024
1 parent 19fefba commit 50c420d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/examples/2022-10-pyodk-webinar.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@
"\n",
"Our goal is to make many common workflow automation tasks directly available in `pyodk` as nice library methods. We haven't implemented most of those yet, though. You can still access the full Central API with the convenience of a configured `pyodk` client by using HTTP verb methods on your `Client` object.\n",
"\n",
"We briefly looked at how to use the [Central API docs](https://odkcentral.docs.apiary.io/) to make the right calls. You can see a worked example [here](https://github.com/getodk/pyodk/blob/master/examples/beyond-library-methods.ipynb).\n",
"We briefly looked at how to use the [Central API docs](https://docs.getodk.org/central-api/) to make the right calls. You can see a worked example [here](https://github.com/getodk/pyodk/blob/master/examples/beyond-library-methods.ipynb).\n",
"\n",
"There's also a longer sample script [here](https://github.com/getodk/pyodk/blob/master/examples/app_user_provisioner.py) that shows provisioning App Users from a file of names and generating custom QR codes for each of them."
]
Expand Down
6 changes: 3 additions & 3 deletions docs/examples/beyond-library-methods.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
"source": [
"## Raw HTTP requests\n",
"\n",
"`podk` also provides methods on `client` to perform raw requests using the [`Requests` library](https://requests.readthedocs.io/en/latest/). This is useful if you're already comfortable with the ODK Central [API documentation](https://odkcentral.docs.apiary.io/) or you need functionality that isn't provided natively by `pyodk`.\n",
"`podk` also provides methods on `client` to perform raw requests using the [`Requests` library](https://requests.readthedocs.io/en/latest/). This is useful if you're already comfortable with the ODK Central [API documentation](https://docs.getodk.org/central-api/) or you need functionality that isn't provided natively by `pyodk`.\n",
"\n",
"For example, you can also get information about a project this way:"
]
Expand Down Expand Up @@ -137,7 +137,7 @@
"source": [
"### Using the API docs\n",
"\n",
"To write your own raw HTTP request, start by finding the endpoint that you would like to make a request to in [the documentation](https://odkcentral.docs.apiary.io). For example, let's say you want to retrieve the XLSForm for a past form version. You can start by finding the API documentation [here](https://odkcentral.docs.apiary.io/#reference/forms/published-form-versions/retrieving-form-version-xls(x)). \n",
"To write your own raw HTTP request, start by finding the endpoint that you would like to make a request to in [the documentation](https://docs.getodk.org/central-api/). For example, let's say you want to retrieve the XLSForm for a past form version. You can start by finding the API documentation [here](https://docs.getodk.org/central-api-form-management/#retrieving-form-xls-x). \n",
"\n",
"![apiary-form-version-xlsx-2.png](attachment:apiary-form-version-xlsx-2.png)\n",
"\n",
Expand Down Expand Up @@ -209,7 +209,7 @@
"\n",
"If your request needs to specify some attributes, you can use request’s [json parameter](https://requests.readthedocs.io/en/latest/api/#requests.request). \n",
"\n",
"For example, let’s say you want to create a new App User with name “Lab Tech”. Start by reviewing the [API docs](https://odkcentral.docs.apiary.io/#reference/accounts-and-users/app-users/creating-a-new-app-user). The `POST` method is specified so you will use your client’s `.post()` method. As above, you can copy the path and fill in values for the parameters:\n",
"For example, let’s say you want to create a new App User with name “Lab Tech”. Start by reviewing the [API docs](https://docs.getodk.org/central-api-accounts-and-users/#creating-a-new-app-user). The `POST` method is specified so you will use your client’s `.post()` method. As above, you can copy the path and fill in values for the parameters:\n",
"\n",
"```\n",
"response = client.post('/projects/7/app-users')\n",
Expand Down

0 comments on commit 50c420d

Please sign in to comment.