Completition and Examples for WebAPI (#1423) by fthobe · Pull Request #4674 · schemaorg/schemaorg

fthobe · 2026-01-02T17:45:36Z

Introduction

Building on the work of @nickevansuk this PR completes the work started in PR #2635 by @nickevansuk this PR introduces:

Examples for WebAPI
privacyPolicy

Picking up on the change requests originally raised in #2635 the PR brings following changes:

Addition of Properties

As Privacy Policies have become a legal requirement on websites to conform with GDPR, the property privacyPolicy has been added to Organization, Service, WebAPI and other classes that seemed appropriate.

Changes to Examples

The API provided in the example has been replaced with a currently available API;
Fixes minor technical issues such as json syntax errors, bugfixed minor automated testing errors and implemented the changes requested by @gmackenz and @danbri back then.

Concerns

Closes #1423
Closes #3050
Closes #4697
Renders obsolete: #2635

Backport WebAPI Schema

@nickevansuk

Based on previous work by @nickevansuk - Replace Google Knowledge Graph API with YouTube API (schemaorg#2635) - Some minor bugfixes to end up with compliant json Closes: schemaorg#1423 Superseedes: schemaorg#2635

fthobe · 2026-01-04T16:28:31Z

@nickevansuk can you take a look? I picked up your old PR to complete this.

fthobe · 2026-01-15T09:10:38Z

@MatthiasWiesmann I picked up #2635 to fix the only nit @danbri had back then as the PR was stale for almost a year and required only a minor change. I think this can be merged without issues as it was already approved back then.

fthobe · 2026-01-17T11:25:10Z

@gmackenz should be fine now if nobody complains.

Adds privacyPolicy to various applicable classes such as Organization, Service and WebAPI Closes schemaorg#3050

Adds privacyPolicy to WebAPI.

gmackenz · 2026-01-21T19:24:08Z

data/ext/pending/issue-1423-examples.txt

Shouldn't this be "TYPES: #eg-1423 WebAPI"

data/ext/pending/issue-1423-examples.txt

gmackenz · 2026-01-21T19:49:39Z

data/ext/pending/issue-1423-examples.txt

 </script>

+
+TYPES: #eg-0464 WebAPI, documentation, termsOfService, apiTransport, conformsTo


Why is this "#eg-0464"? I couldn't find any reference to an issue 464?

danbri · 2026-01-21T20:05:20Z

For some reason I forget (maybe @RichardWallis recalls?) we belatedly decided to give each example an identifier, which were originally assigned sequentially per data/examples.txt There’s a utility under software/ that will add approriage IDs for you. Somewhere around https://github.com/schemaorg/schemaorg/blob/main/software/SchemaExamples/README.md

…

On Wed, Jan 21, 2026 at 19:50 Gordon Mackenzie ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In data/ext/pending/issue-1423-examples.txt <#4674 (comment)>: > "provider": { ***@***.***": "Organization", "name": "Google Inc." } } </script> + +TYPES: #eg-0464 WebAPI, documentation, termsOfService, apiTransport, conformsTo Why is this "#eg-0464"? I couldn't find any reference to an issue 464? — Reply to this email directly, view it on GitHub <#4674 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABJSGJRIWLGR2T2JSAYBFL4H7J6TAVCNFSM6AAAAACQRKA3FKVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZTMOBZGEYTANRTGQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

An outdated name was used on the organization. Update organization name from 'Google Inc.' to 'Google LLC'

fthobe · 2026-01-21T20:15:22Z

@danbri

Thank you for pitching in :)

If the #eg-#### does not serve to indicate an issue anymore, what's the purpose of the progressive number? I can make a PR for the contribution guidelines if they need to be adjusted (at this point they have to). The rakefile does validate the presence of # but nothing else to indicate an issue number.

danbri · 2026-01-21T20:36:29Z

I believe the similarity to Issue IDs was a coincidence. However we did have the practice of grouping new terms (and their examples) into files roughly based on issue IDs. This was never very pure due to the desire to avoid each vocabulary request being an island decoupled from everything else. Many issues ended up being reexpressed to exploit or adapt existing terms. But that is why you’ll see both kinds of ID in the data files. Also just remembered why we went thru and numbered the examples. It was to support deeper linking into the documentation using links like https://schema.org/WebAPI#eg-0239 …while being more robust to changes, additions etc.

…

On Wed, Jan 21, 2026 at 20:15 Fab ***@***.***> wrote: *fthobe* left a comment (schemaorg/schemaorg#4674) <#4674 (comment)> @danbri <https://github.com/danbri> Thank you for pitching in :) If the #eg-#### does not serve to indicate an issue anymore, what's the purpose of the progressive number? I can make a PR for the contribution guidelines if they need to be adjusted (at this point they have to). — Reply to this email directly, view it on GitHub <#4674 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABJSGM35VMVLWHFGY5S3VL4H7M7BAVCNFSM6AAAAACQRKA3FKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTOOBQHE2TQNJTHE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

fthobe · 2026-01-21T20:48:44Z

@gmackenz there's surely some documentation that has to be written about that (I'd be happy to do it as the contribution guidelines in the current form are at least outdated, in some cases like here flat out wrong). Here's what I can do on the specific PR:

Uniform it to the issue number
let the python script run for uniformity

According to (current) docs the issue number would be correct.

I'd also open an issue about the docs regarding the identifier.

gmackenz · 2026-01-21T21:05:20Z

@gmackenz there's surely some documentation that has to be written about that (I'd be happy to do it as the contribution guidelines in the current form are at least outdated, in some cases like here flat out wrong).

