Skip to content

Commit d714e2e

Browse files
feat: add metadata fields and remove description from movie API
Update movie creation and retrieval endpoints to include new metadata fields while removing the deprecated description field. This enhances the API's data model for better movie metadata handling. Key changes: - Add metadata and more_metadata required fields to CreateMovieRequest - Remove description field from Movie interface - Update documentation examples to include new metadata fields - Remove User-Agent header from client configuration - Update test cases to reflect new API structure 🌿 Generated with Fern
1 parent f051752 commit d714e2e

File tree

10 files changed

+30
-17
lines changed

10 files changed

+30
-17
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ import { FernAutopilotTestApiClient } from "";
2525
const client = new FernAutopilotTestApiClient({ environment: "YOUR_BASE_URL" });
2626
await client.imdb.createMovie({
2727
title: "title",
28-
rating: 1.1
28+
rating: 1.1,
29+
metadata: "metadata",
30+
more_metadata: "more_metadata"
2931
});
3032
```
3133

changelog.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## 3.0.0 - 2025-11-20
2+
* feat: add metadata fields and remove description from movie API
3+
* Update movie creation and retrieval endpoints to include new metadata fields while removing the deprecated description field. This enhances the API's data model for better movie metadata handling.
4+
* Key changes:
5+
* Add metadata and more_metadata required fields to CreateMovieRequest
6+
* Remove description field from Movie interface
7+
* Update documentation examples to include new metadata fields
8+
* Remove User-Agent header from client configuration
9+
* Update test cases to reflect new API structure
10+
* 🌿 Generated with Fern
11+

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "",
3-
"version": "2.0.0",
3+
"version": "3.0.0",
44
"private": false,
55
"repository": "github:fern-demo/autopilot-typescript-sdk",
66
"type": "commonjs",

reference.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ Add a movie to the database
2929
```typescript
3030
await client.imdb.createMovie({
3131
title: "title",
32-
rating: 1.1
32+
rating: 1.1,
33+
metadata: "metadata",
34+
more_metadata: "more_metadata"
3335
});
3436

3537
```

src/Client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ export class FernAutopilotTestApiClient {
2323
{
2424
"X-Fern-Language": "JavaScript",
2525
"X-Fern-SDK-Name": "",
26-
"X-Fern-SDK-Version": "2.0.0",
27-
"User-Agent": "/2.0.0",
26+
"X-Fern-SDK-Version": "3.0.0",
27+
"User-Agent": "/3.0.0",
2828
"X-Fern-Runtime": core.RUNTIME.type,
2929
"X-Fern-Runtime-Version": core.RUNTIME.version,
3030
},

src/api/resources/imdb/client/Client.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ export class Imdb {
2828
* @example
2929
* await client.imdb.createMovie({
3030
* title: "title",
31-
* rating: 1.1
31+
* rating: 1.1,
32+
* metadata: "metadata",
33+
* more_metadata: "more_metadata"
3234
* })
3335
*/
3436
public createMovie(

src/api/resources/imdb/types/CreateMovieRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@
33
export interface CreateMovieRequest {
44
title: string;
55
rating: number;
6+
metadata: string;
7+
more_metadata: string;
68
}

src/api/resources/imdb/types/Movie.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,5 @@ export interface Movie {
77
title: string;
88
/** The rating scale out of ten stars */
99
rating: number;
10-
description: string;
1110
metadata: string;
1211
}

src/version.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
export const SDK_VERSION = "2.0.0";
1+
export const SDK_VERSION = "3.0.0";

tests/wire/imdb.test.ts

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ describe("Imdb", () => {
88
test("createMovie", async () => {
99
const server = mockServerPool.createServer();
1010
const client = new FernAutopilotTestApiClient({ environment: server.baseUrl });
11-
const rawRequestBody = { title: "title", rating: 1.1 };
11+
const rawRequestBody = { title: "title", rating: 1.1, metadata: "metadata", more_metadata: "more_metadata" };
1212
const rawResponseBody = "string";
1313
server
1414
.mockEndpoint()
@@ -22,6 +22,8 @@ describe("Imdb", () => {
2222
const response = await client.imdb.createMovie({
2323
title: "title",
2424
rating: 1.1,
25+
metadata: "metadata",
26+
more_metadata: "more_metadata",
2527
});
2628
expect(response).toEqual("string");
2729
});
@@ -30,21 +32,14 @@ describe("Imdb", () => {
3032
const server = mockServerPool.createServer();
3133
const client = new FernAutopilotTestApiClient({ environment: server.baseUrl });
3234

33-
const rawResponseBody = {
34-
id: "tt0111161",
35-
title: "The Shawshank Redemption",
36-
rating: 9.3,
37-
description: "A story of hope and redemption.",
38-
metadata: "hey",
39-
};
35+
const rawResponseBody = { id: "tt0111161", title: "The Shawshank Redemption", rating: 9.3, metadata: "hey" };
4036
server.mockEndpoint().get("/movies/tt0111161").respondWith().statusCode(200).jsonBody(rawResponseBody).build();
4137

4238
const response = await client.imdb.getMovie("tt0111161");
4339
expect(response).toEqual({
4440
id: "tt0111161",
4541
title: "The Shawshank Redemption",
4642
rating: 9.3,
47-
description: "A story of hope and redemption.",
4843
metadata: "hey",
4944
});
5045
});

0 commit comments

Comments
 (0)