Add validation error codes documentation for Notifications API

[olebhansen]

Summary

Updates the Notifications API error codes reference documentation to include the new validation error codes.

Changes

• Adds explanation of two error code formats:
  • Business errors: NOT-XXXXX
  • Validation errors: NOT.VLD-XXXXX
• Adds example response showing the validationErrors array format
• Documents all 30+ validation error codes in organized tables by category

Related

• Implementation PR: Add machine-readable validation error codes for v2 controllers altinn-notifications#1259
• Issue: Add machine readable codes for validation errors altinn-notifications#1189

Test plan

• Preview documentation renders correctly
• Tables are properly formatted
• Code examples are correctly displayed

🤖 Generated with Claude Code

Summary by CodeRabbit

Documentation

• Restructured error code reference documentation for improved clarity and usability
• Introduced explicit separation between business error codes (NOT-XXXXX) and validation error codes (NOT.VLD-XXXXX) formats
• Added comprehensive validation error code reference with organized categories (request validation, timing, endpoints, recipients, email/SMS settings, reminders, channel schema, status feed, integration validation)
• Enhanced documentation with JSON example responses demonstrating validation error handling and machine-readable error identification

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Note

.coderabbit.yaml has unrecognized properties

CodeRabbit is using all valid settings from your configuration. Unrecognized properties (listed below) have been ignored and may indicate typos or deprecated fields that can be removed.

⚠️ Parsing warnings (1)

Validation error: Unrecognized key(s) in object: 'auto_resolve_threads'

⚙️ Configuration instructions

• Please see the configuration documentation for more information.
• You can also validate your configuration using the online YAML validator.
• 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

📝 Walkthrough

Walkthrough

Documentation restructured to delineate error codes into two categories: Business Errors (NOT-XXXXX) and Validation Errors (NOT.VLD-XXXXX). Added comprehensive validation error codes table with multiple validation categories and their associated codes across English and Norwegian Bokmål documentation.

Changes

Cohort / File(s)

Summary

Error Code Documentation Restructuring content/notifications/reference/error-codes/_index.en.md, content/notifications/reference/error-codes/_index.nb.md

Separated error code documentation into two distinct sections: Business Errors (NOT-XXXXX format with RFC7807 references) and Validation Errors (NOT.VLD-XXXXX format). Added comprehensive validation error codes table with 10+ categories (Basic Request Validation, Send Time Validation, Condition Endpoint Validation, Recipient Validation, Email/SMS Settings Validation, Reminder Validation, Channel Schema Validation, Status Feed Validation, Dialogporten Validation). Included example JSON response snippets and reformatted overall documentation flow. Changes applied consistently to both English and Norwegian Bokmål versions. (+138/-2 lines in each file)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🔍 Errors now sorted, neat and clear,
Business and validation, no more fear!
NOT codes dance, VLD ones stay,
Docs restructured in every way! 📋✨

🚥 Pre-merge checks | ✅ 3

✅ 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 primary change: adding validation error codes documentation for the Notifications API, which aligns with the detailed documentation additions across both English and Norwegian files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@content/notifications/reference/error-codes/_index.en.md`:
- Around line 23-26: The last bullet in the validation errors list is missing
terminal punctuation; update the final list item ("- A `validationErrors` array
with individual validation errors, each with its own `code`") to end with a
period so the bullet list reads: include a period at the end of the
`validationErrors` item (the line mentioning `STD-00000` and
`validationErrors`).

In `@content/notifications/reference/error-codes/_index.nb.md`:
- Around line 23-26: The bullet list in the markdown block ending with "hver med
sin egen `code`" lacks terminal punctuation; update that final list item by
appending a period so the line reads "...hver med sin egen `code`." to satisfy
grammar checks and guidelines.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Add terminal punctuation after the bullet list.

The bullet list ends without punctuation; add a period after the last bullet to satisfy grammar checks and improve readability.

🧰 Tools

🪛 LanguageTool

[grammar] ~25-~25: Please add a punctuation mark at the end of paragraph.
Context: ...vidual validation errors, each with its own code **Example validation error resp...

(PUNCTUATION_PARAGRAPH_END)

🤖 Prompt for AI Agents

In `@content/notifications/reference/error-codes/_index.en.md` around lines 23 -
26, The last bullet in the validation errors list is missing terminal
punctuation; update the final list item ("- A `validationErrors` array with
individual validation errors, each with its own `code`") to end with a period so
the bullet list reads: include a period at the end of the `validationErrors`
item (the line mentioning `STD-00000` and `validationErrors`).

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Add terminal punctuation after the bullet list.

The bullet list ends without punctuation; add a period after the last bullet to satisfy grammar checks and improve readability. As per coding guidelines.

🤖 Prompt for AI Agents

In `@content/notifications/reference/error-codes/_index.nb.md` around lines 23 -
26, The bullet list in the markdown block ending with "hver med sin egen `code`"
lacks terminal punctuation; update that final list item by appending a period so
the line reads "...hver med sin egen `code`." to satisfy grammar checks and
guidelines.