Skip to content

Add metadata.yaml schema reference documentation - #1287

Open
aravindtga wants to merge 1 commit into
kptdev:mainfrom
Nordix:metadata-schema-reference
Open

Add metadata.yaml schema reference documentation#1287
aravindtga wants to merge 1 commit into
kptdev:mainfrom
Nordix:metadata-schema-reference

Conversation

@aravindtga

Copy link
Copy Markdown
Contributor

Description

  • What changed: Added a documentation page at documentation/content/en/metadata-schema/_index.md explaining the metadata.yaml schema, and updated CONTRIBUTING.md to link to it.
  • Why it's needed: The schema (scripts/generate_docs/metadata-schema.json) is enforced in CI but was not documented in a human-readable format for function authors.
  • How it works: The new page describes each field, required/optional status, allowed tag values, validation instructions, and how metadata.yaml is embedded in function code.

Related Issue(s)

Type of Change

  • Documentation

Checklist

  • Code follows project style guidelines
  • Self-reviewed changes
  • Tests added/updated
  • Documentation added/updated
  • All tests and gating checks pass

AI Disclosure

  • I have used AI in the creation of this PR.

Signed-off-by: Aravindhan Ayyanathan <aravindhan.a@est.tech>
@netlify

netlify Bot commented Jul 27, 2026

Copy link
Copy Markdown

Deploy Preview for krm-function-catalog ready!

Name Link
🔨 Latest commit 45f44c1
🔍 Latest deploy log https://app.netlify.com/projects/krm-function-catalog/deploys/6a6763251dc7f10008b5a422
😎 Deploy Preview https://deploy-preview-1287--krm-function-catalog.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@aravindtga aravindtga self-assigned this Jul 27, 2026
@aravindtga
aravindtga marked this pull request as ready for review July 27, 2026 14:00
@aravindtga
aravindtga requested review from a team July 27, 2026 14:00
@dosubot dosubot Bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jul 27, 2026
@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Jul 27, 2026
@aravindtga
aravindtga requested a review from a team July 27, 2026 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants