Skip to content

Commit

Permalink
fix(guidelines): remove consumer-facing rules that have been included…
Browse files Browse the repository at this point in the history
… in API Portal (#62)
  • Loading branch information
BirgitBader authored Feb 5, 2024
1 parent 50ee093 commit d3a84df
Show file tree
Hide file tree
Showing 7 changed files with 1 addition and 46 deletions.

This file was deleted.

6 changes: 0 additions & 6 deletions api-guidelines/global/compatibility/preview/README.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ id: R000069

During the deprecation phase, the API provider should add a `Deprecation` header (see [draft: RFC Deprecation HTTP Header](https://tools.ietf.org/html/draft-dalal-deprecation-header)) and - if also planned - a `Sunset` header (see [RFC 8594](https://tools.ietf.org/html/rfc8594#section-3)) to each response affected by a deprecated element (see [MUST reflect deprecation in API specifications](../../../../global/compatibility/deprecation/rules/must-reflect-deprecation-in-api-specifications.md)).

The `Deprecation` header can either be set to `true` when a feature is disabled, or it can carry a deprecation timestamp at which a replacement is made available and consumers are no longer allowed to use the feature (see [MUST NOT start using deprecated APIs](../../../../global/compatibility/deprecation/rules/must-not-start-using-deprecated-apis.md)).
The `Deprecation` header can either be set to `true` when a feature is disabled, or it can carry a deprecation timestamp at which a replacement is made available and consumers are no longer allowed to use the feature.
The optional `Sunset` timestamp indicates when consumers have to stop using a feature at the latest.
The sunset timestamp should always offer an appropriate time interval for switching to a replacement feature.

Expand Down

This file was deleted.

0 comments on commit d3a84df

Please sign in to comment.