Yes please!

Here's what I can do on the specific PR:

Uniform it to the issue number

let the python script run for uniformity

According to (current) docs the issue number would be correct.

Thanks, sounds good to me

I'd also open an issue about the docs regarding the identifier.

Excellent.

Closes schemaorg#4697

gmackenz · 2026-03-10T18:10:20Z

software/SchemaExamples/example-code/batch-process.py

This is code changes and should be reviewed separately IMO

gmackenz · 2026-03-10T18:11:39Z

data/ext/pending/issue-1423-examples.txt

I think there are merge conflicts that need to be resolved

nickevansuk and others added 12 commits July 7, 2020 16:12

Update based on schemaorg#1423

6e3ed2d

Amended to match webapi-discovery/rfcs#17

d2cb7b1

Merge branch 'main' into master

c0dabcd

Removed Hydra and gRPC examples

244be7d

Merge branch 'master' of github.com:openactive/schemaorg

4fce2d5

Simplification of references to documentation and endpointDescription

33b33fe

More general conformsTo

c90261b

Remove references to endpointUrl

7c65609

Merge branch 'main' of https://github.com/schemaorg/schemaorg

df17f1b

Fix conflicting example identifier

0cbd368

Merge pull request #2 from openactive/master

4264743

Backport WebAPI Schema

WebAPI samples (schemaorg#1423)

de929bb

Based on previous work by @nickevansuk - Replace Google Knowledge Graph API with YouTube API (schemaorg#2635) - Some minor bugfixes to end up with compliant json Closes: schemaorg#1423 Superseedes: schemaorg#2635

fthobe changed the title ~~Samples for WebAPI (#1423)~~ Completition and Examples for WebAPI (#1423) Jan 15, 2026

fthobe mentioned this pull request Jan 15, 2026

Add "WebAPI" type #1423

Open

fthobe marked this pull request as draft January 16, 2026 11:38

fthobe marked this pull request as ready for review January 17, 2026 11:25

Adds privacyPolicy (schemaorg#3050)

377142f

Adds privacyPolicy to various applicable classes such as Organization, Service and WebAPI Closes schemaorg#3050

fthobe force-pushed the 1423-WebAPI branch from f0f5f36 to 377142f Compare January 17, 2026 11:25

fthobe added 2 commits January 17, 2026 12:28

Adds privacyPolicy to WebAPI example

6f20ad4

Adds privacyPolicy to WebAPI.

Adds correct identifier to Example

42e3ee7

gmackenz reviewed Jan 21, 2026

View reviewed changes

data/ext/pending/issue-1423-examples.txt

Copy link

Contributor

gmackenz Jan 21, 2026

Choose a reason for hiding this comment

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

Shouldn't this be "TYPES: #eg-1423 WebAPI"

gmackenz reviewed Jan 21, 2026

View reviewed changes

data/ext/pending/issue-1423-examples.txt Outdated Show resolved Hide resolved

gmackenz reviewed Jan 21, 2026

View reviewed changes

data/ext/pending/issue-1423-examples.txt Outdated Show resolved Hide resolved

gmackenz reviewed Jan 21, 2026

View reviewed changes

Update organization name from 'Google Inc.' to 'Google LLC'

9e2e9ce

An outdated name was used on the organization. Update organization name from 'Google Inc.' to 'Google LLC'

fthobe force-pushed the 1423-WebAPI branch from 0ff6fbd to 9e2e9ce Compare January 21, 2026 20:06

fthobe mentioned this pull request Jan 21, 2026

Numbering of new examples in the issue-### example files not documented #4696

Open

fthobe added 3 commits January 23, 2026 19:00

Fix syntax erros in pythonexamples.py

4946d4e

Closes schemaorg#4697

Fix issue numbering in webAPI examples.

d0859cd

Test eg numbering

49ae6ba

gmackenz reviewed Mar 10, 2026

View reviewed changes

software/SchemaExamples/example-code/batch-process.py

Copy link

Contributor

gmackenz Mar 10, 2026

Choose a reason for hiding this comment

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

This is code changes and should be reviewed separately IMO

gmackenz reviewed Mar 10, 2026

View reviewed changes

data/ext/pending/issue-1423-examples.txt

Copy link

Contributor

gmackenz Mar 10, 2026

Choose a reason for hiding this comment

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

I think there are merge conflicts that need to be resolved

		</script>


		TYPES: #eg-0464 WebAPI, documentation, termsOfService, apiTransport, conformsTo

Conversation

fthobe commented Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Introduction

Addition of Properties

Changes to Examples

Concerns

Uh oh!

fthobe commented Jan 4, 2026

Uh oh!

fthobe commented Jan 15, 2026

Uh oh!

fthobe commented Jan 17, 2026

Uh oh!

gmackenz Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gmackenz Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

danbri commented Jan 21, 2026 via email

Uh oh!

fthobe commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

danbri commented Jan 21, 2026 via email

Uh oh!

fthobe commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gmackenz commented Jan 21, 2026

Uh oh!

gmackenz Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

gmackenz Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fthobe commented Jan 2, 2026 •

edited

Loading

fthobe commented Jan 21, 2026 •

edited

Loading

fthobe commented Jan 21, 2026 •

edited

Loading