Commit fa089a4c authored by blackheaven's avatar blackheaven
Browse files

Initial commit

parents

.gitignore

0 → 100644
+2 −0
Original line number Diff line number Diff line 
site/

public/

.gitlab-ci.yml

0 → 100644
+24 −0
Original line number Diff line number Diff line 
# included templates

include:

  # MkDocs template

  - project: "to-be-continuous/mkdocs"

    ref: "2.1"

    file: "templates/gitlab-ci-mkdocs.yml"

  # MkDocs template (GitLab Pages variant)

  - project: "to-be-continuous/mkdocs"

    ref: "2.1"

    file: "templates/gitlab-ci-mkdocs-pages.yml"





# your pipeline stages

stages:

  - build

  - test

  - package-build

  - package-test

  - infra

  - deploy

  - acceptance

  - publish

  - infra-prod

  - production

docs/api/api.yaml

0 → 100644
+47 −0
Original line number Diff line number Diff line 
openapi: 3.1.0

info:

  version: 0.1

  title: AudioLM REST API

servers:

  - url: http://api.example.com/

paths:

  /:

    get:

      summary: default

      tags:

        - default

      responses:

        200:

          description: there's nothing here, yet

  /health:

    get:

      summary: health check

      tags:

        - health check

      responses:

        200:

          description: OK

  /text2audio:

    get:

     summary: test

     tags:

      - audio

     responses:

       200:

         description: return something message

         content:

    # https://stackoverflow.com/a/73418375

    post:

      summary: input text, output audio

      tags:

        - audio

      parameters:

        - name: text

          required: true

          schema:

            type: string

      responses:

        '200':

          description: Receive wav file after audio file generated (It takes avg 5m)

          content:

            audio/wav: {}

docs/index.md

0 → 100644
+5 −0
Original line number Diff line number Diff line 
Descrive AudioLM REST API



## Swagger UI



<swagger-ui src="./api/api.yaml"/>

mkdocs.yml

0 → 100644
+5 −0
Original line number Diff line number Diff line 
site_name: AudioLM REST API Docs

theme:

  name: material

plugins:

  - swagger-ui-tag