Skip to content

Conversation

@Behzad-rabiei
Copy link
Member

@Behzad-rabiei Behzad-rabiei commented Jun 17, 2025

Summary by CodeRabbit

  • New Features

    • Added a new optional "activated" setting for the MediaWiki module metadata.
  • Bug Fixes

    • The "namespaces" field for MediaWiki metadata is now optional and defaults to [0] if not provided.
  • Documentation

    • Updated API documentation to reflect changes in MediaWiki module and platform metadata fields, including the renaming and default value for "namespaces" and the addition of "activated".

@coderabbitai
Copy link

coderabbitai bot commented Jun 17, 2025

Walkthrough

The changes update the MediaWiki platform and module metadata schemas and validation logic. The "namespaces" field is renamed, made optional, and given a default value of [0]. An "activated" boolean property is added to the MediaWiki module metadata. All modifications are limited to documentation and validation schemas.

Changes

File(s) Change Summary
src/docs/module.doc.yml Renamed "pageIds" to "namespaces" (array of numbers, default [0]), added "activated" property to MediaWiki module metadata.
src/docs/platform.doc.yml Made "namespaces" optional (default [0]), removed from required fields in MediaWiki platform metadata.
src/validations/module.validation.ts Updated MediaWiki module metadata schema: added optional "namespaces" (array of numbers, default [0]).
src/validations/platform.validation.ts Made "namespaces" optional with default [0] in MediaWiki platform metadata validation schemas.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Validation
    participant DB

    Client->>API: PATCH /modules (MediaWiki)
    API->>Validation: Validate metadata (namespaces, activated)
    Validation-->>API: Success/Failure
    API->>DB: Update module with metadata (namespaces default to [0] if omitted)
    DB-->>API: Confirmation
    API-->>Client: Response
Loading

Possibly related PRs

  • 471 update mediawiki api #475: Refines changes to the "namespaces" field, making it optional with a default value and renaming it, directly modifying the same MediaWiki metadata schemas.
  • Migration script to add modules #474: Introduces an activated boolean property for modules, related to the addition of the activated field in MediaWiki platform metadata.

Poem

A schema hop, a validation skip,
"Namespaces" now takes a default trip.
"Activated" joins the MediaWiki crew,
Optional fields—what a neat view!
With arrays set to [0],
The docs and code now smoothly flow.
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-17T08_22_26_657Z-debug-0.log

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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 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.

Copy link

@coderabbitai coderabbitai bot left a 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 (4)
src/validations/module.validation.ts (1)

80-85: Avoid shared-array default & tighten validation for namespaces

default([0]) hands every validation result the same array reference.
If any downstream code mutates that array (e.g. value.namespaces.push(1)), the mutation will bleed into future validations. At the same time, nothing prevents negative/duplicate namespace IDs.

-    namespaces: Joi.array().items(Joi.number()).default([0]),
+    namespaces: Joi.array()
+      .items(Joi.number().integer().min(0))
+      .unique()                           // avoid duplicates
+      .default(() => [0]),                // fresh array per call

This keeps the object immutable between requests and enforces non-negative, unique integers.

src/validations/platform.validation.ts (2)

38-44: Same namespaces default issue in update-schema

The update-metadata schema repeats the constant-array default & loose number rule.
Please replicate the fix suggested for the module schema.

-    namespaces: Joi.array().items(Joi.number()).default([0]),
+    namespaces: Joi.array()
+      .items(Joi.number().integer().min(0))
+      .unique()
+      .default(() => [0]),

93-99: …and in create-metadata schema

Apply identical fix here to keep behaviour consistent across create & update paths.

src/docs/platform.doc.yml (1)

168-179: OpenAPI default for arrays: prefer block style for clarity

OpenAPI tooling sometimes mis-parses inline list syntax default: [0].
The safer, clearer form is:

namespaces:
  type: array
  items:
    type: number
  default:
    - 0

Switching avoids parser quirks and improves readability.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c2dd333 and 6bab3c3.

📒 Files selected for processing (4)
  • src/docs/module.doc.yml (1 hunks)
  • src/docs/platform.doc.yml (1 hunks)
  • src/validations/module.validation.ts (1 hunks)
  • src/validations/platform.validation.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: ci / build-push / Build + Push Image
🔇 Additional comments (1)
src/docs/module.doc.yml (1)

244-251: Ambiguous double “activated” field

activated now appears both

  1. at module top-level (line 279) and
  2. inside the MediaWiki metadata object (line 250).

Two boolean flags with the same name but different scopes can confuse API consumers and SDK generators.
Consider renaming the inner flag (e.g. contentActivated) or documenting the distinction explicitly in description:.

@Behzad-rabiei Behzad-rabiei merged commit aea1670 into main Jun 17, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants