Skip to content

docs: point OASF badge references at the live schema server - #169

Open
ncdingari wants to merge 1 commit into
agntcy:mainfrom
ncdingari:docs/oasf-schema-url
Open

docs: point OASF badge references at the live schema server#169
ncdingari wants to merge 1 commit into
agntcy:mainfrom
ncdingari:docs/oasf-schema-url

Conversation

@ncdingari

Copy link
Copy Markdown

docs: point OASF badge references at the live schema server

Problem

The OASF links in the AgentBadge documentation are dead twice over.

The host does not resolve. schema.oasf.agntcy.org has no DNS record:

$ curl -sS https://schema.oasf.agntcy.org/objects/agent
curl: (6) Could not resolve host: schema.oasf.agntcy.org

OASF's own README, CONTRIBUTING guide and server code (server/lib/schema/json_schema.ex, @schema_base_uri) all use schema.oasf.outshift.com.

The path is also gone. OASF renamed the agent object to recordschema/objects/agent.json no longer exists upstream, only schema/objects/record.json:

$ curl -s -o /dev/null -w '%{http_code}\n' https://schema.oasf.outshift.com/objects/agent
404
$ curl -s -o /dev/null -w '%{http_code}\n' https://schema.oasf.outshift.com/objects/record
200

So a reader following # OASF Files - https://schema.oasf.agntcy.org/objects/agent in cmd/issuer/README.md — the line directly above the identity badge issue oasf example — cannot reach the schema it describes by any route.

Someone has already hit this and worked around the symptom rather than the cause: agntcy/agent-identity-demos carries the comment "schema.oasf.agntcy.org may not resolve from your network" in a docker-compose.yaml.

Change

Replaces the host and the object path in the five places the reference appears:

File Kind
api/spec/proto/agntcy/identity/core/v1alpha1/vc.proto source comment
api/server/agntcy/identity/core/v1alpha1/vc.pb.go generated from the proto
api/spec/static/api/proto/v1alpha1/proto_workspace.json generated from the proto
internal/core/vc/types/types.go equivalent comment on the Go constant
cmd/issuer/README.md user-facing docs

Comments and documentation only — no behaviour change, no API change, no proto field or enum value touched.

Deliberately not changed

samples/agent/oasf/marketing-campaign/v1.0.0.json contains two schema.oasf.agntcy.org/features/runtime/... strings. Those are OASF feature name identifiers inside a sample record, not URLs. Changing them would alter sample data rather than fix a broken link, so they are left as they are. Happy to take them in a follow-up if maintainers want the samples refreshed to current OASF.

Same fix needed elsewhere

The identical dead reference appears in agntcy/identity-spec and agntcy/identity-service. I can open matching PRs there if that is useful — I did not want to file three at once unasked.

The OASF links in the AgentBadge documentation are dead twice over.

schema.oasf.agntcy.org does not resolve — it has no DNS record, so every
one of these links fails to connect. The OASF schema server is served
from schema.oasf.outshift.com, which is the host OASF's own README,
CONTRIBUTING guide and server code all use.

The objects/agent path is also gone. OASF renamed that object to
record; schema/objects/agent.json no longer exists upstream and
https://schema.oasf.outshift.com/objects/agent returns 404, while
.../objects/record returns 200.

Updates the proto comment and regenerates the artifacts derived from it,
plus the equivalent comment in internal/core/vc/types and the issuer
README. Comments only — no behaviour change.

The two schema.oasf.agntcy.org strings in
samples/agent/oasf/marketing-campaign/v1.0.0.json are left alone: they
are OASF feature name identifiers inside a sample record, not URLs, and
changing them would alter sample data rather than fix a link.

Signed-off-by: Narahara Chari Dingari <chari@sciencephalon.com>

@jadiaconu jadiaconu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the fix

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.

3 participants