chore: add systemlabel serviceownerlabel docs #2533
Conversation
|
Note
|
| Cohort / File(s) | Summary |
|---|---|
Documentation Pages content/dialogporten/reference/entities/serviceownerlabel/_index.en.md, content/dialogporten/reference/entities/systemlabel/_index.en.md |
New Service Owner Labels documentation page with search behavior details, constraints, and embedded Swagger UI components for API operations. System Labels documentation replaces placeholder with descriptive table, mutual exclusivity notes, and deprecation guidance. |
Estimated code review effort
🎯 3 (Moderate) | ⏱️ ~20 minutes
- Verify accuracy of Service Owner Labels constraints and search behavior descriptions (3–255 character length, up to 20 labels per dialog)
- Confirm System Labels table entries match API specifications and that deprecation guidance is current
- Validate Swagger UI component syntax and endpoint references
- Confirm content consistency across planned language variants (nb-NO, nn-NO) if applicable
Poem
📋 New labels bloom in the reference guide,
Service owners and system tags side by side,
Swagger components dance in elegant rows,
Deprecated paths fade as new wisdom flows. ✨
Pre-merge checks and finishing touches
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | ✅ Passed | The title accurately describes the main change: adding documentation for system labels and service owner labels. |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
✨ Finishing touches
🧪 Generate unit tests (beta)
- Create PR with unit tests
- Post copyable unit tests in a comment
- Commit unit tests in branch
chore/add-systemlabel-serviceownerlabel-docs
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/dialogporten/reference/entities/serviceownerlabel/_index.en.md(1 hunks)content/dialogporten/reference/entities/systemlabel/_index.en.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
content/**/*
⚙️ CodeRabbit configuration file
Check for links, markdown formatting, headings, grammar, and spelling in multiple languages (en-US, nb-NO, nn-NO).
Files:
content/dialogporten/reference/entities/serviceownerlabel/_index.en.mdcontent/dialogporten/reference/entities/systemlabel/_index.en.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: lvbachmann
Repo: Altinn/altinn-studio-docs PR: 2477
File: content/authorization/migration/servicemigrationplan/_index.nb.md:4-4
Timestamp: 2025-10-27T07:48:11.643Z
Learning: In content/authorization/migration/servicemigrationplan/_index.nb.md (Norwegian Bokmål), the use of "Altinn II" in the description and "Altinn 2" in the document body is intentional and reflects actual naming conventions. This terminology difference should not be flagged as an inconsistency.
🪛 LanguageTool
content/dialogporten/reference/entities/systemlabel/_index.en.md
[style] ~18-~18: To form a complete sentence, be sure to include a subject.
Context: ...ened** | Set dialog as unopened/unread. Can be set and removed by service owner and...
(MISSING_IT_THERE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Build and Check links
- GitHub Check: Analyze (go)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (4)
content/dialogporten/reference/entities/systemlabel/_index.en.md (1)
1-30: Verify Norwegian language versions are included in the PR.Per the coding guidelines, documentation should be checked for en-US, nb-NO, and nn-NO. Only the English version is present in this review. Ensure that corresponding Norwegian Bokmål (_index.nb.md) and Norwegian Nynorsk (_index.nn.md) versions are included in the PR or addressed separately.
content/dialogporten/reference/entities/serviceownerlabel/_index.en.md (3)
11-11: Verify the internal documentation link is valid.The relref link to
dialog.md#searchshould be verified to ensure:
- The
dialog.mdfile exists in the expected location- The
#searchanchor exists in that file for the dialog search behavior reference
20-24: Verify Swagger operation paths exist in the API specification.The three endpoints listed (POST, GET, DELETE on
/api/v1/serviceowner/dialogs/{dialogId}/context/labels) should be confirmed to:
- Exist in the current Dialogporten API specification
- Match the operation IDs and paths exactly
- Be documented in the Swagger/OpenAPI source
1-27: Verify Norwegian language versions are included in the PR.Per the coding guidelines, documentation should be checked for en-US, nb-NO, and nn-NO. Only the English version is present in this review. Ensure that corresponding Norwegian Bokmål (_index.nb.md) and Norwegian Nynorsk (_index.nn.md) versions are included in the PR or addressed separately.
| | **Bin** | Mutually exclusive with Default/Archive | | ||
| | **Archive** | Mutually exclusive with Default/Bin | | ||
| | **Sent** | Automatically added by Dialogporten when a transmission of type <br/>`Submission` or `Correction` is added to the dialog.<br/>Cannot be added or removed by service owners or end users | | ||
| | **MarkedAsUnopened** | Set dialog as unopened/unread. Can be set and removed by service owner and end users | |
There was a problem hiding this comment.
Fix grammar in MarkedAsUnopened label description.
The text "Set dialog as unopened/unread. Can be set and removed by service owner and end users" is missing a subject in the second sentence. Additionally, the phrasing could be clearer about who performs the action.
Apply this diff to improve clarity and grammar:
-| **MarkedAsUnopened** | Set dialog as unopened/unread. Can be set and removed by service owner and end users |
+| **MarkedAsUnopened** | Marks a dialog as unopened/unread. Can be set and removed by service owners and end users |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | **MarkedAsUnopened** | Set dialog as unopened/unread. Can be set and removed by service owner and end users | | |
| | **MarkedAsUnopened** | Marks a dialog as unopened/unread. Can be set and removed by service owners and end users | |
🧰 Tools
🪛 LanguageTool
[style] ~18-~18: To form a complete sentence, be sure to include a subject.
Context: ...ened** | Set dialog as unopened/unread. Can be set and removed by service owner and...
(MISSING_IT_THERE)
🤖 Prompt for AI Agents
content/dialogporten/reference/entities/systemlabel/_index.en.md around line 18:
The label description lacks a subject and clarity; replace the current sentence
with a clear two-sentence phrasing such as "Marks the dialog as unopened/unread.
The service owner and end users can set or remove this label." ensuring correct
tense and explicit actor attribution.
1 participant
Summary by CodeRabbit