Skip to content

Commit

Permalink
Updating the readme with the new policy
Browse files Browse the repository at this point in the history
  • Loading branch information
@martin-stanchev
martin-stanchev committed Jan 25, 2023
1 parent 25cc7b1 commit 96b1bdd
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions README.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,21 +52,22 @@ Note that one policy might be used by many filters and filters might work with m
| editorialDeskFilter | Removes the `editorialDesk` field from the response unless the INTERNAL_ANALYTICS policy is present | /content, /enrichedcontent, /internalcontent |
| internalAnalyticsTagsFilter | Removes the `internalAnalyticsTags` field from the response unless the INTERNAL_ANALYTICS policy is present | /content, /enrichedcontent, /internalcontent |

| Policy | Description | Affected fields |
|------------------------------------|------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| INCLUDE_RICH_CONTENT | Allows rich content (images) related fields/content to be returned in response | mainImage, bodyXML, openingXML |
| INCLUDE_IDENTIFIERS | Allows including the `identifiers` field in the response | identifiers |
| INCLUDE_COMMENTS | Allows including the `comments` field in the response | comments |
| INCLUDE_PROVENANCE | Allows including information about the provenance of the content in the response | publishReference, masterSource |
| INCLUDE_LAST_MODIFIED_DATE | Allows including the `lastModified` field in the response | lastModified |
| INCLUDE_LITE | Allows including the `lite` field in the response | lite |
| FASTFT_CONTENT_ONLY | Includes events only for FastFT branded content into notification response | * |
| EXCLUDE_FASTFT_CONTENT | Excludes events for content with FastFT brand from notification response | * |
| INTERNAL_UNSTABLE | Allows including fields considered as "unstable" for internal usage | alternativeTitles, alternativeImages, alternativeStandfirsts, openingXML, accessLevel, contains, containedIn |
| INTERNAL_ANALYTICS | Allows fields for internal analytics usage | editorialDesk |
| EXPAND_RICH_CONTENT | If present along with INCLUDE_RICH_CONTENT it allows expanding rich content related fields in the response | mainImage, embeds, alternativeImages, promotionalImage, members, leadImages, image |
| RESTRICT_NON_SYNDICATABLE_CONTENT | If present non-syndicatable content will throw a 403 Forbidden HTTP error as a response | canBeSyndicated |
| APPEND_LIVE_BLOG_NOTIFICATIONS | Allows including live blog package & live blog post content in the notifications response | * |
| Policy | Description | Affected fields |
|-----------------------------------|------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| INCLUDE_RICH_CONTENT | Allows rich content (images) related fields/content to be returned in response | mainImage, bodyXML, openingXML |
| INCLUDE_IDENTIFIERS | Allows including the `identifiers` field in the response | identifiers |
| INCLUDE_COMMENTS | Allows including the `comments` field in the response | comments |
| INCLUDE_PROVENANCE | Allows including information about the provenance of the content in the response | publishReference, masterSource |
| INCLUDE_LAST_MODIFIED_DATE | Allows including the `lastModified` field in the response | lastModified |
| INCLUDE_LITE | Allows including the `lite` field in the response | lite |
| FASTFT_CONTENT_ONLY | Includes events only for FastFT branded content into notification response | * |
| EXCLUDE_FASTFT_CONTENT | Excludes events for content with FastFT brand from notification response | * |
| INTERNAL_UNSTABLE | Allows including fields considered as "unstable" for internal usage | alternativeTitles, alternativeImages, alternativeStandfirsts, openingXML, accessLevel, contains, containedIn |
| INTERNAL_ANALYTICS | Allows fields for internal analytics usage | editorialDesk |
| EXPAND_RICH_CONTENT | If present along with INCLUDE_RICH_CONTENT it allows expanding rich content related fields in the response | mainImage, embeds, alternativeImages, promotionalImage, members, leadImages, image |
| RESTRICT_NON_SYNDICATABLE_CONTENT | If present non-syndicatable content will throw a 403 Forbidden HTTP error as a response | canBeSyndicated |
| APPEND_LIVE_BLOG_NOTIFICATIONS | Allows including live blog package & live blog post content in the notifications response | * |
| ADVANCED_NOTIFICATIONS | Allows distinguishing between CREATE and UPDATE notifications in the notifications-rw response | * |

Header Handling
===============
Expand Down

0 comments on commit 96b1bdd

Please sign in to comment.