From dc52737e30989571a90b78c24f6c20b8e56b9432 Mon Sep 17 00:00:00 2001 From: blewisCycle Date: Mon, 27 Jan 2025 16:03:14 -0800 Subject: [PATCH 1/2] changelog schemas --- .../schemas/changelog/ChangelogEntry.yml | 126 ++++++++++++++++++ .../schemas/changelog/ChangelogEntryState.yml | 14 ++ 2 files changed, 140 insertions(+) create mode 100644 components/schemas/changelog/ChangelogEntry.yml create mode 100644 components/schemas/changelog/ChangelogEntryState.yml diff --git a/components/schemas/changelog/ChangelogEntry.yml b/components/schemas/changelog/ChangelogEntry.yml new file mode 100644 index 00000000..c77a2254 --- /dev/null +++ b/components/schemas/changelog/ChangelogEntry.yml @@ -0,0 +1,126 @@ +title: ChangelogEntry +type: object +description: A changelog entry released by the Cycle team. +required: + - id + - date + - version + - title + - hidden + - state + - events + - creator + - changes +properties: + id: + "$ref": "../ID.yml" + title: + type: string + description: The title of the changelog entry. + version: + type: string + description: The version of the release described in the changelog entry. + date: + $ref: "../DateTime.yml" + hero: + description: An object describing the hero image for the changelog entry. + oneOf: + - type: object + required: + - intro + properties: + intro: + type: string + image_url: + type: + - string + - "null" + image_alt: + type: + - string + - "null" + - type: "null" + hidden: + type: boolean + state: + $ref: ./ChangelogEntryState.yml + events: + title: ChangelogEntryEvents + type: object + description: A collection of timestamps for each event in the changelog entry's lifetime. + required: + - created + - updated + - deleted + - published + - hidden + properties: + created: + description: The timestamp of when the changelog entry was created. + "$ref": "../DateTime.yml" + updated: + description: The timestamp of when the changelog entry was updated. + "$ref": "../DateTime.yml" + deleted: + description: The timestamp of when the changelog entry was deleted. + "$ref": "../DateTime.yml" + published: + description: The timestamp of when the changelog entry was published. + "$ref": "../DateTime.yml" + hidden: + description: The timestamp of when the changelog entry was hidden. + "$ref": "../DateTime.yml" + email_events: + type: array + items: + type: object + required: + - list + - type + - sent + properties: + list: + type: string + enum: + - changelog + type: + type: string + enum: + - internal + - external + - single + sent: + $ref: "../DateTime.yml" + + creator: + "$ref": "../creators/CreatorScope.yml" + changes: + type: array + items: + type: object + required: + - title + - description + - notes + - showcase + - type + - codebase + properties: + title: + type: string + description: + type: string + notes: + type: array + items: + type: string + showcase: + type: boolean + type: + type: string + codebase: + type: string + external_url: + type: + - string + - "null" diff --git a/components/schemas/changelog/ChangelogEntryState.yml b/components/schemas/changelog/ChangelogEntryState.yml new file mode 100644 index 00000000..233070e1 --- /dev/null +++ b/components/schemas/changelog/ChangelogEntryState.yml @@ -0,0 +1,14 @@ +title: ChangelogEntryState +allOf: + - required: + - current + properties: + current: + description: The current state of the changelog entry. + type: string + enum: + - new + - approved + - published + - deleted + - "$ref": "../State.yml" From 235636f8f6c5d2ea7b6df5ad623f7783531d34b3 Mon Sep 17 00:00:00 2001 From: blewisCycle Date: Wed, 29 Jan 2025 07:16:28 -0800 Subject: [PATCH 2/2] changelog specs --- .../schemas/changelog/ChangelogEntry.yml | 126 ------------------ .../schemas/changelog/ChangelogEntryState.yml | 14 -- 2 files changed, 140 deletions(-) delete mode 100644 components/schemas/changelog/ChangelogEntry.yml delete mode 100644 components/schemas/changelog/ChangelogEntryState.yml diff --git a/components/schemas/changelog/ChangelogEntry.yml b/components/schemas/changelog/ChangelogEntry.yml deleted file mode 100644 index c77a2254..00000000 --- a/components/schemas/changelog/ChangelogEntry.yml +++ /dev/null @@ -1,126 +0,0 @@ -title: ChangelogEntry -type: object -description: A changelog entry released by the Cycle team. -required: - - id - - date - - version - - title - - hidden - - state - - events - - creator - - changes -properties: - id: - "$ref": "../ID.yml" - title: - type: string - description: The title of the changelog entry. - version: - type: string - description: The version of the release described in the changelog entry. - date: - $ref: "../DateTime.yml" - hero: - description: An object describing the hero image for the changelog entry. - oneOf: - - type: object - required: - - intro - properties: - intro: - type: string - image_url: - type: - - string - - "null" - image_alt: - type: - - string - - "null" - - type: "null" - hidden: - type: boolean - state: - $ref: ./ChangelogEntryState.yml - events: - title: ChangelogEntryEvents - type: object - description: A collection of timestamps for each event in the changelog entry's lifetime. - required: - - created - - updated - - deleted - - published - - hidden - properties: - created: - description: The timestamp of when the changelog entry was created. - "$ref": "../DateTime.yml" - updated: - description: The timestamp of when the changelog entry was updated. - "$ref": "../DateTime.yml" - deleted: - description: The timestamp of when the changelog entry was deleted. - "$ref": "../DateTime.yml" - published: - description: The timestamp of when the changelog entry was published. - "$ref": "../DateTime.yml" - hidden: - description: The timestamp of when the changelog entry was hidden. - "$ref": "../DateTime.yml" - email_events: - type: array - items: - type: object - required: - - list - - type - - sent - properties: - list: - type: string - enum: - - changelog - type: - type: string - enum: - - internal - - external - - single - sent: - $ref: "../DateTime.yml" - - creator: - "$ref": "../creators/CreatorScope.yml" - changes: - type: array - items: - type: object - required: - - title - - description - - notes - - showcase - - type - - codebase - properties: - title: - type: string - description: - type: string - notes: - type: array - items: - type: string - showcase: - type: boolean - type: - type: string - codebase: - type: string - external_url: - type: - - string - - "null" diff --git a/components/schemas/changelog/ChangelogEntryState.yml b/components/schemas/changelog/ChangelogEntryState.yml deleted file mode 100644 index 233070e1..00000000 --- a/components/schemas/changelog/ChangelogEntryState.yml +++ /dev/null @@ -1,14 +0,0 @@ -title: ChangelogEntryState -allOf: - - required: - - current - properties: - current: - description: The current state of the changelog entry. - type: string - enum: - - new - - approved - - published - - deleted - - "$ref": "../State.yml"