https://github.com/ndlano/audio-api

DEPRECATED! Moved into the backend monorepo: https://github.com/NDLANO/backend. API for accessing audio
https://github.com/ndlano/audio-api

audio elasticsearch

Last synced: about 5 hours ago
JSON representation

DEPRECATED! Moved into the backend monorepo: https://github.com/NDLANO/backend. API for accessing audio

• Host: GitHub
• URL: https://github.com/ndlano/audio-api
• Owner: NDLANO
• License: gpl-3.0
• Created: 2016-09-19T12:26:03.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-12-22T06:32:03.000Z (almost 3 years ago)
• Last Synced: 2024-04-10T18:10:58.194Z (7 months ago)
• Topics: audio, elasticsearch
• Language: Scala
• Homepage:
• Size: 984 KB
• Stars: 0
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# audio-api

![CI](https://github.com/NDLANO/audio-api/workflows/CI/badge.svg)

## Usage

API for accessing audio from NDLA. Adds, lists and/or returns an `Audio` file with metadata. Implements Elasticsearch for search within the audio database.

To interact with the api, you need valid security credentials.

To write data to the api, you need write role access.

### Avaliable Endpoints

- `GET /audio-api/v1/audio/` - Fetch a json-object containing a *list* with *all audio files available*.

- `GET /audio-api/v1/audio/` - Fetch a json-object containing the *audio id* of the *audio file* that needs to be fecthed.

- `POST /audio-api/v1/audio/` - Upload a *new audio file* provided with metadata.

- `PUT /audio-api/v1/audio/` - Update the *audio file* provided with metadata.

- `GET /audio-api/v1/series/` - Fetch a json-object containing a *list* with *all podcast series available*.

- `GET /audio-api/v1/series/` - Fetch a json-object containing the *series id* of the *podcast series* that needs to be fecthed.

- `POST /audio-api/v1/series/` - Upload a *new podcast series* provided with metadata.

- `PUT /audio-api/v1/series/` - Update the *podcast series* provided with metadata.

For a more detailed documentation of the API, please refer to the [API documentation](https://api.ndla.no) (Staging: [API documentation](https://staging.api.ndla.no)).

## Developer documentation

**Compile:** sbt compile

**Run tests:** sbt test

**Create Docker Image:**./build.sh