Add overview of the graph API

This commit is contained in:
Serafeim Chatzopoulos 2024-07-05 17:55:58 +03:00
parent abc9a2c9c6
commit 9cf1a50f47
8 changed files with 52 additions and 4 deletions

View File

@ -0,0 +1,2 @@
# Get single entities

View File

@ -0,0 +1,22 @@
# Graph API
The OpenAIRE Graph API provides a comprehensive way for developers to explore the [OpenAIRE Graph](https://graph.openaire.eu/), a vast interconnected dataset that aggregates metadata from a wide range of scholarly resources.
The Graph API offers endpoints for accessing and querying this interconnected dataset, enabling users to retrieve detailed information on research products, organizations, data sources, and projects.
You can access the Swagger documentation of the Graph API [here](https://openaire-api.athenarc.gr/swagger-ui/index.html#/).
Please note that the Graph API:
- is intended for data discovery and exploration; if you are interested in downloading the full OpenAIRE Graph dataset, please navigate [here](../../downloads/full-graph).
- adhers to the [terms of use](../terms.md) of the OpenAIRE public APIs - certain (rate limit) restrictions apply.
## Learn more
Please use the following links to learn more about the Graph API:
- [Get single entities](./get-single-entities) - Retrieve detailed information on a single entity.
- [Search entities](./search-entities/overview) - Retrieve a list of entities based on specific search criteria.
- [Filter search results](./search-entities/filter-search-results) - Filter search results based on specific criteria.
- [Sort search results](./search-entities/sort-search-results) - Sort search results based on specific criteria.
- [Pagination](./search-entities/pagination) - Retrieve a subset of search results.

View File

@ -0,0 +1,2 @@
# Filter search results

View File

@ -0,0 +1 @@
# Search entities

View File

@ -0,0 +1 @@
# Pagination

View File

@ -0,0 +1 @@
# Sort search results

View File

@ -1,9 +1,10 @@
# Public APIs # Public APIs
The OpenAIRE Graph data are accessible through various public APIs. More specifically, the following APIs are currently provided: The OpenAIRE Graph data are accessible through various public APIs. More specifically, the following APIs are currently provided:
* [Search API](./search-api/search-api.md) (an API to search for research products and projects) * [Graph API](./graph-api/overview) - an API to explore the OpenAIRE Graph
* [ScholeXplorer API](https://api.scholexplorer.openaire.eu/swagger-ui/index.html?urls.primaryName=Scholexplorer%20API%20V2.0) (an API offering dataset-publication & dataset-dataset links) * [Search API](./search-api/search-api.md) - an API to search for research products and projects
* [DSpace & EPrints API](./dspace-eprints-api.md) (an API to offer custom access to metadata for projects funded by a selection of international funders for DSpace and EPrints platforms) * [ScholeXplorer API](https://api.scholexplorer.openaire.eu/swagger-ui/index.html?urls.primaryName=Scholexplorer%20API%20V2.0) - an API offering dataset-publication & dataset-dataset links
* [Broker API](./broker-api.md) (an API to enrich metadata for repositories, publishers, and aggregators) * [DSpace & EPrints API](./dspace-eprints-api.md) - an API to offer custom access to metadata for projects funded by a selection of international funders for DSpace and EPrints platforms
* [Broker API](./broker-api.md) - an API to enrich metadata for repositories, publishers, and aggregators
It is also worth mentioning that, between 2015 and 2023 a LOD API was being provided but the respective service has been discontinued. Old LOD datasets can be found on Zenodo [here](https://zenodo.org/records/4587369). It is also worth mentioning that, between 2015 and 2023 a LOD API was being provided but the respective service has been discontinued. Old LOD datasets can be found on Zenodo [here](https://zenodo.org/records/4587369).

View File

@ -58,6 +58,24 @@ const sidebars = {
label: "Public APIs", label: "Public APIs",
link: {type: 'doc', id: 'apis/home'}, link: {type: 'doc', id: 'apis/home'},
items: [ items: [
{
type: 'category',
label: "Graph API",
link: { type: 'doc', id: 'apis/graph-api/overview' },
items: [
{ type: 'doc', id: 'apis/graph-api/get-single-entities' },
{
type: 'category',
label: "Search entities",
link: { type: 'doc', id: 'apis/graph-api/search-entities/overview' },
items: [
{ type: 'doc', id: 'apis/graph-api/search-entities/filter-search-results' },
{ type: 'doc', id: 'apis/graph-api/search-entities/sort-search-results' },
{ type: 'doc', id: 'apis/graph-api/search-entities/pagination' },
]
}
]
},
{ {
type: 'category', type: 'category',
label: "Search API", label: "Search API",