diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 5bd18cc383..bbcd523614 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -40,6 +40,7 @@ jobs: name: # src/ directory - archives + - article-api - assets - audit-logs - automated-pipelines @@ -66,7 +67,6 @@ jobs: - observability # - open-source - pageinfo - - pagelist # - pages - products - redirects diff --git a/src/article-api/README.md b/src/article-api/README.md new file mode 100644 index 0000000000..413273733e --- /dev/null +++ b/src/article-api/README.md @@ -0,0 +1,10 @@ +# Article API + +This subject folder contains the code for the Article API endpoints: +- `/api/pagelist` +- `/api/article/body` +- `/api/article/meta` + +## What it does + +Article API endpoints allow consumers to query GitHub Docs for listings of current articles, and for specific article information. diff --git a/src/pagelist/middleware.ts b/src/article-api/middleware/pagelist.ts similarity index 100% rename from src/pagelist/middleware.ts rename to src/article-api/middleware/pagelist.ts diff --git a/src/pagelist/tests/pagelist.ts b/src/article-api/tests/pagelist.ts similarity index 100% rename from src/pagelist/tests/pagelist.ts rename to src/article-api/tests/pagelist.ts diff --git a/src/frame/middleware/api.ts b/src/frame/middleware/api.ts index 63ceb9fe12..24c99eef7e 100644 --- a/src/frame/middleware/api.ts +++ b/src/frame/middleware/api.ts @@ -6,7 +6,7 @@ import anchorRedirect from '@/rest/api/anchor-redirect.js' import aiSearch from '@/search/middleware/ai-search' import search from '@/search/middleware/search-routes.js' import pageInfo from '@/pageinfo/middleware' -import pageList from '@/pagelist/middleware' +import pageList from '@/article-api/middleware/pagelist' import webhooks from '@/webhooks/middleware/webhooks.js' import { ExtendedRequest } from '@/types' import { noCacheControl } from './cache-control' diff --git a/src/pagelist/README.md b/src/pagelist/README.md deleted file mode 100644 index 7dc3fa9cd6..0000000000 --- a/src/pagelist/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Pagelist - -This subject folder contains the code for the `/api/pagelist` endpoint. - -## What it does - -The `/api/pagelist` endpoint provides a flat structure of all the pages on GitHub Docs.