From fdc4886d3c660424b7170fb973b3b32df7f37426 Mon Sep 17 00:00:00 2001 From: Laszlo Gecse Date: Wed, 1 Oct 2025 16:12:40 +0200 Subject: [PATCH 1/2] fix(docs): updated schema_version in record examples Signed-off-by: Laszlo Gecse --- docs/dir/ads-records.md | 8 ++++---- docs/dir/hosted-agent-directory.md | 10 ++++++++-- docs/dir/scenarios.md | 2 +- docs/how-to-guides/agent-record-guide.md | 3 ++- 4 files changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/dir/ads-records.md b/docs/dir/ads-records.md index caad8379..5ee47319 100644 --- a/docs/dir/ads-records.md +++ b/docs/dir/ads-records.md @@ -21,7 +21,7 @@ You can generate your own example records using the [OASF Record Sample generato ```json { - "schema_version": "v0.7.0", + "schema_version": "0.7.0", "name": "email-agent", "version": "v1.0.0", "authors": [ @@ -46,12 +46,12 @@ You can generate your own example records using the [OASF Record Sample generato "locators": [ { "url": "https://github.com/agntcy/agentic-apps/tree/main/email_reviewer", - "type": "source-code" + "type": "source_code" }, { "url": "https://github.com/agntcy/agentic-apps/tree/main/email_reviewer/pyproject.toml", - "type": "python-package" + "type": "python_package" } - ], + ] } ``` diff --git a/docs/dir/hosted-agent-directory.md b/docs/dir/hosted-agent-directory.md index 1d91845c..db91b016 100644 --- a/docs/dir/hosted-agent-directory.md +++ b/docs/dir/hosted-agent-directory.md @@ -228,18 +228,24 @@ And it will look like this: ```json { + "schema_version": "0.7.0", "name": "organization/my-agent", "version": "2.0", + "authors": [ + "Organization Name" + ], "description": "This agent takes any text input and condenses it down to 3 bullets of less than 100 characters each using any LLM.", + "created_at": "2025-08-11T16:20:37.159072Z", "locators": [ { "url": "https://github.com/example/agent_A", - "type": "package-source-code" + "type": "source_code" } ], "skills": [ { - "class_uid": 10201 + "id": 10201, + "name": "natural_language_processing/natural_language_generation/text_completion" } ] } diff --git a/docs/dir/scenarios.md b/docs/dir/scenarios.md index 601ca842..2979dd47 100644 --- a/docs/dir/scenarios.md +++ b/docs/dir/scenarios.md @@ -33,7 +33,7 @@ cat << EOF > record.json "name": "my-record", "version": "v1.0.0", "description": "insert description here", - "schema_version": "v0.7.0", + "schema_version": "0.7.0", "skills": [ { "id": 201, diff --git a/docs/how-to-guides/agent-record-guide.md b/docs/how-to-guides/agent-record-guide.md index 6e0654cf..ba6f2afe 100644 --- a/docs/how-to-guides/agent-record-guide.md +++ b/docs/how-to-guides/agent-record-guide.md @@ -16,7 +16,8 @@ Start by filling out the basic metadata of your record: - `version`: Use semantic versioning to indicate the current version of your record. - `schema_version`: - Provide the OASF schema version the record needs to be valid against. + Provide the OASF schema version the record needs to be valid against. + Must be in semantic versioning format (see [https://semver.org/](https://semver.org/)), e.g., `"0.7.0"`. - `authors`: List the authors in the `Name ` format. Replace `Your Name` and `you@example.com` with the appropriate details. From 3b9fd8552e53964e484db971b1213c9740e76b21 Mon Sep 17 00:00:00 2001 From: Tibor Kircsi Date: Wed, 1 Oct 2025 16:54:53 +0200 Subject: [PATCH 2/2] update version in text also Signed-off-by: Tibor Kircsi --- docs/dir/ads-records.md | 2 +- docs/dir/dir-core-v1-api.md | 4 ++-- docs/oasf/decoding.md | 2 +- docs/oasf/validation.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/dir/ads-records.md b/docs/dir/ads-records.md index 5ee47319..43cd869b 100644 --- a/docs/dir/ads-records.md +++ b/docs/dir/ads-records.md @@ -17,7 +17,7 @@ You can generate your own example records using the [OASF Record Sample generato !!! note - This record uses `v0.7.0` of the OASF specification. + This record uses `0.7.0` of the OASF specification. ```json { diff --git a/docs/dir/dir-core-v1-api.md b/docs/dir/dir-core-v1-api.md index ed9a355a..1aff2032 100644 --- a/docs/dir/dir-core-v1-api.md +++ b/docs/dir/dir-core-v1-api.md @@ -23,8 +23,8 @@ Record is a generic object that encapsulates data of different Record types. Supported schemas: -v0.3.1: https://schema.oasf.outshift.com/0.3.1/objects/agent -v0.7.0: https://schema.oasf.outshift.com/0.7.0/objects/record +0.3.1: https://schema.oasf.outshift.com/0.3.1/objects/agent +0.7.0: https://schema.oasf.outshift.com/0.7.0/objects/record | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | diff --git a/docs/oasf/decoding.md b/docs/oasf/decoding.md index e5619fd1..ab8c2420 100644 --- a/docs/oasf/decoding.md +++ b/docs/oasf/decoding.md @@ -71,4 +71,4 @@ func GetRecordSchemaVersion(record *structpb.Struct) (string, error) * `record`: OASF record as Protocol Buffer Struct -Returns `string`: schema version (e.g., "v0.3.1", "v0.7.0"). +Returns `string`: schema version (e.g., "0.3.1", "0.7.0"). diff --git a/docs/oasf/validation.md b/docs/oasf/validation.md index f7e46437..fc7f8692 100644 --- a/docs/oasf/validation.md +++ b/docs/oasf/validation.md @@ -2,7 +2,7 @@ The validation service validates OASF records against JSON schemas. It supports both embedded schemas and custom schema URLs. The validation service supports the following features: -* Validates records against embedded schema versions (v0.3.1 and v0.7.0). +* Validates records against embedded schema versions (0.3.1 and 0.7.0). * Supports custom schema URLs for remote validation. * Returns detailed validation errors. * Automatic schema version detection from records.