diff --git a/CHANGELOG_API.md b/CHANGELOG_API.md index 3bc9e66b4bd..04d89e0e5d0 100644 --- a/CHANGELOG_API.md +++ b/CHANGELOG_API.md @@ -13,10 +13,10 @@ v1: - new computed fields such as `is_maintained`, - the replacement of fields that were using union types with two separate single-type fields: - `lts` -> `isLts` and `ltsFrom`, - - `support` -> `isActiveSupportOver` and `activeSupportUntil`, + - `support` -> `isEoas` and `eoasFrom`, - `eol` -> `isEol` and `eolFrom`, - `discontinued` -> `isDiscontinued` and `discontinuedFrom`, - - `extendedSupport` -> `isExtendedSupportOver` and `extendedSupportUntil`. + - `extendedSupport` -> `isEoes` and `eoesFrom`. - provide new endpoints (#2078, #2160, #2530) - is versioned using the `api/v1` prefix (#2066), making it easier to implement non-backward-compatible changes in the future, diff --git a/_plugins/generate-api-v1.rb b/_plugins/generate-api-v1.rb index f979c5b44cd..0bb388a9eee 100755 --- a/_plugins/generate-api-v1.rb +++ b/_plugins/generate-api-v1.rb @@ -214,10 +214,10 @@ def product_to_json(site, product) id: identifier.values.first } }, labels: { - "activeSupport": product.data['activeSupportColumn'] ? ApiV1.strip_html(product.data['activeSupportColumnLabel']) : nil, + "eoas": product.data['eoasColumn'] ? ApiV1.strip_html(product.data['eoasColumnLabel']) : nil, "discontinued": product.data['discontinuedColumn'] ? ApiV1.strip_html(product.data['discontinuedColumnLabel']) : nil, "eol": product.data['eolColumn'] ? ApiV1.strip_html(product.data['eolColumnLabel']) : nil, - "extendedSupport": product.data['extendedSupportColumn'] ? ApiV1.strip_html(product.data['extendedSupportColumnLabel']) : nil, + "eoes": product.data['eoesColumn'] ? ApiV1.strip_html(product.data['eoesColumnLabel']) : nil, }, links: { icon: product.data['iconUrl'], @@ -249,14 +249,14 @@ def cycle_to_json(cycle) date: cycle['releaseDate'], isLts: cycle['is_lts'], ltsFrom: cycle['lts_from'], - isActiveSupportOver: cycle['is_active_support_over'], - activeSupportUntil: cycle['active_support_until'], + isEoas: cycle['is_eoas'], + eoasFrom: cycle['eoas_from'], isEol: cycle['is_eol'], eolFrom: cycle['eol_from'], isDiscontinued: cycle['is_discontinued'], discontinuedFrom: cycle['discontinued_from'], - isExtendedSupportOver: cycle['is_extended_support_over'], - extendedSupportUntil: cycle['extended_support_until'], + isEoes: cycle['is_eoes'], + eoesFrom: cycle['eoes_from'], isMaintained: cycle['is_maintained'], latest: { name: cycle['latest'], diff --git a/api_v1/openapi.yml b/api_v1/openapi.yml index 4fae130bba3..31e23262005 100644 --- a/api_v1/openapi.yml +++ b/api_v1/openapi.yml @@ -284,16 +284,16 @@ components: nullable: true description: Start date of the LTS phase. example: "2022-04-21" - isActiveSupportOver: + isEoas: type: boolean nullable: true description: Whether the active support phase is over. example: false - activeSupportUntil: + eoasFrom: type: string format: date nullable: true - description: End date of the active support phase. + description: End of active support date for the product cycle. example: "2024-09-30" isEol: type: boolean @@ -317,16 +317,16 @@ components: nullable: true description: Discontinuation date (mainly used for hardware). example: "2027-04-01" - isExtendedSupportOver: + isEoes: type: boolean nullable: true description: Whether the extended support phase is over. example: true - extendedSupportUntil: + eoesFrom: type: string format: date nullable: false - description: End date of the extended support phase. + description: End of extended support date for the product cycle. example: "2032-04-09" isMaintained: type: boolean @@ -407,10 +407,10 @@ components: type: object description: Product labels. properties: - activeSupport: + eoas: type: string nullable: true - description: Label used to denote the active support phase. + description: Label used to denote the phase before the end of active support of the product. example: Hardware & Maintenance discontinued: type: string @@ -420,12 +420,12 @@ components: eol: type: string nullable: true - description: Label used to denote the phase before the EOL of the product. + description: Label used to denote the phase before the end of life of the product. example: Maintenance & Security Support - extendedSupport: + eoes: type: string nullable: true - description: Label used to denote the extended support phase. + description: Label used to denote the phase before the end of extended support of the product. example: Extended Security Maintenance links: type: object