Skip to content

fix(docs): updated schema_version in record examples - #266

Merged
lgecse merged 2 commits into
mainfrom
fix_record_examples
Oct 1, 2025
Merged

fix(docs): updated schema_version in record examples#266
lgecse merged 2 commits into
mainfrom
fix_record_examples

Conversation

@lgecse

@lgecse lgecse commented Oct 1, 2025

Copy link
Copy Markdown
Member

Fixes #265

Updated schema_version in record examples, so every example in the docs are valid. Ran extensive validation on these records using the OASF API, and made sure they are all valid.

Test evidence

Take OASF record example from docs/dir/ads-records.md.

CURL Command

curl -X 'POST' \
  'https://schema.oasf.outshift.com/api/validate/object/record?missing_recommended=false' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "schema_version": "0.7.0",
    "name": "email-agent",
    "version": "v1.0.0",
    "authors": [
      "Cisco Systems Inc."
    ],
    "description": "An agent that can send and receive emails.",
    "created_at": "2025-08-11T16:20:37.159072Z",
    "skills": [
        {
            "id": 10306,
            "name": "natural_language_processing/information_retrieval_synthesis/information_retrieval_synthesis_search"
        },
        {
            "id": 10202,
            "name": "natural_language_processing/natural_language_generation/summarization"
        },
        {
            "id": 60103,
            "name": "retrieval_augmented_generation/retrieval_of_information/document_retrieval"
        }
    ],
    "locators": [
      {
        "url": "https://github.com/agntcy/agentic-apps/tree/main/email_reviewer",
        "type": "source_code"
      },
      {
        "url": "https://github.com/agntcy/agentic-apps/tree/main/email_reviewer/pyproject.toml",
        "type": "python_package"
      }
    ]
}'

API Response

{
    "warnings": [],
    "errors": [],
    "error_count": 0,
    "warning_count": 0
}

Summary

The OASF record example from docs/dir/ads-records.md passes official validation, confirming compliance with OASF schema version 0.7.0.

Signed-off-by: Laszlo Gecse <lgecse@cisco.com>
@lgecse
lgecse requested a review from a team as a code owner October 1, 2025 14:33
@lgecse
lgecse requested review from akijakya, keraron and tkircsi and removed request for a team October 1, 2025 14:33

@keraron keraron left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

Signed-off-by: Tibor Kircsi <tkircsi@cisco.com>

@tkircsi tkircsi left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks!

@lgecse
lgecse merged commit c7337b8 into main Oct 1, 2025
5 checks passed
@lgecse
lgecse deleted the fix_record_examples branch October 1, 2025 15:09
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.

[Docs]: Update the schema_version field in OASF examples

3 participants