openapi: 3.0.0
info:
  version: 0.0.1
  title: Nebraska Activity Login API
  description: Nebraska is an update manager.
  contact:
    name: Flatcar Container Linux
    email: maintainers@flatcar-linux.org
    url: http://flatcar.org
tags:
- name: Login
paths:
  /login/cb:
    get:
      operationId: loginCb
      description: GitHub OAuth callback (GitHub mode only)
      security: []
      responses:
        '200':
          description: OAuth callback processed successfully
        '302':
          description: Redirect to originally requested URL
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
        '501':
          description: Not implemented for OIDC auth mode
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
      tags:
      - Login
  /login/validate_token:
    get:
      operationId: validateToken
      description: validate JWT access token (OIDC mode only)
      security: []
      responses:
        '200':
          description: validate token response
        '401':
          description: invalid or expired token
        '501':
          description: Not implemented for GitHub auth mode
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
      tags:
      - Login
  /login/webhook:
    post:
      operationId: loginWebhook
      description: GitHub webhook (GitHub mode only)
      security: []
      parameters:
      - in: header
        name: X-Hub-Signature
        required: true
        schema:
          type: string
      - in: header
        name: X-Github-Event
        required: true
        schema:
          type: string
      responses:
        '200':
          description: login webhook response
        '501':
          description: Not implemented for OIDC auth mode
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
      tags:
      - Login
components:
  schemas:
    errorResponse:
      type: object
      required:
      - error
      - description
      properties:
        error:
          type: string
          description: Error code identifier
        description:
          type: string
          description: Human-readable error description
        docs:
          type: string
          description: Link to documentation (optional)
  securitySchemes:
    oidcBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    oidcCookieAuth:
      type: apiKey
      in: cookie
      name: oidc
    githubCookieAuth:
      type: apiKey
      in: cookie
      name: github