diff --git a/docs/apis/graph-api/getting-a-single-entity.md b/docs/apis/graph-api/getting-a-single-entity.md index c0e977f..432bb68 100644 --- a/docs/apis/graph-api/getting-a-single-entity.md +++ b/docs/apis/graph-api/getting-a-single-entity.md @@ -14,11 +14,11 @@ You can retrieve the data of a single entity by providing the entity's OpenAIRE The OpenAIRE id is the primary key of an entity in the OpenAIRE Graph. :::note -Note that if you want to retrieve multiple entities based on their OpenAIRE ids, you can use the [search endpoints and filter](./searching-entities/filtering-search-results#or-operator) by the `id` field using `OR`. +Note that if you want to retrieve multiple entities based on their OpenAIRE ids, you can use the [search endpoints and filter](./searching-entities/filtering-search-results.md#or-operator) by the `id` field using `OR`. ::: ## Response -The response of the Graph API is a [Research product](../../data-model/entities/research-product), [Organization](../../data-model/entities/organization), [Data Source](../../data-model/entities/data-source), or [Project](../../data-model/entities/project), depending on the endpoint used. +The response of the Graph API is a [Research product](../../data-model/entities/research-product.md), [Organization](../../data-model/entities/organization.md), [Data Source](../../data-model/entities/data-source.md), or [Project](../../data-model/entities/project.md), depending on the endpoint used. ## Example diff --git a/docs/apis/graph-api/overview.md b/docs/apis/graph-api/graph-api.md similarity index 64% rename from docs/apis/graph-api/overview.md rename to docs/apis/graph-api/graph-api.md index 79b90b9..f26f8bb 100644 --- a/docs/apis/graph-api/overview.md +++ b/docs/apis/graph-api/graph-api.md @@ -16,16 +16,16 @@ You can access the API Swagger documentation in [https://api-beta.openaire.eu/gr ## Notes 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). +- is intended for data discovery and exploration; if you are interested in downloading the full OpenAIRE Graph dataset, please navigate [here](../../downloads/full-graph.md). - 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: -- [Getting a single entity](./getting-a-single-entity) - Retrieve detailed information on a single entity. -- [Searching entities](./searching-entities/overview) - Retrieve a list of entities based on specific search criteria. - - [Filtering results](./searching-entities/filtering-search-results) - Filter search results based on specific criteria. - - [Sorting results](./searching-entities/sorting-and-paging#sorting) - Sort search results based on specific criteria. - - [Paging](./searching-entities/sorting-and-paging#paging) - Retrieve a subset of search results. -- [Making requests](./making-requests) - Learn how to make requests with different programming languages. +- [Getting a single entity](./getting-a-single-entity.md) - Retrieve detailed information on a single entity. +- [Searching entities](./searching-entities/searching-entities.md) - Retrieve a list of entities based on specific search criteria. + - [Filtering results](./searching-entities/filtering-search-results.md) - Filter search results based on specific criteria. + - [Sorting results](./searching-entities/sorting-and-paging.md#sorting) - Sort search results based on specific criteria. + - [Paging](./searching-entities/sorting-and-paging.md#paging) - Retrieve a subset of search results. +- [Making requests](./making-requests.md) - Learn how to make requests with different programming languages. diff --git a/docs/apis/graph-api/searching-entities/filtering-search-results.md b/docs/apis/graph-api/searching-entities/filtering-search-results.md index a2ce7a2..b8e239f 100644 --- a/docs/apis/graph-api/searching-entities/filtering-search-results.md +++ b/docs/apis/graph-api/searching-entities/filtering-search-results.md @@ -1,7 +1,7 @@ # Filtering search results Filters can be used to narrow down the search results based on specific criteria. -Filters are provided as query parameters in the request URL (see [here](./overview#endpoints) for the available search entpoints). +Filters are provided as query parameters in the request URL (see [here](./searching-entities.md) for the available search entpoints). Multiple filters can be provided in a single request; they should be formatted as follows: `param1=value1¶m2=value2&...¶mN=valueN`. diff --git a/docs/apis/graph-api/searching-entities/overview.md b/docs/apis/graph-api/searching-entities/searching-entities.md similarity index 79% rename from docs/apis/graph-api/searching-entities/overview.md rename to docs/apis/graph-api/searching-entities/searching-entities.md index ce59be5..57f5e10 100644 --- a/docs/apis/graph-api/searching-entities/overview.md +++ b/docs/apis/graph-api/searching-entities/searching-entities.md @@ -11,8 +11,8 @@ Currently, the Graph API supports the following entity types: * Projects - endpoint: [`GET /projects`](https://api-beta.openaire.eu/graph/projects) Each of these endpoints can be used to list all entities of the corresponding type. -Listing such entities can be more useful when using the [filtering](./filtering-search-results), -[sorting](./sorting-and-paging#sorting), and [paging](./sorting-and-paging#paging) capabilities of the Graph API. +Listing such entities can be more useful when using the [filtering](./filtering-search-results.md), +[sorting](./sorting-and-paging.md#sorting), and [paging](./sorting-and-paging.md#paging) capabilities of the Graph API. ## Response @@ -41,4 +41,4 @@ It contains a `header` object with the following fields: - `page`: the current page of the search results - `pageSize`: the number of entities per page -Finally, the `results` field contains an array of entities of the corresponding type (i.e., [Research product](../../../data-model/entities/research-product), [Organization](../../../data-model/entities/organization), [Data Source](../../../data-model/entities/data-source), or [Project](../../../data-model/entities/project)). +Finally, the `results` field contains an array of entities of the corresponding type (i.e., [Research product](../../../data-model/entities/research-product.md), [Organization](../../../data-model/entities/organization.md), [Data Source](../../../data-model/entities/data-source.md), or [Project](../../../data-model/entities/project.md)). diff --git a/docs/apis/graph-api/searching-entities/sorting-and-paging.md b/docs/apis/graph-api/searching-entities/sorting-and-paging.md index 3458a3c..ff88a26 100644 --- a/docs/apis/graph-api/searching-entities/sorting-and-paging.md +++ b/docs/apis/graph-api/searching-entities/sorting-and-paging.md @@ -9,7 +9,7 @@ Sorting is achieved using the `sortBy` parameter, which specifies the field and * `sortBy`: Defines the field and the sort direction. The format should be `fieldname sortDirection`, where the `sortDirection` can be either `ASC` for ascending order or `DESC` for descending order. -The field names that can be used for sorting are specific to each entity type and can be found in the `sortBy` field values of the [available paremeters](../searching-entities/filtering-search-results#available-parameters). +The field names that can be used for sorting are specific to each entity type and can be found in the `sortBy` field values of the [available paremeters](../searching-entities/filtering-search-results.md#available-parameters). Note that the default sorting is based on the `relevance` score of the search results. diff --git a/docs/apis/home.md b/docs/apis/home.md index aa25e6e..24198f2 100644 --- a/docs/apis/home.md +++ b/docs/apis/home.md @@ -1,7 +1,7 @@ # Public APIs The OpenAIRE Graph data are accessible through various public APIs. More specifically, the following APIs are currently provided: -* [Graph API](./graph-api/overview) - an API to explore the OpenAIRE Graph +* [Graph API](./graph-api/graph-api.md) - an API to explore the OpenAIRE Graph * [Search API](./search-api/search-api.md) - an API to search for research products and projects * [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 * [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 diff --git a/sidebars.js b/sidebars.js index ca88c55..c7c317c 100644 --- a/sidebars.js +++ b/sidebars.js @@ -61,13 +61,13 @@ const sidebars = { { type: 'category', label: "Graph API", - link: { type: 'doc', id: 'apis/graph-api/overview' }, + link: { type: 'doc', id: 'apis/graph-api/graph-api' }, items: [ { type: 'doc', id: 'apis/graph-api/getting-a-single-entity' }, { type: 'category', label: "Searching entities", - link: { type: 'doc', id: 'apis/graph-api/searching-entities/overview' }, + link: { type: 'doc', id: 'apis/graph-api/searching-entities/searching-entities' }, items: [ { type: 'doc', id: 'apis/graph-api/searching-entities/filtering-search-results' }, { type: 'doc', id: 'apis/graph-api/searching-entities/sorting-and-paging' },