Merge branch 'main' into overrides

Author: devalog

.github/workflows/check-links.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Install link checker
         run: pip install linkchecker
       - name: Create config
-        run: echo -e "[csv]\nseparator=,\n[filtering]\nignore=\n\texample.com\n\tus.i.posthog.com\n\tc.vialoops.com/CL0\n[output]\nignoreerrors=\n  ^http ^403 Forbidden" > lcconfig
+        run: echo -e "[csv]\nseparator=,\n[filtering]\nignore=\n\texample.com\n\tus.i.posthog.com\n\tdocs.stack-auth.com\n\t/_vercel/(speed-)?insights/\n\tc.vialoops.com/CL0\n[output]\nignoreerrors=\n  ^http ^403 Forbidden" > lcconfig
       - name: Check ${{ matrix.site.name }} Links
         run: |
           set +e

.github/workflows/update-versions.yml

@@ -26,6 +26,8 @@ jobs:
         run: curl -s "https://registry.hub.docker.com/v2/repositories/fernapi/fern-ruby-sdk/tags" | jq -r -j '[.results[] | select(.name != "latest")] | .[0].name' > fern/snippets/version-number-ruby.mdx
       - name: update-ts-version
         run: curl -s "https://registry.hub.docker.com/v2/repositories/fernapi/fern-typescript-sdk/tags" | jq -r -j '[.results[] | select(.name != "latest")] | .[0].name' > fern/snippets/version-number-ts.mdx
+      - name: update-swift-version
+        run: curl -s "https://registry.hub.docker.com/v2/repositories/fernapi/fern-swift-sdk/tags" | jq -r -j '[.results[] | select(.name != "latest")] | .[0].name' > fern/snippets/version-number-swift.mdx
       - name: create PR
         id: cpr
         uses: peter-evans/create-pull-request@v7

README.md

