chore: sunset Foo API

Author: adamhenson

packages/foo-api-docs/docs/api-cli.md

@@ -6,6 +6,9 @@ description: Documentation of Foo's API CLI for its page experience testing serv
 
 # API CLI
 
+> [!IMPORTANT]
+> Foo API is now deprecated and will sunset on 01/01/2026. It will be permanently offline soon after that date.
+
 `foo-api` CLI is a Node.js package to provide utilities using [Foo's REST API](/docs/api/endpoints). This package is [hosted on NPM](https://www.npmjs.com/package/@foo-software/foo-api-cli).
 
 ## Getting Started

packages/foo-api-docs/docs/api-client.md

@@ -6,6 +6,9 @@ description: Documentation of Foo's Node.js API CLI for its page experience test
 
 # Node.js API Client
 
+> [!IMPORTANT]
+> Foo API is now deprecated and will sunset on 01/01/2026. It will be permanently offline soon after that date.
+
 The API client is a Node.js package to interface with [Foo's REST API](/docs/api/endpoints) programmatically. This package is [hosted on NPM](https://www.npmjs.com/package/@foo-software/foo-api-client) and exports an API client class with methods for interacting with endpoints. The project is typed (for those working with TypeScript). Before proceeding you may want to first read the below sections.
 
 - [API Endpoints](/docs/api/endpoints)

packages/foo-api-docs/docs/api/api-response.md

@@ -6,6 +6,9 @@ description: Documentation of Foo's API response for its page experience testing
 
 # Response
 
+> [!IMPORTANT]
+> Foo API is now deprecated and will sunset on 01/01/2026. It will be permanently offline soon after that date.
+
 All responses will have either a `data` or `error` field. A request for a collection of data will populate `data` with an array, otherwise `data` will be a single JSON object. If an error occurs - th `error` field will be populated with a message. Below is an illustration of the API response in TypeScript.
 
 ```typescript

packages/foo-api-docs/docs/api/authentication.md

@@ -6,6 +6,9 @@ description: Documentation of Foo's API authentication for its page experience t
 
 # Authentication
 
+> [!IMPORTANT]
+> Foo API is now deprecated and will sunset on 01/01/2026. It will be permanently offline soon after that date.
+
 Foo's REST API implements a loose form of "token authentication" or "bearer authentication". At the time of this writing all endpoints require authentication and there is a single, "all or nothing" level of authorization (as in - no endpoints requre specific types of access... you either have access to all of them or you don't).
 
 ## Example

packages/foo-api-docs/docs/api/endpoints.md

@@ -6,6 +6,9 @@ description: Documentation of Foo's API endpoints for its page experience testin
 
 # Endpoints
 
+> [!IMPORTANT]
+> Foo API is now deprecated and will sunset on 01/01/2026. It will be permanently offline soon after that date.
+
 Foo exposes a public REST API for management of pages on to be audited by Lighthouse. Before proceeding you may want to first read the below sections.
 
 - [API Response](/docs/api/api-response)

packages/foo-api-docs/docs/api/parameters.md

@@ -6,6 +6,9 @@ description: Documentation of Foo's API parameters for its page experience testi
 
 # Parameters
 
+> [!IMPORTANT]
+> Foo API is now deprecated and will sunset on 01/01/2026. It will be permanently offline soon after that date.
+
 API methods that are "read-only" and return an array of data will typically support the following optional parameters. In the REST API these are query parameters. Below is a TypeScript representation useful for [Foo's Node.js API client](/docs/api-client).
 
 ```typescript

packages/foo-api-docs/docs/api/resources.md

@@ -6,6 +6,9 @@ description: Documentation of Foo's API resources for its page experience testin
 
 # Resources
 
+> [!IMPORTANT]
+> Foo API is now deprecated and will sunset on 01/01/2026. It will be permanently offline soon after that date.
+
 The sets of data we manage can be thought of as resources. Each resource is represented by a shape of data consistent across interfaces.
 
 ## Common Types

packages/foo-api-docs/docs/api/rest-methods.md

@@ -6,6 +6,9 @@ description: Documentation of Foo's API REST methods for its page experience tes
 
 # REST Methods
 
+> [!IMPORTANT]
+> Foo API is now deprecated and will sunset on 01/01/2026. It will be permanently offline soon after that date.
+
 Foo's REST API expects standard requests and payloads. Below are examples of different REST methods via [cURL](https://en.wikipedia.org/wiki/CURL#cURL).
 
 ## GET