Skip to content

refactor: migrate Studio Home caller to standardized v3 API (FC-0118) #3140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
taimoor-ahmed-1 wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

refactor: migrate Studio Home caller to standardized v3 API (FC-0118) #3140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/studio-home/data/api.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ describe('studio-home api calls', () => {
});

it('should get studio v1 libraries data', async () => {
const apiLink = `${getApiBaseUrl()}/api/contentstore/v1/home/libraries`;
const apiLink = `${getApiBaseUrl()}/api/contentstore/v3/home/libraries/`;
axiosMock.onGet(apiLink).reply(200, generateGetStudioHomeLibrariesApiResponse());
const result = await getStudioHomeLibraries();
const expected = generateGetStudioHomeLibrariesApiResponse();
Expand Down
10 changes: 8 additions & 2 deletions src/studio-home/data/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@ import { camelCaseObject, snakeCaseObject, getConfig } from '@edx/frontend-platf
import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth';

export const getApiBaseUrl = () => getConfig().STUDIO_BASE_URL;
export const getStudioHomeApiUrl = () => new URL('api/contentstore/v1/home', getApiBaseUrl()).href;
// FC-0118 (ADR 0028/0037): standardized v3 Studio Home endpoint. The trailing
// slash is required by the DRF DefaultRouter that serves the v3 `HomeViewSet`
// (the v1 route was a plain APIView). The aggregated home context lives at the
// `list` action `…/v3/home/`, and the library list at `…/v3/home/libraries/`.
export const getStudioHomeApiUrl = () => new URL('api/contentstore/v3/home/', getApiBaseUrl()).href;
export const getRequestCourseCreatorUrl = () => new URL('request_course_creator', getApiBaseUrl()).href;
export const getCourseNotificationUrl = (url) => new URL(url, getApiBaseUrl()).href;

Expand Down Expand Up @@ -55,7 +59,9 @@ export interface LibrariesV1ListData {
}

export async function getStudioHomeLibraries(): Promise<LibrariesV1ListData> {
const { data } = await getAuthenticatedHttpClient().get(`${getStudioHomeApiUrl()}/libraries`);
// `getStudioHomeApiUrl()` already ends in a slash (`…/v3/home/`); the v3
// library list is the `libraries` action at `…/v3/home/libraries/`.
const { data } = await getAuthenticatedHttpClient().get(`${getStudioHomeApiUrl()}libraries/`);
return camelCaseObject(data);
}

Expand Down