chore: Update OpenAPI specs (#141)

Author: bdbyrne

.github/workflows/changelog.yml

@@ -12,6 +12,10 @@ jobs:
     - name: Get current date
       id: date
       run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
+    - name: Check out repository content
+      uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.pull_request.head.ref }}
     - name: Check out HEAD rev
       uses: actions/checkout@v2
       with:
@@ -38,17 +42,26 @@ jobs:
         base: 'base/fern/apis/beta/openapi-beta.yaml'
         revision: 'head/fern/apis/beta/openapi-beta.yaml'  
         format: text
-        output-to-file: 'changelog/beta/${{ steps.date.outputs.date }}_oasdiff.md'
-    - name: Prompt
-      run: |
-        python changelog.py --date ${{ steps.date.outputs.date }}
-        git config user.name github-actions
-        git config user.email [email protected]
-        git add fern/apis/*/changelog
-        git commit -m "generated by Claude"
-        git push
+        output-to-file: 'temp/beta/${{ steps.date.outputs.date }}_oasdiff.md'
     - name: Archive changelogs
       uses: actions/upload-artifact@v4
       with:
         name: changelog-${{ steps.date.outputs.date }}
         path: temp/**
+    - name: Prompt
+      env:
+          LLM_JWT: ${{ secrets.LLM_JWT }} 
+      run: |
+        logfiles="fern/apis/*/changelog/${{ steps.date.outputs.date }}.md"
+
+        if ls $logfiles >/dev/null 2>&1; then
+          logfiles=($logfiles)
+          echo "${logfiles[@]} already exist."
+        else
+          python changelog.py --date ${{ steps.date.outputs.date }}
+          git config user.name github-actions
+          git config user.email [email protected]
+          git add fern/apis/*/changelog/${{ steps.date.outputs.date }}.md
+          git commit -m "generated by Claude"
+          git push
+        fi

changelog.py

@@ -27,28 +27,31 @@ def main(vrn, d):
 
 def gen_log(prompt):
 
-    log = None
     auth = os.environ.get('LLM_JWT')
-    headers = {"Content-Type": "application/json", "Authorization": f"Bearer {auth}"}
-    payload = {
-        "model": "us.anthropic.claude-3-5-sonnet-20241022-v2:0",
-        "messages": [
-            {
-                "role": "user",
-                "content": prompt
-            }
-        ]
-    }
-
-    try:
-        r = requests.post('https://openwebui.dev.devrev-eng.ai/api/chat/completions', json=payload,
-                            headers=headers)
-        log = r.json()['choices'][0]['message']['content']
-        log = re.sub(r"^Here's.*\n?", '', log, flags=re.MULTILINE)
-        log = re.sub(r"^Let me know.*\n?", '', log, flags=re.MULTILINE)
-    except Exception as e:
-        print(
-            f"Failed to generate changelog. Error: {type(e)} {e} {r}")
+    if auth:
+        headers = {"Content-Type": "application/json", "Authorization": f"Bearer {auth}"}
+        payload = {
+            "model": "us.anthropic.claude-3-5-sonnet-20241022-v2:0",
+            "messages": [
+                {
+                    "role": "user",
+                    "content": prompt
+                }
+            ]
+        }
+
+        try:
+            r = requests.post('https://openwebui.dev.devrev-eng.ai/api/chat/completions', json=payload,
+                                headers=headers)
+            log = r.json()['choices'][0]['message']['content']
+            log = re.sub(r"^Here's.*\n?", '', log, flags=re.MULTILINE)
+            log = re.sub(r"^Let me know.*\n?", '', log, flags=re.MULTILINE)
+        except Exception as e:
+            print(
+                f"Failed to generate changelog. Error: {type(e)} {e} {r}")
+    else:
+        log = "No auth token"
+        
     return log
 
 

fern/apis/beta/changelog/2025-01-17.md

@@ -0,0 +1,40 @@
+
+# API Changelog
+
+## Links
+- Added support for meetings in link objects - `type` enum now includes `meeting` value
+- This affects the following endpoints:
+  - [`/links.create`](/beta/api-reference/links/create)
+  - [`/links.get`](/beta/api-reference/links/get-post)
+  - [`/links.list`](/beta/api-reference/links/list-post)
+
+## SLA
+### SLA Trackers
+- Added new property `applies_to_type` to SLA tracker objects 
+- Added new property `completed_at` to metric target summaries
+- This affects the following endpoints:
+  - [`/sla-trackers.get`](/beta/api-reference/slas/sla-trackers-get-post)
+  - [`/sla-trackers.list`](/beta/api-reference/slas/sla-trackers-list-post)
+
+### SLAs
+- Added new property `account_filter` to SLA objects
+- This affects the following endpoints:
+  - [`/slas.create`](/beta/api-reference/slas/create)
+  - [`/slas.get`](/beta/api-reference/slas/get-post)
+  - [`/slas.list`](/beta/api-reference/slas/list-post)
+  - [`/slas.transition`](/beta/api-reference/slas/transition)
+  - [`/slas.update`](/beta/api-reference/slas/update)
+
+## Works
+- Added new query parameter `state` for filtering works
+- This affects the following endpoints:
+  - [`/works.export`](/beta/api-reference/works/export-post)
+  - [`/works.list`](/beta/api-reference/works/list-post)
+
+The changes are primarily focused on:
+1. Adding support for meetings in link objects
+2. Enhancing SLA tracking capabilities with new properties
+3. Adding account filtering to SLAs  
+4. Adding state filtering capability for works endpoints
+
+All modified endpoints continue to maintain backward compatibility while adding these new capabilities.

fern/apis/beta/openapi-beta.yaml

@@ -891,6 +891,11 @@ components:
             a different policy starting to apply.
           example: "2023-01-01T12:00:00.000Z"
           format: date-time
+        completed_at:
+          type: string
+          description: The time at which the metric completed at.
+          example: "2023-01-01T12:00:00.000Z"
+          format: date-time
         completed_in:
           type: integer
           description: |
@@ -9923,6 +9928,7 @@ components:
           feature: '#/components/schemas/feature-summary'
           incident: '#/components/schemas/incident-summary'
           issue: '#/components/schemas/issue-summary'
+          meeting: '#/components/schemas/meeting-summary'
           opportunity: '#/components/schemas/opportunity-summary'
           product: '#/components/schemas/product-summary'
           rev_org: '#/components/schemas/rev-org-summary'
@@ -9939,6 +9945,7 @@ components:
         - $ref: '#/components/schemas/feature-summary'
         - $ref: '#/components/schemas/incident-summary'
         - $ref: '#/components/schemas/issue-summary'
+        - $ref: '#/components/schemas/meeting-summary'
         - $ref: '#/components/schemas/opportunity-summary'
         - $ref: '#/components/schemas/product-summary'
         - $ref: '#/components/schemas/rev-org-summary'
@@ -9962,6 +9969,7 @@ components:
         - feature
         - incident
         - issue
+        - meeting
         - opportunity
         - product
         - rev_org
@@ -15013,6 +15021,11 @@ components:
         - $ref: '#/components/schemas/atom-base'
         - type: object
           properties:
+            account_filter:
+              type: object
+              description: |
+                A set of account attributes that must be satisfied for the SLA to
+                apply. AND applies between each field.
             compensation:
               $ref: '#/components/schemas/sla-compensation'
             description:
@@ -15166,6 +15179,8 @@ components:
             applies_to_id:
               type: string
               description: Details of the object on which the SLA is being tracked.
+            applies_to_type:
+              $ref: '#/components/schemas/sla-tracker-applies-to-type'
             metric_target_summaries:
               type: array
               description: |
@@ -15196,9 +15211,20 @@ components:
           required:
             - metric_target_summaries
       title: sla-tracker
+    sla-tracker-applies-to-type:
+      type: string
+      description: The type of the object on which the SLA is being tracked.
+      enum:
+        - conversation
+        - issue
+        - ticket
     sla-tracker-summary:
       allOf:
         - $ref: '#/components/schemas/atom-base-summary'
+        - type: object
+          properties:
+            applies_to_type:
+              $ref: '#/components/schemas/sla-tracker-applies-to-type'
       title: sla-tracker-summary
     sla-trackers-get-request:
       type: object
@@ -19483,6 +19509,11 @@ components:
           $ref: '#/components/schemas/stage-filter'
         staged_info:
           $ref: '#/components/schemas/staged-info-filter'
+        state:
+          type: array
+          description: Filters for work with any of the provided states.
+          items:
+            type: string
         sync_metadata:
           $ref: '#/components/schemas/sync-metadata-filter'
         tags:
@@ -19728,6 +19759,11 @@ components:
           $ref: '#/components/schemas/stage-filter'
         staged_info:
           $ref: '#/components/schemas/staged-info-filter'
+        state:
+          type: array
+          description: Filters for work with any of the provided states.
+          items:
+            type: string
         sync_metadata:
           $ref: '#/components/schemas/sync-metadata-filter'
         tags:
@@ -35638,6 +35674,14 @@ paths:
           name: staged_info.is_staged
           schema:
             type: boolean
+        - description: Filters for work with any of the provided states.
+          explode: false
+          in: query
+          name: state
+          schema:
+            type: array
+            items:
+              type: string
         - description: Filters for issues with this specific external reference.
           explode: false
           in: query
@@ -36113,6 +36157,14 @@ paths:
           name: staged_info.is_staged
           schema:
             type: boolean
+        - description: Filters for work with any of the provided states.
+          explode: false
+          in: query
+          name: state
+          schema:
+            type: array
+            items:
+              type: string
         - description: Filters for issues with this specific external reference.
           explode: false
           in: query

fern/apis/public/changelog/2025-01-17.md

@@ -0,0 +1,32 @@
+
+# API Changes
+
+## SLA Trackers
+The following endpoints have been updated with new properties in the SLA tracker schema:
+- [`/sla-trackers.get`](/public/api-reference/slas/sla-trackers-get-post)
+- [`/sla-trackers.list`](/public/api-reference/slas/sla-trackers-list-post)
+
+Changes:
+- Added `applies_to_type` property to SLA tracker schema
+- Added `completed_at` property to metric target summaries
+
+## SLAs 
+The following endpoints have been updated with new properties in the SLA schema:
+- [`/slas.create`](/public/api-reference/slas/create)
+- [`/slas.get`](/public/api-reference/slas/get-post)
+- [`/slas.list`](/public/api-reference/slas/list-post)
+- [`/slas.transition`](/public/api-reference/slas/transition)
+- [`/slas.update`](/public/api-reference/slas/update)
+
+Changes:
+- Added `account_filter` property to SLA schema
+
+## Works
+The following endpoints have been updated:
+- [`/works.export`](/public/api-reference/works/export-post)
+- [`/works.list`](/public/api-reference/works/list-post)
+
+Changes:
+- Added new query parameter `state` to filter works
+
+All work-related endpoints have also been updated to include the new SLA tracker schema changes mentioned above in their responses.