Remove directory rest api from index and sitemap. clarify contacts/programs/modules references (#3778)

Author: aelmanaa

astro.config.ts

@@ -93,6 +93,11 @@ export default defineConfig({
           return false
         }
 
+        // CCIP directory API v1 interactive page: noindex + omit from sitemap to avoid competing with CCIP Tools REST (v2)
+        if (cleanPath === "/api/ccip/v1/docs") {
+          return false
+        }
+
         return !redirectSources.has(cleanPath)
       },
       serialize(item) {

postman/ccip-chains-api.json

@@ -1,7 +1,7 @@
 {
   "info": {
-    "name": "CCIP API",
-    "description": "Collection for testing the Cross-Chain Interoperability Protocol (CCIP) API",
+    "name": "CCIP directory and configuration REST API (v1)",
+    "description": "**Deprecation:** CCIP Directory REST API (v1) is **planned for deprecation soon**; see https://docs.chain.link/ccip/tools/. For CCIP Tools REST API (v2), see https://docs.chain.link/ccip/tools/api/",
     "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
   },
   "item": [

public/api/ccip/v1/openapi.json

@@ -1,8 +1,8 @@
 {
   "openapi": "3.0.0",
   "info": {
-    "title": "CCIP Docs config API",
-    "description": "API for retrieving CCIP chain, token, and lane information.\n\nTo get started quickly, you can download our [Postman Collection](/api/ccip/v1/postman-collection.json) which includes all endpoints and example requests.",
+    "title": "CCIP directory and configuration REST API (v1)",
+    "description": "**Deprecation:** This CCIP Directory and configuration REST API (v1), including `/api/ccip/v1/*` on docs.chain.link, is **planned for deprecation soon**. Timelines and migration guidance will be published in the [CCIP Tools documentation](https://docs.chain.link/ccip/tools/). For new integrations, prefer the [CCIP Tools REST API (v2)](https://docs.chain.link/ccip/tools/api/) where it meets your needs.\n\nREST API for CCIP supported chains, tokens, lanes, and related configuration on docs.chain.link. This is distinct from the CCIP Tools REST API (v2), which covers messages, lane latency, intents, and related tooling (https://docs.chain.link/ccip/tools/api/). For on-chain Solidity, Move, SVM, and TON interfaces, see https://docs.chain.link/ccip/api-reference.\n\nTo get started quickly, you can download our [Postman Collection](/api/ccip/v1/postman-collection.json) which includes all endpoints and example requests.",
     "version": "1.6.0",
     "contact": {
       "name": "File issues",

public/api/ccip/v1/postman-collection.json

@@ -1,7 +1,7 @@
 {
   "info": {
-    "name": "CCIP API",
-    "description": "Collection for testing the Cross-Chain Interoperability Protocol (CCIP) API. Includes examples for chains, tokens, and lanes across EVM, Solana, and Aptos networks.",
+    "name": "CCIP directory and configuration REST API (v1)",
+    "description": "**Deprecation:** This CCIP Directory and configuration REST API (v1) is **planned for deprecation soon**; see https://docs.chain.link/ccip/tools/ for timelines and migration. Prefer CCIP Tools REST API (v2) for new work where applicable.",
     "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
   },
   "item": [

public/ccip/llms.txt

@@ -49,10 +49,17 @@ Use directory pages only when retrieving current chain, lane, token, or contract
 
 ## Tools and Reference
 
-- [EVM API Reference](https://docs.chain.link/ccip/api-reference.md)
-- [SVM API Reference](https://docs.chain.link/ccip/api-reference/svm.md)
-- [Aptos API Reference](https://docs.chain.link/ccip/api-reference/aptos.md)
-- [TON API Reference](https://docs.chain.link/ccip/api-reference/ton.md)
+On-chain contracts and interfaces:
+
+- [EVM contracts and interfaces reference](https://docs.chain.link/ccip/api-reference.md)
+- [Solana program interfaces reference](https://docs.chain.link/ccip/api-reference/svm.md)
+- [Aptos Move module interfaces reference](https://docs.chain.link/ccip/api-reference/aptos.md)
+- [TON contract interfaces reference](https://docs.chain.link/ccip/api-reference/ton.md)
+
+### CCIP HTTP REST APIs
+
+- **Directory and configuration (v1)** — supported chains, tokens, and lanes: OpenAPI UI at `https://docs.chain.link/api/ccip/v1/docs` and spec at `https://docs.chain.link/api/ccip/v1/openapi.json`. **Planned for deprecation soon**; follow [CCIP Tools](https://docs.chain.link/ccip/tools/) for timelines and migration. Prefer [CCIP Tools API (v2)](https://docs.chain.link/ccip/tools/api/) for new work where applicable.
+- **CCIP Tools (v2)** — messages, lane latency, intents: [CCIP Tools API](https://docs.chain.link/ccip/tools/api/).
 
 ## Live Data
 

public/llms.txt

@@ -88,10 +88,10 @@ Operational Considerations
 - [Service Limits](https://docs.chain.link/ccip/service-limits.md)
 
 Reference
-- [EVM API Reference](https://docs.chain.link/ccip/api-reference/evm.md)
-- [SVM API Reference](https://docs.chain.link/ccip/api-reference/svm.md)
-- [Aptos API Reference](https://docs.chain.link/ccip/api-reference/aptos.md)
-- [TON API Reference](https://docs.chain.link/ccip/api-reference/ton.md)
+- [EVM contracts and interfaces reference](https://docs.chain.link/ccip/api-reference/evm.md)
+- [Solana program interfaces reference](https://docs.chain.link/ccip/api-reference/svm.md)
+- [Aptos Move module interfaces reference](https://docs.chain.link/ccip/api-reference/aptos.md)
+- [TON contract interfaces reference](https://docs.chain.link/ccip/api-reference/ton.md)
 
 
 ## Data Feeds

src/content/ccip/api-reference/aptos/index.mdx

@@ -1,9 +1,9 @@
 ---
 section: ccip
 date: Last Modified
-title: "Move Module Interfaces Reference Documentation (Aptos)"
+title: "CCIP Move Module Interfaces Reference Documentation (Aptos)"
 metadata:
-  description: "Complete API reference documentation for Chainlink Cross-Chain Interoperability Protocol (CCIP) on the Aptos blockchain. Includes message structures, router functionality, events, and error handling."
+  description: "On-chain Move module interfaces for Chainlink CCIP on Aptos: messages, router, events, and errors."
 isIndex: true
 ---
 

src/content/ccip/api-reference/evm/index.mdx

@@ -1,9 +1,9 @@
 ---
 section: ccip
 date: Last Modified
-title: "Solidity Interfaces & Contracts Reference Documentation (EVM)"
+title: "CCIP Solidity Interfaces & Contracts Reference Documentation (EVM)"
 metadata:
-  description: "Complete API reference documentation for Chainlink Cross-Chain Interoperability Protocol (CCIP) on EVM-based blockchains. Includes smart contracts, libraries, and interfaces for cross-chain messaging and token transfers."
+  description: "On-chain Solidity interfaces and contracts for Chainlink CCIP on EVM chains: routers, pools, receivers, and related contracts."
 isIndex: true
 ---
 

src/content/ccip/api-reference/index.mdx

@@ -1,14 +1,22 @@
 ---
 section: ccip
 date: Last Modified
-title: "CCIP API Reference"
+title: "CCIP contracts and interfaces reference"
 metadata:
-  description: "Complete API reference documentation for Chainlink Cross-Chain Interoperability Protocol (CCIP). Access developer resources for EVM, Solana, and Aptos blockchains."
+  description: "On-chain reference for Chainlink CCIP: EVM, Solana, Aptos, and TON contracts and interfaces for cross-chain messaging and token transfers."
 isIndex: true
 ---
 
 Chainlink Cross-Chain Interoperability Protocol (CCIP) provides secure cross-chain messaging and token transfers between blockchain networks.
 
-- **[EVM-based Blockchains](/ccip/api-reference/evm)**: Complete API reference for CCIP on Ethereum Virtual Machine (EVM) compatible blockchains.
-- **[Solana](/ccip/api-reference/svm)**: Complete API reference for CCIP on Solana.
-- **[Aptos Blockchain](/ccip/api-reference/aptos)**: Complete API reference for CCIP on the Aptos blockchain.
+**This section is for on-chain integration** (contracts, interfaces, and program modules). CCIP also exposes HTTP APIs for different jobs:
+
+- **Directory and configuration REST API (v1)** — JSON for supported chains, tokens, and lanes served from `docs.chain.link`. **Planned for deprecation soon**; timelines and migration steps will be published with the [CCIP Tools documentation](https://docs.chain.link/ccip/tools/). Until then: interactive reference [/api/ccip/v1/docs](/api/ccip/v1/docs); machine-readable spec [/api/ccip/v1/openapi.json](/api/ccip/v1/openapi.json). Prefer the [CCIP Tools REST API (v2)](https://docs.chain.link/ccip/tools/api/) for new integrations where it meets your needs.
+- **CCIP Tools REST API (v2)** — messages, lane latency, intents, and related tooling. See the [CCIP Tools API documentation](https://docs.chain.link/ccip/tools/api/) and [CCIP Tools overview](https://docs.chain.link/ccip/tools/).
+
+Platform-specific **contracts and interfaces** on this site:
+
+- **[EVM-based blockchains](/ccip/api-reference/evm)**: Solidity interfaces and contracts for CCIP on Ethereum Virtual Machine (EVM) compatible chains.
+- **[Solana](/ccip/api-reference/svm)**: SVM program interfaces for CCIP on Solana.
+- **[Aptos](/ccip/api-reference/aptos)**: Move module interfaces for CCIP on Aptos.
+- **[TON](/ccip/api-reference/ton)**: TON contract interfaces for CCIP on TON.

src/content/ccip/api-reference/svm/index.mdx

@@ -1,9 +1,9 @@
 ---
 section: ccip
 date: Last Modified
-title: "SVM Program Interfaces Reference Documentation (SVM)"
+title: "CCIP Program Interfaces Reference Documentation (Solana)"
 metadata:
-  description: "Complete API reference documentation for Chainlink CCIP on Solana. Includes message structures, router functionality, events, and error handling."
+  description: "Onchain SVM program interfaces for Chainlink CCIP on Solana: message structures, router, pools, events, and errors."
 isIndex: true
 ---