Use openverse.org domains for Openverse API in all documentation (#4323)

WordPress · May 14, 2024 · 7dd3550 · 7dd3550
1 parent 6c1ae8d
commit 7dd3550
Show file tree

Hide file tree

Showing 18 changed files with 27 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ You can keep in touch with the project via the following channels:
 ## Documentation
 
 To use the Openverse API, please refer to the
-[API consumer documentation](https://api.openverse.engineering/v1/).
+[API consumer documentation](https://api.openverse.org/v1/).
 
 ## Contributing
 

diff --git a/documentation/api/guides/deploy.md b/documentation/api/guides/deploy.md
@@ -16,9 +16,8 @@ For more information on how deployments work, please see the [general deployment
 
 1. Check for any Sentry errors in the maintainer's `#openverse-alerts` channel,
    or in the Sentry UI.
-1. Visit
-   [https://api.openverse.engineering/v1](https://api.openverse.engineering/v1)
-   and verify the SHA is the same as the value you deployed.
+1. Visit [https://api.openverse.org/v1](https://api.openverse.org/v1) and verify
+   the SHA is the same as the value you deployed.
 1. Review and Approve the automatically-generated changelog pull request in the
    repository.
 1. In the event of errors or problems, rollback the application by running the

diff --git a/documentation/api/guides/documentation.md b/documentation/api/guides/documentation.md
@@ -158,7 +158,7 @@ provides code examples in Bash.
 image_stats_bash = \
   """
   # Get a list of content providers and their image count
-  curl -H "Authorization: Bearer DLBYIcfnKfolaXKcmMC8RIDCavc2hW" http://api.openverse.engineering/v1/sources
+  curl -H "Authorization: Bearer DLBYIcfnKfolaXKcmMC8RIDCavc2hW" http://api.openverse.org/v1/sources
   """
 
 @swagger_auto_schema(operation_id='image_stats',

diff --git a/documentation/api/index.md b/documentation/api/index.md
@@ -2,7 +2,7 @@
 
 This section includes documentation about developing the Openverse Django API.
 Documentation about how to use the API currently lives on the API itself at
-<https://api.openverse.engineering/v1/>.
+<https://api.openverse.org/v1/>.
 
 ```{toctree}
 :titlesonly:

diff --git a/documentation/api/reference/authentication_and_throttling.md b/documentation/api/reference/authentication_and_throttling.md
@@ -7,7 +7,7 @@ OAuth flow and configuration must also be explained.
 This document deals primarily with the server's perspective of the OAuth flow
 and assumes you are familiar with the user's perspective. If you are not
 familiar with the user's perspective, please study the
-[Register and Authenticate](https://api.openverse.engineering/v1/#section/Register-and-Authenticate)
+[Register and Authenticate](https://api.openverse.org/v1/#section/Register-and-Authenticate)
 section of the API documentation.
 
 Furthermore, this section assumes at least a surface level understanding of the

diff --git a/documentation/api/reference/search_algorithm.md b/documentation/api/reference/search_algorithm.md
@@ -151,8 +151,8 @@ By default, items marked "mature" are excluded, but these can also be enabled.
 See the following API documentation links for descriptions and options for each
 field:
 
-- [Audio search](https://api.openverse.engineering/v1/#operation/audio_search)
-- [Image search](https://api.openverse.engineering/v1/#operation/image_search)
+- [Audio search](https://api.openverse.org/v1/#operation/audio_search)
+- [Image search](https://api.openverse.org/v1/#operation/image_search)
 
 For each of these fields, there is a limited and specific set of terms that
 appear for the relevant document fields for each of these query parameters.

diff --git a/documentation/changelogs/api/index.md b/documentation/changelogs/api/index.md
@@ -1,6 +1,6 @@
 # API changelogs
 
-Changelogs for <https://api.openverse.engineering/>.
+Changelogs for <https://api.openverse.org/>.
 
 ```{toctree}
 :glob:

diff --git a/documentation/frontend/reference/testing_guidelines.md b/documentation/frontend/reference/testing_guidelines.md
@@ -65,7 +65,7 @@ pnpm dev
 ```
 
 For the second, you'll need to follow
-[the instructions to set up an OAuth application](https://api.openverse.engineering/v1/#section/Register-and-Authenticate)
+[the instructions to set up an OAuth application](https://api.openverse.org/v1/#section/Register-and-Authenticate)
 and then fill in the `API_CLIENT_ID` and `API_CLIENT_SECRET` in the `.env` file
 copied from `.env.template`. Be sure to remove the leading `#` to uncomment
 these variables from the copied template.

diff --git a/documentation/general/deployment.md b/documentation/general/deployment.md
@@ -25,10 +25,10 @@ Deployment logs are currently held in a private repository but are linked here f
 
 ### API
 
-| Environment | Deployment Log                                                                                                      | URL                                         | Version Endpoint                                                |
-| ----------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | --------------------------------------------------------------- |
-| Staging     | [Deployment Log](https://github.com/WordPress/openverse-infrastructure/actions/workflows/deploy-staging-api.yml)    | <https://api-staging.openverse.engineering> | [`/version`](https://api-staging.openverse.engineering/version) |
-| Production  | [Deployment Log](https://github.com/WordPress/openverse-infrastructure/actions/workflows/deploy-production-api.yml) | <https://api.openverse.engineering>         | [`/version`](https://api.openverse.engineering/version)         |
+| Environment | Deployment Log                                                                                                      | URL                                 | Version Endpoint                                        |
+| ----------- | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------------------------- |
+| Staging     | [Deployment Log](https://github.com/WordPress/openverse-infrastructure/actions/workflows/deploy-staging-api.yml)    | <https://api-staging.openverse.org> | [`/version`](https://api-staging.openverse.org/version) |
+| Production  | [Deployment Log](https://github.com/WordPress/openverse-infrastructure/actions/workflows/deploy-production-api.yml) | <https://api.openverse.org>         | [`/version`](https://api.openverse.org/version)         |
 
 ## Overview
 

diff --git a/documentation/index.md b/documentation/index.md
@@ -12,7 +12,7 @@ Openverse stack locally on your computer, refer to the
 ```{note}
 This documentation is for developers who are building Openverse. If you want to
 use the Openverse API, you should instead refer to the
-[API consumer documentation](https://api.openverse.engineering/).
+[API consumer documentation](https://api.openverse.org/).
 ```
 
 # Related documentation

diff --git a/documentation/meta/ci_cd/artifacts.md b/documentation/meta/ci_cd/artifacts.md
@@ -53,10 +53,10 @@ The following artifacts are related to documentation.
 - `openapi.json`
 
   This is the OpenAPI schema of the Openverse API. This JSON file is consumed by
-  Redoc to generate the
-  [interactive API docs](https://api.openverse.engineering/v1/). This is
-  generated by the [`django-checks`](/meta/ci_cd/jobs/api.md#django-checks) job,
-  specifically the `test_doc` named element in the matrix.
+  Redoc to generate the [interactive API docs](https://api.openverse.org/v1/).
+  This is generated by the
+  [`django-checks`](/meta/ci_cd/jobs/api.md#django-checks) job, specifically the
+  `test_doc` named element in the matrix.
 
 - `documentation`
 

diff --git a/documentation/meta/ci_cd/index.md b/documentation/meta/ci_cd/index.md
@@ -40,7 +40,7 @@ of these, "documentation" is also applicable to PRs.
 
 - **API staging:** When a new commit is pushed to `main` which affects the API
   service and the tests for the API pass, a new
-  [staging deployment of the API](https://api-staging.openverse.engineering/) is
+  [staging deployment of the API](https://api-staging.openverse.org/) is
   triggered. The deployment uses the image published above.
 
   See job [`deploy-api`](/meta/ci_cd/jobs/deployment.md#deploy-api).

diff --git a/documentation/meta/ci_cd/jobs/documentation.md b/documentation/meta/ci_cd/jobs/documentation.md
@@ -31,7 +31,7 @@ the <https://docs.openverse.org/> site itself.
 
 ```{caution}
 This job only publishes developer documentation. The API documentation hosted at
-<https://api.openverse.engineering/v1/> is provided by the API service itself.
+<https://api.openverse.org/v1/> is provided by the API service itself.
 ```
 
 This job is skipped if neither the documentation nor the frontend codebase has

diff --git a/...ages/collection=creator&unstable__collection=creator&creator=strogoscope_keep-alive.json5 b/...ages/collection=creator&unstable__collection=creator&creator=strogoscope_keep-alive.json5
@@ -1,7 +1,7 @@
 {
     meta: {
         createdAt: '2024-04-29T13:43:29.302Z',
-        host: 'https://api.openverse.engineering',
+        host: 'https://api.openverse.org',
         resHumanReadable: true,
         resUncompressed: true,
     },

diff --git a/...earch/images/collection=source&unstable__collection=source&source=flickr_keep-alive.json5 b/...earch/images/collection=source&unstable__collection=source&source=flickr_keep-alive.json5
@@ -1,7 +1,7 @@
 {
     meta: {
         createdAt: '2024-04-29T13:43:26.456Z',
-        host: 'https://api.openverse.engineering',
+        host: 'https://api.openverse.org',
         resHumanReadable: true,
         resUncompressed: true,
     },

diff --git a/...images/collection=tag&unstable__collection=tag&tag=cat&unstable__tag=cat_keep-alive.json5 b/...images/collection=tag&unstable__collection=tag&tag=cat&unstable__tag=cat_keep-alive.json5
@@ -1,7 +1,7 @@
 {
     meta: {
         createdAt: '2024-04-29T13:43:21.008Z',
-        host: 'https://api.openverse.engineering',
+        host: 'https://api.openverse.org',
         resHumanReadable: true,
         resUncompressed: true,
     },

diff --git a/utilities/load_testing/README.md b/utilities/load_testing/README.md
@@ -37,5 +37,5 @@ All load tests are accessible through `just` scripts in this directory's
 
 To run API load tests against a local API instance, use `just api`. You can
 optionally specify a host (the default is to point to local). For example
-`just api https://api-staging.openverse.engineering` will run the load tests
-against the staging API.
+`just api https://api-staging.openverse.org` will run the load tests against the
+staging API.
diff --git a/utilities/load_testing/k6/utils.js b/utilities/load_testing/k6/utils.js
@@ -2,8 +2,7 @@ import { check } from "k6"
 import http from "k6/http"
 import { randomItem } from "https://jslib.k6.io/k6-utils/1.2.0/index.js"
 
-export const API_URL =
-  __ENV.API_URL || "https://api-staging.openverse.engineering/v1/"
+export const API_URL = __ENV.API_URL || "https://api-staging.openverse.org/v1/"
 export const SLEEP_DURATION = 0.1
 // Use the random words list available locally, but filter any words that end with apostrophe-s
 const WORDS = open("/usr/share/dict/words")