fix: update sunset header (#641)

* fix: update sunset header docs
snyk · Aug 23, 2024 · e1c2b9d · e1c2b9d
1 parent d25bb97
commit e1c2b9d
Show file tree

Hide file tree

Showing 2 changed files with 215 additions and 217 deletions.
diff --git a/components/common.yaml b/components/common.yaml
@@ -318,15 +318,13 @@ headers:
 
   SunsetHeader:
     description: >
-      The date of when the underlying endpoint will be removed. This header is
-      only present if the endpoint has been deprecated.  Please refer to the
-      RFC for more information:
-
-      https://datatracker.ietf.org/doc/html/rfc8594
+      A header containing the date of when the underlying endpoint will be removed.
+      This header is only present if the endpoint has been deprecated.
+      For information purposes only. Returned as a date in the format: YYYY-MM-DD.
     schema:
       type: string
-      format: date-time
-      example: "2021-08-02T00:00:00Z"
+      format: date
+      example: "2021-08-02"
 
   RequestIdResponseHeader:
     description: >