express-generator-typescript-k8s/lib/openAPI/src/api.yaml

Generate a new Express applications similar to express-generate with Kubernetes client and Typescript configured.

openapi: 3.0.0
info:
  title: Sample API
  description: Example API descriptor of REST endpoints. HTTP calls to these endpoints will subsequently call the Kubernetes API.
  version: 1.0.1
servers:
  - url: /api
    description: This server
paths:
  /deployments:
    get:
      summary: Returns a list of Deployment resources in the curently active k8s cluster.
      responses:
        '200':
          description: A JSON array of user deployments
          content:
            application/json:
              schema: 
                type: array
                items: 
                  $ref: '#/components/schemas/Deployment'
  /deployments/{name}:
    delete:
      summary: Deletes the deployment with given name in k8s cluster. Must be in the default namespace.
      responses:
        '200':
          description: OK
components:
  schemas:
    Deployment:
      type: object
      properties:
        name:
          type: string
        image:
          type: string
        replicas:
          type: integer
      example:
        name: coredns
        image: k8s.gcr.io/coredns:1.6.5
        replicas: 2