WIP: Bug 1863077 - Add OpenAPI spec for REST APIOpen api

.github/actions/redocly-bundle/action.yaml

@@ -0,0 +1,22 @@
+name: redocly bundle
+description: "Bundle a multi-file API description to a single file."
+inputs:
+  apis:
+    description: "List of API description root filenames or names assigned in the `apis` section of your Redocly configuration file. Default values are all names defined in the `apis` section within your configuration file."
+    required: true
+  output:
+    description: "Name or folder for the bundle file. If you don't specify the file extension, `.yaml` is used by default. If the specified folder doesn't exist, it's created automatically. If the file specified as the bundler's output already exists, it's overwritten."
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/setup-node@main
+      with:
+        node-version: 20
+    - name: install redocly
+      shell: bash
+      run: npm install @redocly/cli -g
+    - name: bundle openapi spec
+      shell: bash
+      run: |
+        redocly bundle ${{ inputs.apis }} ${{ inputs.output && '--output' }} ${{ inputs.output }}

.github/workflows/openapi.yml

@@ -0,0 +1,47 @@
+name: BMO OpenAPI spec
+
+on:
+  push:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            .github
+            openapi
+
+      - name: bundle OpenAPI spec
+        uses: ./.github/actions/redocly-bundle
+        with:
+          apis: openapi/openapi.yaml
+          output: openapi/bundled.yaml
+
+      - name: install vacuum
+        run: npm i -g @quobix/vacuum
+
+      - name: run vacuum lint
+        run: vacuum lint openapi/bundled.yaml
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: bundle OpenAPI spec
+        uses: ./.github/actions/redocly-bundle
+        with:
+          apis: openapi/openapi.yaml
+          output: openapi/bundled.yaml
+
+      - name: Generate Python Client
+        uses: openapi-generators/openapitools-generator-action@v1.5.0
+        with:
+          generator: python
+          openapi-file: openapi/bundled.yaml
+          command-args: --skip-validate-spec
+          # config-file: python-generator-config.yml

.neoconf.json

@@ -0,0 +1,14 @@
+{
+    "lspconfig": {
+        "yamlls": {
+            "yaml": {
+                "schemas": {
+                     "https://github.com/OAI/OpenAPI-Specification/raw/main/schemas/v3.1/schema.json#/$defs/path-item": "openapi/paths/*.yaml",
+                     "https://github.com/OAI/OpenAPI-Specification/raw/main/schemas/v3.1/schema.json#/$defs/parameter": "openapi/components/parameters/*.yaml",
+                     "https://github.com/OAI/OpenAPI-Specification/raw/main/schemas/v3.1/schema.json#/$defs/schema": "openapi/components/schema/*.yaml",
+                     "https://json.schemastore.org/github-workflow.json": ".github/workflows/*.yml",
+                }
+            }
+        }
+    }
+}

openapi/.gitignore

@@ -0,0 +1 @@
+bundled.yaml

openapi/components/parameters/BugId.yaml

@@ -0,0 +1,9 @@
+name: id
+in: query
+description: The numeric ID of the bug.
+schema:
+  oneOf:
+    - type: integer
+    - type: array
+      items:
+        type: integer

openapi/components/parameters/BugIdOrAlias.yaml

@@ -0,0 +1,8 @@
+name: id_or_alias
+in: path
+description: A single integer bug ID or alias.
+required: true
+schema:
+  type:
+    - string
+    - integer

openapi/components/schemas/Attachment.yaml

@@ -0,0 +1,56 @@
+type: object
+properties:
+  data:
+    description: The raw data of the attachment, encoded as Base64.
+    type: string
+    format: base64
+  size:
+    description: The length (in bytes) of the attachment.
+    type: integer
+  creation_time:
+    description: The time the attachment was created.
+    type: string
+    format: date-time
+  last_change_time:
+    description: The last time the attachment was modified.
+    type: string
+    format: date-time
+  id:
+    description: The numeric ID of the attachment.
+    type: integer
+  bug_id:
+    description: The numeric ID of the bug that the attachment is attached to.
+    type: integer
+  file_name:
+    description: The file name of the attachment.
+    type: string
+  summary:
+    description: A short string describing the attachment.
+    type: string
+  content_type:
+    description: The MIME type of the attachment.
+    type: string
+  is_private:
+    description: >-
+      ``true`` if the attachment is private (only visible to a certain group
+      called the "insidergroup"), ``false`` otherwise.
+    type: boolean
+  is_obsolete:
+    description: '``true`` if the attachment is obsolete, ``false`` otherwise.'
+    type: boolean
+  is_patch:
+    description: '``true`` if the attachment is a patch, ``false`` otherwise.'
+    type: boolean
+  creator:
+    description: The login name of the user that created the attachment.
+    type: string
+  creator_detail:
+    description: An object containing detailed user information for the creator.
+    $ref: ./User.yaml
+  flags:
+    description: >-
+      Array of objects, each containing the information about the flag currently
+      set for each attachment.
+    type: array
+    items:
+      $ref: ./Flag.yaml