openapi-v2.yml

swagger: "2.0"
info:
  title: "playground-api Playground Service"
  description: "Playground Service definition hosted by Cloud Endpoints with a Cloud Run backend"
  version: "1.0.0"
host: api.ashdavies.dev
schemes:
  - "https"
consumes:
  - "application/json"
produces:
  - "application/json"
paths:
  /.well-known/assetlinks.json:
    get:
      tags: [ "static" ]
      summary: "Returns AssetLinks protocol file"
      operationId: "getAssetLinks"
      responses:
        "200":
          description: "OK"
      security: []
  /events/upcoming:
    get:
      tags: [ "events" ]
      summary: "Return upcoming events by start date"
      operationId: "getUpcomingEvents"
      parameters:
        - name: "startAt"
          in: "query"
          type: "string"
          format: "date"
          description: "The start date to start this query at."
        - name: "limit"
          in: "query"
          type: "integer"
          format: "int32"
          description: "The maximum number of items to return."
      responses:
        "200":
          description: "OK"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Event"
      security:
        - ApiKeyAuth: [ ]
          AppCheckAuth: [ ]
  /events:aggregate:
    post:
      tags: [ "events" ]
      summary: "Aggregate events from data sources"
      operationId: "aggregateEvents"
      responses:
        "200":
          description: "OK"
      security:
        - ApiKeyAuth: [ ]
          AppCheckAuth: [ ]
  /firebase/auth:
    post:
      tags: [ "firebase" ]
      summary: "Signs in or signs up a user"
      description: >
        Signs in or signs up a user by exchanging a custom Auth token for the given UID. Upon a 
        successful sign-in or sign-up, a new Identity Platform ID token and refresh token are
        issued for the user.
      operationId: "signIn"
      parameters:
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "uid"
            properties:
              uid:
                type: "string"
                description: >
                  The UID to store in the token. This identifies the user to other Firebase
                  services (Realtime Database, Firebase Auth, etc.). Should be less than 128
                  characters.
                example: "jane.smith@example.com"
      responses:
        "200":
          description: "OK"
          schema:
            $ref: "#/definitions/AuthResult"
  /firebase/token:
    post:
      tags: [ "firebase" ]
      summary: "Creates a new App Check token"
      operationId: "createToken"
      parameters:
        - name: "body"
          in: "body"
          required: true
          schema:
            $ref: "#/definitions/FirebaseApp"
      responses:
        "200":
          description: "OK"
          schema:
            $ref: "#/definitions/AppCheckToken"
  /firebase/token:verify:
    put:
      tags: [ "firebase" ]
      summary: "Verifies an App Check token"
      description: >
        Verifies a Firebase App Check token (JWT). If the token is valid, the promise is fulfilled
        with the token's decoded claims; otherwise, the promise is rejected.
      operationId: "verifyToken"
      parameters:
        - name: "X-Firebase-AppCheck"
          in: "header"
          description: "The App Check token to verify"
          required: true
          type: "string"
      responses:
        "200":
          description: "OK"
          schema:
            $ref: "#/definitions/DecodedToken"
        "400":
          description: "Request is missing app check token header"
  /hello:
    get:
      tags: [ "hello" ]
      summary: "Greet the user"
      operationId: "helloWorld"
      responses:
        "200":
          description: "OK"
definitions:
  AppCheckToken:
    type: "object"
    required:
      - "ttlMillis"
      - "token"
    properties:
      ttlMillis:
        type: "integer"
        format: "int64"
        description: "The time-to-live duration of the token in milliseconds"
      token:
        type: "string"
        description: "The Firebase App Check token"
  AuthResult:
    type: "object"
    properties:
      idToken:
        type: "string"
        description: "A Firebase Auth ID token generated from the provided custom token."
      refreshToken:
        type: "string"
        description: "A Firebase Auth refresh token generated from the provided custom token."
      expiresIn:
        type: "integer"
        format: "int64"
        description: "The number of seconds in which the ID token expires."
        example: 3600
  DecodedToken:
    type: "object"
    required:
      - "audience"
      - "expiresAt"
      - "issuedAt"
      - "subject"
      - "issuer"
      - "appId"
    properties:
      audience:
        type: "array"
        description: >
          The audience for which this token is intended. This value is a JSON array of two strings,
          the first is the project number of your Firebase project, and the second is the project
          ID of the same project.
        items:
          type: "string"
      expiresAt:
        type: "integer"
        format: "int64"
        description: >
          The App Check token's expiration time, in seconds since the Unix epoch. That is, the time
          at which this App Check token expires and should no longer be considered valid.
        example: "1672497116"
      issuedAt:
        type: "integer"
        format: "int64"
        description: >
          The App Check token's issued-at time, in seconds since the Unix epoch. That is, the time
          at which this App Check token was issued and should start to be considered valid.
        example: "1672493516"
      subject:
        type: "string"
        description: >
          The Firebase App ID corresponding to the app the token belonged to. As a convenience,
          this value is copied over to the | app_id property.
        example: "1:1234567890:android:321abc456def7890"
      issuer:
        type: "string"
        description: >
          The issuer identifier for the issuer of the response. This value is a URL with the format
          https://firebaseappcheck.googleapis.com/<PROJECT_NUMBER>, where <PROJECT_NUMBER> is the
          same project number specified in the | aud property.
        example: "https://firebaseappcheck.googleapis.com/1234567890"
      appId:
        type: "string"
        description: >
          The App ID corresponding to the App the App Check token belonged to. This value is not
          actually one of the JWT token claims. It is added as a convenience, and is set as the
          value of the | sub property.
        example: "1:1234567890:android:321abc456def7890"
  Event:
    type: "object"
    required:
      - "id"
      - "name"
      - "website"
      - "location"
      - "dateStart"
      - "dateEnd"
    properties:
      id:
        type: "string"
      name:
        type: "string"
      website:
        type: "string"
      location:
        type: "string"
      imageUrl:
        type: "string"
      status:
        type: "string"
      online:
        type: "boolean"
      dateStart:
        type: "string"
        format: "date"
      dateEnd:
        type: "string"
        format: "date"
      cfp:
        type: "object"
        properties:
          start:
            type: "string"
            format: "date"
          end:
            type: "string"
            format: "date"
          site:
            type: "string"
  FirebaseApp:
    type: "object"
    required:
      - "appId"
    properties:
      appId:
        type: "string"
        description: "The app ID to use as the JWT app_id"
        example: "1:1234567890:android:321abc456def7890"
securityDefinitions:
  ApiKeyAuth:
    name: "X-API-Key"
    type: "apiKey"
    in: "header"
  AppCheckAuth:
    name: "X-Firebase-AppCheck"
    type: "apiKey"
    in: "header"
security:
  - ApiKeyAuth: [ ]
x-google-backend:
  address: "${backend_service_name}"
  protocol: "h2"