Document created field for supervisor jobs

[mdegat01]

Proposed change

Document created field added in home-assistant/supervisor#5545

Type of change

• Document existing features within Home Assistant
• Document new or changing features which there is an existing pull request elsewhere
• Spelling or grammatical corrections, or rewording for improved clarity
• Changes to the backend of this documentation
• Removed stale or deprecated documentation

Additional information

• This PR fixes or closes issue: fixes #
• Link to relevant existing code or pull request: Sort jobs by creation in API supervisor#5545

Summary by CodeRabbit

• Documentation
  • Updated supervisor API documentation to include a new created field in the Job model, providing a timestamp for job creation in ISO format.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a new created field to the "Job" model in the supervisor API documentation. This field is a string representing the date and time of job creation in ISO format. The change enhances the existing Job model by adding a timestamp that indicates when a job was initially created, providing more comprehensive metadata about job entries.

Changes

File	Change Summary
docs/api/supervisor/models.md	Added created field to Job model as a string representing job creation timestamp in ISO format

The changes are minimal and focused on documentation, specifically expanding the metadata description for the Job model by introducing a creation timestamp field.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b2b3f5 and ebf8715.

📒 Files selected for processing (1)

• docs/api/supervisor/models.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Redirect rules - developers-home-assistant
• GitHub Check: Header rules - developers-home-assistant
• GitHub Check: Pages changed - developers-home-assistant

🔇 Additional comments (1)

docs/api/supervisor/models.md (1)

301-301: LGTM! Documentation matches implementation.

The documentation for the created field is clear, consistent with other timestamp fields in the document, and follows the established format.

Let's verify that this matches the implementation from PR #5545:

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.