From 19fefbac649c2b07cc6bf38b1d72893cf550b2df Mon Sep 17 00:00:00 2001 From: Yaw Anokwa Date: Wed, 25 Oct 2023 12:54:40 -0700 Subject: [PATCH] Fix API docs links and internal links --- README.md | 2 +- docs/examples/README.md | 2 +- docs/http-methods.md | 2 +- pyodk/_endpoints/auth.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5e02914..ebe5629 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # pyODK [![pypi](https://img.shields.io/pypi/v/pyodk.svg)](https://pypi.python.org/pypi/pyodk) -An API client for the [ODK Central API](https://odkcentral.docs.apiary.io). Use it to interact with your data and automate common tasks from Python. +An API client for the [ODK Central API](https://docs.getodk.org/central-api). Use it to interact with your data and automate common tasks from Python. This library aims to make common data analysis and workflow automation tasks as simple as possible by providing clear method names, types, and examples. It also provides convenient access to the full API using [HTTP verb methods](https://getodk.github.io/pyodk/http-methods/). diff --git a/docs/examples/README.md b/docs/examples/README.md index 6d9f59b..1a972ea 100644 --- a/docs/examples/README.md +++ b/docs/examples/README.md @@ -10,7 +10,7 @@ A standalone Jupyter notebook intended to introduce `pyodk` and show how it can ## [Going beyond `pyodk`'s library methods](beyond-library-methods.ipynb) -A standalone Jupyter notebook that shows how the raw HTTP method access and the [API docs](https://odkcentral.docs.apiary.io/) can be used together to make use of the full ODK Central API. +A standalone Jupyter notebook that shows how the raw HTTP method access and the [API docs](https://docs.getodk.org/central-api) can be used together to make use of the full ODK Central API. ## [Working with repeats](working-with-repeats.ipynb) diff --git a/docs/http-methods.md b/docs/http-methods.md index d98557c..f6464d8 100644 --- a/docs/http-methods.md +++ b/docs/http-methods.md @@ -1,6 +1,6 @@ # HTTP verb methods -For interacting with parts of the ODK Central API ([docs](https://odkcentral.docs.apiary.io)) that have not been implemented in `pyodk`, use HTTP verb methods exposed on the `Client`: +For interacting with parts of the ODK Central API ([docs](https://docs.getodk.org/central-api)) that have not been implemented in `pyodk`, use HTTP verb methods exposed on the `Client`: ```python client.get("projects/8") diff --git a/pyodk/_endpoints/auth.py b/pyodk/_endpoints/auth.py index 784cfbf..be0b8a5 100644 --- a/pyodk/_endpoints/auth.py +++ b/pyodk/_endpoints/auth.py @@ -44,7 +44,7 @@ def get_new_token(self, username: str, password: str) -> str: """ Get a new token from Central by creating a new session. - https://odkcentral.docs.apiary.io/#reference/authentication/session-authentication/logging-in + https://docs.getodk.org/central-api-authentication/#logging-in :param username: The username of the Web User to auth with. :param password: The Web User's password.