chore: Include 'Bearer' in authorization header documentation

Author: bdbyrne

fern/apis/beta/openapi-beta.yaml

@@ -27997,7 +27997,7 @@ components:
     auth-token:
       type: http
       description: |-
-        All the DevRev APIs require a token to authenticate the user. Provide `Authorization: <token>` as a header to every API request.
+        All the DevRev APIs require a token to authenticate the user. Provide `Authorization: Bearer <TOKEN>` as a header to every API request.
          [How do I find my token?](https://devrev.ai/docs/apis/auth)
       scheme: bearer
       x-fern-bearer:

fern/apis/public/openapi-public.yaml

@@ -16021,7 +16021,7 @@ components:
     auth-token:
       type: http
       description: |-
-        All the DevRev APIs require a token to authenticate the user. Provide `Authorization: <token>` as a header to every API request.
+        All the DevRev APIs require a token to authenticate the user. Provide `Authorization: Bearer <TOKEN>` as a header to every API request.
          [How do I find my token?](https://devrev.ai/docs/apis/auth)
       scheme: bearer
       x-fern-bearer:

fern/docs/pages/create-accounts.mdx

@@ -19,7 +19,7 @@ flowchart TD
 acct-create[accounts.create]
 exist(((Account is existing
 'account ID')))
-list[rev-orgs.list with 
+list[rev-orgs.list with
 'account' filter]
 get[rev-orgs.get with
 'account ID']
@@ -52,7 +52,7 @@ The payload to make a request is given below:
    curl --location 'https://api.devrev.ai/accounts.create' \
     --header 'Content-Type: application/json' \
     --header 'Accept: application/json' \
-    --header 'Authorization: <PAT>' \
+    --header 'Authorization: Bearer <PAT>' \
     --data '{
         "display_name": "John Doe"
         }'
@@ -126,7 +126,7 @@ The payload to make a request is given below:
    }
    ```
 
-The response contains `"external_ref": "don:identity:dvrv-us-1:devo/<devo-id>:account/<acc-id>",`. The `external_ref` identifies the `devo` ID (Dev organization ID) as `devo/<devo-id>` and the `account` ID as `account/<acc-id>`. 
+The response contains `"external_ref": "don:identity:dvrv-us-1:devo/<devo-id>:account/<acc-id>",`. The `external_ref` identifies the `devo` ID (Dev organization ID) as `devo/<devo-id>` and the `account` ID as `account/<acc-id>`.
 
 1. Check **Customers > Accounts** in the DevRev app to confirm that that account was created.
 
@@ -139,19 +139,19 @@ To create a contact associated with the account you created, follow the steps li
 Get the default rev org created along with the newly created account using the `rev-orgs.list` API:
 
     1. Make a GET/POST request to "https://api.devrev.ai/rev-orgs.list" using cURL with the `account` filter. Use the `external_ref` from the previous response as an `account` filter.
-    
+
        ```bash
         curl -X POST https://api.devrev.ai/rev-orgs.list \
-            -H "Authorization: <apiKey>" \
+            -H "Authorization: Bearer <apiKey>" \
             -H "Content-Type: application/json" \
             -d '{"account": [
                     "<external reference of the account>"
                 ]
             }'
        ```
-    
+
        It returns the following response:
-    
+
        ```json focus={19}
        {
          "rev_orgs": [
@@ -189,26 +189,26 @@ Get the default rev org created along with the newly created account using the `
          ]
        }
        ```
-    
+
        Note the `display_id` (example: `REV-abcd`) of the rev org from the response.
 
 - If there is an existing account then you can get the default rev org using the `rev-orgs.get` API:
 
     - Make a GET request to "https://api.devrev.ai/rev-orgs.get" using cURL with the `account` filter.
-    
+
        ```bash
           curl -G https://api.devrev.ai/rev-orgs.get \
-               -H "Authorization: <apiKey>" \
+               -H "Authorization: Bearer <apiKey>" \
                -d account=ACC-12345 \
        ```
-    
+
 2. Make a POST request to "https://api.devrev.ai/rev-users.create" to create a rev-user.
 
    In the request, set `rev_org` to the value of the `display_id` from the previous reponse.
 
    ```bash
     curl -X POST https://api.devrev.ai/rev-users.create \
-        -H "Authorization: <apiKey>" \
+        -H "Authorization: Bearer <apiKey>" \
         -H "Content-Type: application/json" \
         -d '{
             "rev_org": "<rev org display-id>"

fern/docs/pages/custom-objects.mdx

@@ -29,7 +29,7 @@ All DevRev objects require a schema. First, create a schema for the "Campaign" c
 curl --location 'https://api.devrev.ai/schemas.custom.set' \
 --header 'Content-Type: application/json' \
 --header 'Accept: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "type": "tenant_fragment",
     "description": "Attributes for Campaign",
@@ -79,7 +79,7 @@ Once the schema is created, you can create a custom object of type "Campaign":
 curl --location 'https://api.devrev.ai/custom-objects.create' \
 --header 'Content-Type: application/json' \
 --header 'Accept: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "leaf_type": "campaign",
     "unique_key": "CAMP-001",
@@ -135,7 +135,7 @@ To get a custom object, use the `custom-objects.get` endpoint:
 curl --location 'https://api.devrev.ai/custom-objects.get' \
 --header 'Content-Type: application/json' \
 --header 'Accept: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "id": "don:core:dvrv-us-1:devo/demo:custom_object/campaign/1"
 }'
@@ -149,7 +149,7 @@ To list custom objects, use the `custom-objects.list` endpoint:
 curl --location 'https://api.devrev.ai/custom-objects.list' \
 --header 'Content-Type: application/json' \
 --header 'Accept: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "leaf_type": "campaign",
     "filter": [
@@ -169,7 +169,7 @@ following example updates the budget of the previously created campaign custom o
 curl --location 'https://api.devrev.ai/custom-objects.update' \
 --header 'Content-Type: application/json' \
 --header 'Accept: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "id": "don:core:dvrv-us-1:devo/demo:custom_object/campaign/1",
     "custom_fields": {
@@ -187,7 +187,7 @@ The following example deletes the previously created campaign custom object:
 curl --location 'https://api.devrev.ai/custom-objects.delete' \
 --header 'Content-Type: application/json' \
 --header 'Accept: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "id": "don:core:dvrv-us-1:devo/demo:custom_object/campaign/1"
 }'
@@ -204,7 +204,7 @@ in the account tenant schema.
 curl --location 'https://api.devrev.ai/schemas.custom.set' \
 --header 'Content-Type: application/json' \
 --header 'Accept: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "type": "tenant_fragment",
     "description": "Tenant attributes for Account",
@@ -234,7 +234,7 @@ campaign custom object with subtype "social_media", you can do so as follows:
 curl --location 'https://api.devrev.ai/custom-objects.create' \
 --header 'Content-Type: application/json' \
 --header 'Accept: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "leaf_type": "campaign",
     "custom_schema_spec": {
@@ -253,4 +253,3 @@ curl --location 'https://api.devrev.ai/custom-objects.create' \
     "unique_key": "CAMP-001"
 }'
 ```
-

fern/docs/pages/customization.mdx

@@ -61,7 +61,7 @@ Make sure to replace `<TOKEN>` with your API token.
 ```curl
 curl --location 'https://api.devrev.ai/schemas.custom.set' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "type": "custom_type_fragment",
     "description": "Attributes for tracking a bug",
@@ -105,7 +105,7 @@ _bug_-flavored _issue_ object to track it and assigns a relevant owner.
 ```curl {11-17}
 curl --location 'https://api.devrev.ai/works.create' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "type": "issue",
     "title": "API failure in Prod",
@@ -138,7 +138,7 @@ a subtype-specific field.
 ```curl
 curl --location 'https://api.devrev.ai/schemas.custom.set' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "type": "tenant_fragment",
     "description": "Tenant attributes for issues",
@@ -160,7 +160,7 @@ Populate the release notes in the issue object created above:
 ```curl {8-13}
 curl --location 'https://api.devrev.ai/works.update' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "id": "don:core:dvrv-us-1:devo/test:issue/1",
     "type": "issue",
@@ -239,7 +239,7 @@ to `true` and _impacted_environments_ containing `"Prod"`.
 ```curl
 curl --location 'https://api.devrev.ai/works.list' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "type": [ "issue" ],
     "issue": {
@@ -275,7 +275,7 @@ and delete the _regression_ field.
 ```curl {28-36}
 curl --location 'https://api.devrev.ai/schemas.custom.set' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "type": "custom_type_fragment",
     "description": "Attributes for tracking a bug",
@@ -359,7 +359,7 @@ _regression_ field is dropped in the response.
 ```curl {16-18, 21}
 curl --location 'https://api.devrev.ai/works.get' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "id": "don:core:dvrv-us-1:devo/test:issue/2"
 }'
@@ -414,7 +414,7 @@ organization:
 ```curl
 curl --location 'https://api.devrev.ai/schemas.custom.list' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>'
+--header 'Authorization: Bearer <TOKEN>'
 ```
 
 Deprecated fragments aren't listed in the response.
@@ -458,7 +458,7 @@ fragment with the following payload:
 ```curl
 curl --location 'https://api.devrev.ai/internal/schemas.custom.set' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
   "type": "tenant_fragment",
   "leaf_type": "issue",
@@ -540,7 +540,7 @@ You want to add a new stage _Needs RCA_ to the _bug_ subtype.
 ```curl
 curl --location 'https://api.devrev.ai/stages.custom.create' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "name": "Needs RCA",
     "state": "closed",
@@ -581,7 +581,7 @@ backl --> dev --> rca --> compl
 ```curl {11}
 curl --location 'https://api.devrev.ai/stage-diagrams.create' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "leaf_type": "issue",
     "subtype": "bug",
@@ -629,7 +629,7 @@ The stage diagram created above can be referenced in the _bug_ subtype as follow
 ```curl {9}
 curl --location 'https://api.devrev.ai/schemas.custom.set' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "type": "custom_type_fragment",
     "leaf_type": "issue",
@@ -654,7 +654,7 @@ _completed_ stage by adding a dependent field constraint.
 ```curl {12-22}
 curl --location 'https://api.devrev.ai/schemas.custom.set' \
 --header 'Content-Type: application/json' \
---header 'Authorization: <TOKEN>' \
+--header 'Authorization: Bearer <TOKEN>' \
 --data '{
     "type": "custom_type_fragment",
     "leaf_type": "issue",

fern/docs/pages/interact-agent.mdx

@@ -7,7 +7,7 @@ The DevRev async API enables you to execute agents without any execution timeout
 - Ability to handle long-running agent tasks.
 
 <Callout type="note">
-  In any unlikely and unforeseen circumstances, if an individual operation of the workflow times out, you do not receive an error event right now to notify that you should not wait for any more messages. It is better to have a client side timeout for now while the issue is brainstormed and fixed for you. 
+  In any unlikely and unforeseen circumstances, if an individual operation of the workflow times out, you do not receive an error event right now to notify that you should not wait for any more messages. It is better to have a client side timeout for now while the issue is brainstormed and fixed for you.
 </Callout>
 
 ## Set up webhook
@@ -18,7 +18,7 @@ Before using the async API, you need to create a webhook to receive agent execut
   ```bash
   curl --location 'https://api.devrev.ai/internal/webhooks.create' \
   --header 'Content-Type: application/json' \
-  --header 'Authorization: <YOUR_API_TOKEN>' \
+  --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
   --data '{
       "url": "https://your-application.com/webhook-endpoint",
       "event_types": ["ai_agent_response"],
@@ -86,7 +86,7 @@ You should follow the documentation provided for webhooks [here](https://develop
   curl --location 'https://api.devrev.ai/internal/ai-agents.events.execute-async' \
   --header 'Content-Type: application/json' \
   --header 'Accept: application/json' \
-  --header 'Authorization: <YOUR_API_KEY>' \
+  --header 'Authorization: Bearer <YOUR_API_KEY>' \
   --data '{
     "agent": "don:core:dvrv-us-1:devo/0:ai_agent/1",
     "event": {
@@ -131,7 +131,7 @@ You should follow the documentation provided for webhooks [here](https://develop
         }
       })
     });
-    
+
     return await response.json();
   };
   ```
@@ -276,7 +276,7 @@ function handleUserMessage(message) {
     method: "POST",
     headers: {
       "Content-Type": "application/json",
-      Authorization: "YOUR_API_KEY",
+      Authorization: Bearer "YOUR_API_KEY",
     },
     body: JSON.stringify({
       agent: "your_agent_id",
@@ -342,7 +342,7 @@ If you're using DevRev workflows:
   Agent node.
 </Callout>
 
-1. Add the "Talk To Agent" node to your workflow 
+1. Add the "Talk To Agent" node to your workflow
 2. Configure it with your agent ID
 3. Connect it to response nodes to process the agent's output
 4. The async API is used automatically by the workflow engine

fern/docs/pages/timeline-entries.mdx

@@ -9,7 +9,7 @@ You can use this to send any information about a customer like their last logged
 
 To send a restricted visibility message, follow the steps listed below:
 
-The payload to make a request would look like given below: 
+The payload to make a request would look like given below:
 
 <CodeBlock title="Payload">
 ```json {4-6}
@@ -20,12 +20,12 @@ The payload to make a request would look like given below:
         "private_to": [<list of user IDs>],
         "type": "timeline_comment"
     }
-``` 
+```
 </CodeBlock>
 
 * `object` must be of type string and contains `<partition>`, `<dev-org-id>`, and `<object-id>`.
 * `body` is of type string and contains the actual message to be posted.
-* `visibility` is set to `private` in order for the message to be visible only to users, `internal` is visible with the Dev organization, `external` is visible to the Dev organzation and customers, and `public` is visible to all. 
+* `visibility` is set to `private` in order for the message to be visible only to users, `internal` is visible with the Dev organization, `external` is visible to the Dev organzation and customers, and `public` is visible to all.
 * `type` should be `timeline_comment`.
 
 1. Get the [object ID](/api-reference/getting-started) and object type where you want to send a message.
@@ -44,15 +44,15 @@ In this example, you are using curl to make the requests but you can use any too
 
 <CodeBlock title="Request">
 ```bash
-curl -X POST -H "Content-Type: application/json" -d 
+curl -X POST -H "Content-Type: application/json" -d
 '{
     "object": "don:core:<partition>:devo/<dev-org-id>:<object-type>/<object-id>",
     "body": "message",
     "visibility": "private",
     "type": "timeline_comment"
-}' 
+}'
 'https://api.devrev.ai/timeline-entries.create' \
---header 'Authorization: <PAT>'
+--header 'Authorization: Bearer <PAT>'
 ```
 </CodeBlock>