-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: allow Tax Free Assets to be a draft before publishing #50
Conversation
WalkthroughThe changes update two JSON schema files. In the tax-free-asset schema, the "draftAndPublish" option is enabled by switching its value from false to true. In the documentation schema, the generation date has been refreshed with a new timestamp and a new "publishedAt" property (a string in date-time format) has been added. These updates adjust the configuration for draft publishing and improve documentation metadata. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant API
participant DB
User->>API: Create tax-free-asset (draft)
API->>DB: Save content as draft
DB-->>API: Confirm draft saved
API-->>User: Return draft content
User->>API: Request publish of content
API->>DB: Update content status to published
DB-->>API: Confirm content published
API-->>User: Return published content
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/extensions/documentation/documentation/1.0.0/full_documentation.json (1)
27911-27914
: Addition of publishedAt PropertyThe new "publishedAt" property has been correctly added with the expected "string" type and "date-time" format, aligning with the intent to track publication dates and enable draft functionality. To improve clarity and maintainability, consider adding a brief description for this field in the schema.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/api/tax-free-asset/content-types/tax-free-asset/schema.json
(1 hunks)src/extensions/documentation/documentation/1.0.0/full_documentation.json
(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: docker
🔇 Additional comments (2)
src/extensions/documentation/documentation/1.0.0/full_documentation.json (1)
14-18
: Update to Generation DateThe updated "x-generation-date" field now reflects the new timestamp "2025-02-07T14:35:19.279Z", which is in line with the requirement for refreshing the documentation generation date. The ISO 8601 format appears correct and consistent.
src/api/tax-free-asset/content-types/tax-free-asset/schema.json (1)
10-12
: Enable Draft and Publish Option in SchemaThe update at line 11 correctly changes the "draftAndPublish" option from false to true, aligning with the PR objective of requiring manual inspection before publication. Ensure that any parts of your workflow or admin UI that manage Tax Free Assets are updated to handle the draft state appropriately.
Actually, let's do without draft |
Summary
Using the built-in
draft
state forTax Free Assets
model.This way a manual inspection is required before enabling any entry.
Summary by CodeRabbit