Skip to content

Commit

Permalink
Rename sensitivity_warning to content_warning, closes #3
Browse files Browse the repository at this point in the history
  • Loading branch information
muan committed Nov 24, 2022
1 parent 75000eb commit e53da50
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Common fields between Image Stories and Video Stories:
- `date_expired` (optional, _String_): The date at which the story did or will expire. Clients are encouraged not to display stories after this date.
- `preview` (optional, [_Preview_](#preview)): Data that helps the client display a preview while this image is loading.
- `reactions` (optional, [_Reactions_](#reactions)): Data that describes how clients can react to this image.
- `senstivity_warning` (optional, _String_): If present, clients should display this warning before showing the story to the user.
- `content_warning` (optional, _String_): If present, clients should display this warning before showing the story to the user.
- `duration_in_seconds` (optional, _Number_): How long the story should be displayed for. Clients are free to adjust this number.
- `mime_type` (required, _String_ beginning with `image/${string}`): the MIME type of the image.
- `alt` (required, _String_): The alt text of the image.
Expand All @@ -106,7 +106,7 @@ Common fields between Image Stories and Video Stories:
- `date_expired` (optional, _String_): The date at which the story did or will expire. Clients are encouraged not to display stories after this date.
- `preview` (optional, _Preview_): Data that helps the client display a preview while this video is loading.
- `reactions` (optional, _Reactions_): Data that describes how clients can react to this video.
- `senstivity_warning` (optional, _String_): If present, clients should display this warning before showing the story to the user.
- `content_warning` (optional, _String_): If present, clients should display this warning before showing the story to the user.
- `duration_in_seconds` (optional, _Number_): How long the story should be displayed for. Clients are free to adjust this number.
- `mime_type` (required, _String_ beginning with `video/${string}`): the MIME type of the video.
- `alt` (required, _String_): The alt text of the video.
Expand Down
2 changes: 1 addition & 1 deletion dist/openstories.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ interface OpenStory {
date_expired?: string;
preview?: Preview;
reactions?: Reactions;
senstivity_warning?: string;
content_warning?: string;
duration_in_seconds?: number;
}

Expand Down

0 comments on commit e53da50

Please # to comment.