OpenAPI Specification
openapi: 3.0.3
info:
title: Zenodo REST Access Featured Communities API
description: 'REST API for Zenodo, the free open research data repository operated by CERN and built on InvenioRDM. Provides programmatic access to deposits (draft records), published records, file management, communities, vocabularies, OAI-PMH sets, requests, users, groups, statistics, and audit logs. Every published record receives a DOI for persistent citation. Authenticate with a personal access token passed as a Bearer token.
'
version: 12.0.0
contact:
name: Zenodo Developer Documentation
url: https://developers.zenodo.org/
license:
name: MIT License
url: https://opensource.org/licenses/MIT
x-upstream-spec: https://github.com/inveniosoftware/invenio-openapi
servers:
- url: https://zenodo.org
description: Zenodo production instance
- url: https://sandbox.zenodo.org
description: Zenodo sandbox (testing)
security:
- BearerAuth: []
tags:
- name: Featured Communities
description: Featured communities management
paths:
/api/communities/featured:
get:
summary: Search featured communities
tags:
- Featured Communities
operationId: searchFeaturedCommunities
parameters:
- name: q
in: query
required: false
schema:
type: string
- name: size
in: query
required: false
schema:
type: string
- name: page
in: query
required: false
schema:
type: string
responses:
'200':
$ref: '#/components/responses/Success'
'500':
$ref: '#/components/responses/InternalServerError'
/api/communities/{communityId}/featured:
get:
summary: Get featured community entry
tags:
- Featured Communities
operationId: getFeaturedCommunityEntry
parameters:
- name: communityId
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/Success'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
security:
- BearerAuth: []
post:
summary: Create a featured community entry
tags:
- Featured Communities
operationId: createFeaturedCommunityEntry
parameters:
- name: communityId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
example:
start_date: '2024-06-12T23:24:15.373Z'
responses:
'201':
$ref: '#/components/responses/Created'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
security:
- BearerAuth: []
components:
responses:
Created:
description: Resource created successfully
content:
application/json:
schema:
type: object
Success:
description: Successful response
content:
application/json:
schema:
type: object
Unauthorized:
description: Unauthorized - authentication required
NotFound:
description: Not found - resource does not exist
Forbidden:
description: Forbidden - insufficient permissions
InternalServerError:
description: Internal server error
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: Personal access token issued from the Zenodo account settings