Skip to content

WebAPI update based on #1423 #2635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nickevansuk wants to merge 10 commits into
base: main
Choose a base branch
from
Open

WebAPI update based on #1423 #2635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6e3ed2d
Update based on #1423
nickevansuk Jul 7, 2020
d2cb7b1
Amended to match https://github.com/webapi-discovery/rfcs/pull/17
nickevansuk Aug 7, 2020
c0dabcd
Merge branch 'main' into master
nickevansuk Aug 12, 2020
244be7d
Removed Hydra and gRPC examples
nickevansuk Aug 14, 2020
4fce2d5
Merge branch 'master' of github.com:openactive/schemaorg
nickevansuk Aug 14, 2020
33b33fe
Simplification of references to documentation and endpointDescription
nickevansuk Aug 17, 2020
c90261b
More general `conformsTo`
nickevansuk Aug 25, 2020
7c65609
Remove references to endpointUrl
nickevansuk Nov 10, 2020
df17f1b
Merge branch 'main' of https://github.com/schemaorg/schemaorg
nickevansuk Nov 11, 2020
0cbd368
Fix conflicting example identifier
nickevansuk Nov 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 72 additions & 3 deletions data/ext/pending/issue-1423-examples.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ See JSON example.

MICRODATA:

TODO
Example is JSON-LD only.

RDFA:

TODO
Example is JSON-LD only.

JSON:

Expand All @@ -20,7 +20,8 @@ JSON:
"@type": "WebAPI",
"name": "Google Knowledge Graph Search API",
"description": "The Knowledge Graph Search API lets you find entities in the Google Knowledge Graph. The API uses standard schema.org types and is compliant with the JSON-LD specification.",
"documentation": "https://developers.google.com/knowledge-graph/",
"url": "https://developers.google.com/knowledge-graph/",
"documentation": "https://developers.google.com/knowledge-graph/reference/rest/v1",
"termsOfService": "https://developers.google.com/knowledge-graph/terms",
"provider": {
"@type": "Organization",
Expand All @@ -29,3 +30,71 @@ JSON:
}
</script>


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

PRE-MARKUP:

See JSON example.

MICRODATA:

Example is JSON-LD only.

RDFA:

Example is JSON-LD only.

JSON:

<script type="application/ld+json">
{
"@context": "https://schema.org/",
"@type": "WebAPI",
"name": "Google Knowledge Graph Search API",
"description": "The Knowledge Graph Search API lets you find entities in the Google Knowledge Graph. The API uses standard schema.org types and is compliant with the JSON-LD specification.",
"documentation": "https://developers.google.com/knowledge-graph/reference/rest/v1",
"endpointDescription": [
{
"@type": "CreativeWork",
"encodingFormat": "application/json",
"url": "https://kgsearch.googleapis.com/$discovery/rest?version=v1"
},
{
"@type": "CreativeWork",
"encodingFormat": "application/vnd.oai.openapi+json;version=3.0",
"url": "https://api.apis.guru/v2/specs/googleapis.com/kgsearch/v1/openapi.json"
}
],
"url": "https://developers.google.com/knowledge-graph/",
"termsOfService": "https://developers.google.com/knowledge-graph/terms",
"logo": "https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png",
"license": "https://creativecommons.org/licenses/by/3.0/",
"provider": {
"@type": "Organization",
"name": "Google Inc.",
"contactPoint": [
{
"@type": "ContactPoint",
"name": "Google",
"url": "https://google.com"
}
],
},
"version": "1.0.0",
"apiTransport": [
"HTTP",
"HTTPS"
],
"conformsTo": [
"https://jsonapi.org/format/1.0/"
],
"potentialAction": [
{
"@type": "ConsumeAction",
"name": "API Client Registration",
"target": "https://developers.google.com/knowledge-graph/how-tos/authorizing"
}
]
}
</script>
54 changes: 52 additions & 2 deletions data/ext/pending/issue-1423.ttl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@
:category "issue-1423" ;
:isPartOf <http://pending.schema.org> ;
:source <https://github.com/schemaorg/schemaorg/issues/1423> ;
rdfs:comment "An application programming interface accessible over Web/Internet technologies." ;
rdfs:comment """An application programming interface accessible over Web/Internet technologies.

The [[documentation]] and [[endpointDescription]] properties give specific details of the actual endpoint instances, while the [[conformsTo]] property is used to indicate the general standard or specification that the endpoints implement. The [[url]] property indicates a landing page for the API, which is a Web page that can be navigated to in a Web browser to gain access to the API and/or additional information.
""" ;
rdfs:subClassOf :Service .

:documentation a rdf:Property ;
Expand All @@ -18,7 +21,19 @@
:rangeIncludes :CreativeWork,
:URL ;
:source <https://github.com/schemaorg/schemaorg/issues/1423> ;
rdfs:comment "Further documentation describing the Web API in more detail." .
rdfs:comment "Human-readable documentation of the services available via the [[WebAPI]], including their operations, parameters etc." .

:endpointDescription a rdf:Property ;
rdfs:label "endpointDescription" ;
:category "issue-1423" ;
:domainIncludes :WebAPI ;
:isPartOf <http://pending.schema.org> ;
:rangeIncludes :CreativeWork ;
:source <https://github.com/schemaorg/schemaorg/issues/1423> ;
rdfs:comment """Machine-readable API definition of the services available via the [[WebAPI]], including their operations, parameters etc.

Machine-readable formats include OpenAPI (Swagger) description, an OGC GetCapabilities response WFS, ISO-19142, WMS, ISO-19128, a SPARQL Service Description, an OpenSearch or WSDL20 document, or a Hydra API description. The [[encodingFormat]] property of the [[CreativeWork]] should be used to indicate the use of such formats via their MIME type.
""" .

:termsOfService a rdf:Property ;
rdfs:label "termsOfService" ;
Expand All @@ -30,3 +45,38 @@
:source <https://github.com/schemaorg/schemaorg/issues/1423> ;
rdfs:comment "Human-readable terms of service documentation." .

:conformsTo a rdf:Property ;
Comment thread
nickevansuk marked this conversation as resolved.
rdfs:label "conformsTo" ;
:category "issue-1423" ;
:domainIncludes :CreativeWork,
:WebAPI ;
:isPartOf <http://pending.schema.org> ;
:rangeIncludes :URL ;
:source <https://github.com/schemaorg/schemaorg/issues/1423> ;
rdfs:comment """The URL reference of an established standard to which the [[Thing]] described conforms.
""" .

:accessService a rdf:Property ;
rdfs:label "accessService" ;
:category "issue-1423" ;
:domainIncludes :Dataset,
:DataDownload ;
:isPartOf <http://pending.schema.org> ;
:rangeIncludes :WebAPI ;
:source <https://github.com/schemaorg/schemaorg/issues/1423> ;
rdfs:comment "An API that provides access to the dataset." .

:apiTransport a rdf:Property ;
rdfs:label "apiTransport" ;
:category "issue-1423" ;
:domainIncludes :WebAPI ;
:isPartOf <http://pending.schema.org> ;
:rangeIncludes :Text ;
:source <https://github.com/schemaorg/schemaorg/issues/1423> ;
rdfs:comment "The type of transport used for the API, such as `HTTP`, `HTTPS`, `SMTP`, `MQTT`, `WS`, `WSS`, `gRPC`." .

:version a rdf:Property ;
:domainIncludes :WebAPI .

:license a rdf:Property ;
:domainIncludes :WebAPI .