@@ -54,6 +54,7 @@ Keep the following principles in mind:
 - **Use [Fern’s documentation components](https://buildwithfern.com/learn/docs/writing-content/components/overview)** whenever you can.
 - **When editing an existing page** - Match the existing heading structure, tone, and level of detail to ensure your changes integrate as seamlessly as possible.
 - **Use diagrams when it makes sense** – Show, don't tell! Use [Mermaid](https://buildwithfern.com/learn/docs/writing-content/markdown#diagrams), a Markdown-like diagramming syntax, to illustrate a workflow. 
+- [**Use sentence case**](https://developers.google.com/style/capitalization) for page and section headings. 
 
 > "Break any of these rules sooner than say anything outright barbarous."
 > 

fern/apis/fai/definition/commons.yml

@@ -7,3 +7,10 @@ errors:
   InternalError:
     status-code: 401
     type: string
+
+types:
+  Pagination:
+    properties:
+      total: integer
+      page: integer
+      limit: integer

fern/apis/fai/definition/document.yml

@@ -40,7 +40,59 @@ service:
             authed:
               type: optional<boolean>
               docs: Whether the document is authed
-      response: CreateDocumentResponse
+      response: DocumentIdResponse
+      errors:
+        - commons.BadRequestError
+        - commons.InternalError
+    
+    updateDocument:
+      docs: Update a document for a given domain
+      path: /{domain}/{document_id}
+      method: PATCH
+      audiences:
+        - customers
+      path-parameters:
+        domain: string
+        document_id: string
+      request:
+        name: UpdateDocumentRequest
+        body:
+          properties:
+            document:
+              type: optional<string>
+              docs: The content of the document that will be returned in the tool response.
+            chunk:
+              type: optional<string>
+              docs: The chunk of the document that will be indexed as a vector.
+            title:
+              type: optional<string>
+              docs: The title of the document
+            url:
+              type: optional<string>
+              docs: The url of the document
+            version:
+              type: optional<string>
+              docs: The version of the document
+            keywords:
+              type: optional<list<string>>
+              docs: The keywords of the document
+            authed:
+              type: optional<boolean>
+              docs: Whether the document is authed
+      response: Document
+      errors:
+        - commons.BadRequestError
+        - commons.InternalError
+
+    deleteDocumentById:
+      docs: Delete a document for a given domain
+      path: /{domain}/{document_id}
+      method: DELETE
+      audiences:
+        - customers
+      path-parameters:
+        domain: string
+        document_id: string
       errors:
         - commons.BadRequestError
         - commons.InternalError
@@ -60,7 +112,7 @@ service:
         - commons.InternalError
 
 types:
-  CreateDocumentResponse:
+  DocumentIdResponse:
     properties:
       document_id: string
 

fern/apis/fai/definition/guidance.yml

@@ -25,6 +25,7 @@ service:
             document:
               type: string
               docs: The content of the guidance document that will be returned in the tool response
+      response: GuidanceIdResponse
       errors:
         - commons.BadRequestError
         - commons.InternalError
@@ -101,6 +102,10 @@ service:
         - commons.InternalError
 
 types:
+  GuidanceIdResponse:
+    properties:
+      guidance_id: string
+
   Guidance:
     properties:
       guidance_id: string
@@ -113,10 +118,4 @@ types:
   GuidanceList:
     properties:
       guidances: list<Guidance>
-      pagination: Pagination
-
-  Pagination:
-    properties:
-      total: integer
-      page: integer
-      limit: integer
+      pagination: commons.Pagination

fern/products/api-def/api-def.yml

@@ -16,7 +16,10 @@ navigation:
       - page: Authentication
         path: ./openapi-pages/auth.mdx
       - page: Servers
-        path: ./openapi-pages/servers.mdx            
+        path: ./openapi-pages/servers.mdx   
+      - page: Automation
+        path: ./openapi-pages/automation.mdx  
+        slug: sync-your-open-api-specification        
       - section: Endpoints
         slug: endpoints
         contents:
@@ -62,12 +65,7 @@ navigation:
           - page: Schema names
             path: ./openapi-pages/extensions/schema-names.mdx
           - page: Server names
-            path: ./openapi-pages/extensions/server-names.mdx
-      - section: Workflow & automation
-        skip-slug: true
-        contents:
-          - page: Sync your OpenAPI specification
-            path: ./openapi-pages/automation.mdx            
+            path: ./openapi-pages/extensions/server-names.mdx         
       - section: Integrate your server framework
         slug: frameworks
         contents:

fern/products/api-def/asyncapi-def.yml

@@ -1,4 +1,5 @@
 navigation:
   - page: AsyncAPI Definition Redirect Page
     path: ./pages/asyncapi-empty.mdx
-    slug: empty-page
+    slug: empty-page
+    hidden: true

fern/products/api-def/asyncapi-pages/extensions/overview.md

@@ -13,13 +13,13 @@ The table below shows all available extensions and links to detailed documentati
 
 | Extension | Description |
 | --- | --- |
-| [`x-fern-ignore`](./ignore) | Skip reading specific operations, channels, or schemas |
-| [`x-fern-examples`](./examples) | Provide additional examples for better SDK documentation |
+| [`x-fern-ignore`](./ignoring-elements) | Skip reading specific operations, channels, or schemas |
+| [`x-fern-examples`](./request-response-examples) | Provide additional examples for better SDK documentation |
 | [`x-fern-pagination`](./pagination) | Configure pagination for operations that return multiple results |
-| [`x-fern-retry`](./retry) | Configure retry behavior for operations |
-| [`x-fern-streaming`](./streaming) | Mark operations as streaming for appropriate SDK generation |
+| [`x-fern-retry`](./retry-behavior) | Configure retry behavior for operations |
+| [`x-fern-streaming`](./streaming-operations) | Mark operations as streaming for appropriate SDK generation |
 | [`x-fern-error-handling`](./error-handling) | Configure error handling for operations |
-| [`x-fern-server-name`](./server-name) | Specify custom names for servers |
+| [`x-fern-server-name`](./server-names) | Specify custom names for servers |
 | [`x-fern-availability`](./availability) | Mark features as available in specific SDK versions |
 
 <Note title="Request a new extension">

fern/products/api-def/ferndef-def.yml

@@ -1,4 +1,5 @@
 navigation:
   - page: Fern Definition Redirect Page
     path: ./pages/ferndef-empty.mdx
-    slug: empty-page
+    slug: empty-page
+    hidden: true