chore: Include 'Bearer' in authorization header documentation #247

bdbyrne · 2025-06-04T21:30:54Z

ISS-180060

github-actions · 2025-06-04T21:31:54Z

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page.

For questions or feedback, please email support@ekline.io.

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

EkLine

⚠️ [EkLine]

Consider using 'TBD' instead of 'Dev org'. (EK25033)

fern-api-docs/fern/docs/pages/webhooks.mdx

Line 9 in 28968b8

    
           associated with your Dev org. After successful registration and verification of the endpoint,

🚫 [EkLine]

'Event POST ******' should use sentence-style capitalization. (EK00037)

fern-api-docs/fern/docs/pages/webhooks.mdx

Line 44 in 28968b8

### Event POST `[json]`

⚠️ [EkLine]

In general, don't use an ellipsis. (EK00011)

fern-api-docs/fern/docs/pages/webhooks.mdx

Line 57 in 28968b8

"work_created": {...}

⚠️ [EkLine]

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/welcome.mdx

Line 44 in 28968b8

    
           Next, you'll want to set up your development environment to connect and interact with the DevRev API.

fern/docs/pages/create-accounts.mdx

github-actions · 2025-06-04T21:31:56Z

fern/docs/pages/create-accounts.mdx

@@ -139,19 +139,19 @@
 Get the default rev org created along with the newly created account using the `rev-orgs.list` API:


⚠️ [EkLine]

Consider using 'workspace' instead of 'rev org'. (EK25033)

Suggested change

Get the default rev org created along with the newly created account using the `rev-orgs.list` API:

Get the default workspace created along with the newly created account using the `rev-orgs.list` API:

github-actions · 2025-06-04T21:31:56Z

fern/docs/pages/create-accounts.mdx

@@ -189,26 +189,26 @@
         ]
       }
       ```
-    
+
       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:


⚠️ [EkLine]

Consider using 'workspace' instead of 'rev org'. (EK25033)

Suggested change

- If there is an existing account then you can get the default rev org using the `rev-orgs.get` API:

- If there is an existing account then you can get the default workspace using the `rev-orgs.get` API:

github-actions · 2025-06-04T21:31:56Z

fern/docs/pages/create-accounts.mdx

@@ -189,26 +189,26 @@
         ]
       }
       ```
-
+
       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.


⚠️ [EkLine]

Consider using 'customer' instead of 'rev'. (EK25033)

Suggested change

- Make a GET request to "https://api.devrev.ai/rev-orgs.get" using cURL with the `account` filter.

- Make a GET request to "https://api.devrev.ai/rev-orgs.get" using cURL with the `customer` filter.

github-actions · 2025-06-04T21:31:56Z

fern/docs/pages/create-accounts.mdx

               -d account=ACC-12345 \
       ```
-    
+
 2. Make a POST request to "https://api.devrev.ai/rev-users.create" to create a rev-user.


⚠️ [EkLine]

Suggestions:

Consider using 'customer' instead of 'rev'. (EK25033)
Consider using 'customer' instead of 'rev-user'. (EK25033)

Suggested change

2. Make a POST request to "https://api.devrev.ai/rev-users.create" to create a rev-user.

2. Make a POST request to "https://api.devrev.ai/rev-users.create" to create a customer.

github-actions · 2025-06-04T21:31:56Z

fern/docs/pages/welcome.mdx

 2. Go to the **Orgs** section and click on **+**.
 3. Fill in the details and click **Create**.

 Now you can find your newly created org in **Orgs**.

-Login into your demo org and [obtain the PAT token](/about/authentication#generate-a-personal-access-token-pat). 
+Login into your demo org and [obtain the PAT token](/about/authentication#generate-a-personal-access-token-pat).
 Now you can use this PAT token to make test API calls and try building something new.

 In this tutorial, you will be able to retrive your account information by using the `dev-users` API. Let's get started with DevRev APIs.


⚠️ [EkLine]

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change

In this tutorial, you will be able to retrive your account information by using the `dev-users` API. Let's get started with DevRev APIs.

In this tutorial, you can retrieve your account information by using the `dev-users` API. Let's get started with DevRev APIs.

github-actions · 2025-06-04T21:31:56Z

fern/docs/pages/welcome.mdx

@@ -30,11 +30,11 @@

 First, create a DevRev account or log in.

-Every call to a DevRev API must include a PAT. After you create your account, [generate a personal access token](/about/authentication) and store it in a safe place. 
+Every call to a DevRev API must include a PAT. After you create your account, [generate a personal access token](/about/authentication) and store it in a safe place.

 In this guide, you’ll make a call to the [`dev-users.self`](/api-reference/dev-users/self) API which gets the authenticated user's information. You will retrieve the user object created for your account on DevRev. This user object contains information such as a unique identifier, full name, display name, and profile picture.


⚠️ [EkLine]

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

Suggested change

In this guide, you’ll make a call to the [`dev-users.self`](/api-reference/dev-users/self) API which gets the authenticated user's information. You will retrieve the user object created for your account on DevRev. This user object contains information such as a unique identifier, full name, display name, and profile picture.

In this guide, you make a call to the [`dev-users.self`](/api-reference/dev-users/self) API which gets the authenticated user's information. You retrieve the user object created for your account on DevRev. This user object contains information such as a unique identifier, full name, display name, and profile picture.

github-actions · 2025-06-04T21:31:57Z

fern/docs/pages/welcome.mdx

@@ -123,7 +123,7 @@
 </CodeBlock>


-The response contains `"id": "don:identity:dvrv-us-1:devo/20:devu/40",`. The `id` identifies the `devo` ID (Dev organization ID) as `devo/<devo-id>` and the `devu` ID (Dev user ID) as `devu/<devu-id>`. 
+The response contains `"id": "don:identity:dvrv-us-1:devo/20:devu/40",`. The `id` identifies the `devo` ID (Dev organization ID) as `devo/<devo-id>` and the `devu` ID (Dev user ID) as `devu/<devu-id>`.


🚫 [EkLine]

Avoid using the term 'Dev user'. (EK25015)

Suggested change

The response contains `"id": "don:identity:dvrv-us-1:devo/20:devu/40",`. The `id` identifies the `devo` ID (Dev organization ID) as `devo/<devo-id>` and the `devu` ID (Dev user ID) as `devu/<devu-id>`.

The response contains `"id": "don:identity:dvrv-us-1:devo/20:devu/40",`. The `id` identifies the `devo` ID (Dev organization ID) as `devo/<devo-id>` and the `devu` ID (Developer user ID) as `devu/<devu-id>`.

github-actions · 2025-06-04T21:31:58Z

fern/docs/pages/create-accounts.mdx

⚠️ [EkLine]

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/create-accounts.mdx

Line 1 in 28968b8

In this tutorial, you'll learn how to create an account and contacts associated with it in DevRev via `accounts-create` and `rev-users.create` API. You can also [create accounts manually in DevRev app](https://docs.devrev.ai/product/customers#add-new-customers).

github-actions · 2025-06-04T21:31:59Z

fern/docs/pages/create-accounts.mdx

⚠️ [EkLine]

Suggestions:

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
Consider using 'workspace' instead of 'rev org'. (EK25033)
Avoid using 'we' as it can come off as patronizing. For example, write 'The configuration is complete' rather than 'We are now done with the configuration.' (EK81039)

fern-api-docs/fern/docs/pages/create-accounts.mdx

Line 4 in 28968b8

The `rev-users.create` API is used to create [contacts](https://docs.devrev.ai/product/grow#-contact) which represents an individual user associated with the account of the organization. To create a contact, we also need to use the `rev-orgs.list` API with the `accounts` filter to get the default [workspace](https://docs.devrev.ai/product/grow#-workspace)(rev org) created with the account. We will be creating a contact under the workspace (`rev_org`) of the account as contacts (`rev_user`) cannot exist individually without being associated with a workspace.

github-actions · 2025-06-04T21:32:00Z

fern/docs/pages/create-accounts.mdx

⚠️ [EkLine]

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/create-accounts.mdx

Line 260 in 28968b8

You have now successfully created a contact for the account. You can check the contacts created on the DevRev app by going to **Customers** > **Contacts** or by clicking the account you created in **Accounts** and selecting the **Contacts** tab to view all the contacts created for the selected account.

github-actions · 2025-06-04T21:32:01Z

fern/docs/pages/custom-objects.mdx

⚠️ [EkLine]

In general, don't use an ellipsis. (EK00011)

fern-api-docs/fern/docs/pages/custom-objects.mdx

Line 104 in 28968b8

"created_by": {...},

github-actions · 2025-06-04T21:32:02Z

fern/docs/pages/custom-objects.mdx

⚠️ [EkLine]

In general, don't use an ellipsis. (EK00011)

fern-api-docs/fern/docs/pages/custom-objects.mdx

Line 106 in 28968b8

"modified_by": {...},

github-actions · 2025-06-04T21:32:03Z

fern/docs/pages/custom-objects.mdx

📝 [EkLine]

Remove 'effectively' if it's not important to the meaning of the statement. (EK00006)

fern-api-docs/fern/docs/pages/custom-objects.mdx

Line 226 in 28968b8

objects more effectively. The process is the same as adding subtypes to other standard

github-actions · 2025-06-04T21:32:04Z

fern/docs/pages/customization.mdx

⚠️ [EkLine]

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/customization.mdx

Line 6 in 28968b8

process of tracking bugs in your organization. By the end of this section, you'll be able

github-actions · 2025-06-04T21:32:05Z

fern/docs/pages/customization.mdx

⚠️ [EkLine]

In general, don't use an ellipsis. (EK00011)

fern-api-docs/fern/docs/pages/customization.mdx

Line 183 in 28968b8

"created_by": {...},

github-actions · 2025-06-04T21:32:07Z

fern/docs/pages/timeline-entries.mdx

⚠️ [EkLine]

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/timeline-entries.mdx

Line 3 in 28968b8

In this tutorial, you'll learn how to send restricted visibility messages on the timeline of an object by using the `timeline-entries-create` API. These messages are only visible to the specific users you give access to.

github-actions · 2025-06-04T21:32:08Z

fern/docs/pages/timeline-entries.mdx

⚠️ [EkLine]

Consider using 'agent' instead of 'bot'. (EK25033)

fern-api-docs/fern/docs/pages/timeline-entries.mdx

Line 5 in 28968b8

The [timeline entries](/api-reference/timeline-entries/create) API is used to create discussions (comments) on the timeline of an object such as a ticket or issue. These messages can be sent by users or by a bot.

github-actions · 2025-06-04T21:33:03Z

Published docs preview URL: https://devrev-preview-57585575-b8b3-4612-a9f6-3c57399cf497.docs.buildwithfern.com

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

github-actions · 2025-06-04T21:36:26Z

Published docs preview URL: https://devrev-preview-3da7eef9-0ab7-4ca2-881b-d68cc24e69bf.docs.buildwithfern.com

bdbyrne · 2025-06-04T22:06:40Z

@bc-devrev Let me know if I can dismiss these Ekline comments, I just added a bunch of Bearer text and didn't change any descriptions.

bc-devrev

Yes Brian, you can disregard the EkLine comments.

chore: Include 'Bearer' in authorization header documentation

28968b8

bdbyrne requested a review from a team as a code owner June 4, 2025 21:30

github-actions bot reviewed Jun 4, 2025

View reviewed changes

Update fern/docs/pages/create-accounts.mdx

fe5a658

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

bc-devrev approved these changes Jun 4, 2025

View reviewed changes

bdbyrne merged commit cef03ae into main Jun 4, 2025
5 of 7 checks passed

bdbyrne deleted the auth-bearer branch June 4, 2025 22:15

tilenkavcic pushed a commit that referenced this pull request Jun 9, 2025

chore: Include 'Bearer' in authorization header documentation (#247)

33c6cf2

		@@ -139,19 +139,19 @@
		Get the default rev org created along with the newly created account using the `rev-orgs.list` API:

	Get the default rev org created along with the newly created account using the `rev-orgs.list` API:
	Get the default workspace created along with the newly created account using the `rev-orgs.list` API:

	- If there is an existing account then you can get the default rev org using the `rev-orgs.get` API:
	- If there is an existing account then you can get the default workspace using the `rev-orgs.get` API:

	- Make a GET request to "https://api.devrev.ai/rev-orgs.get" using cURL with the `account` filter.
	- Make a GET request to "https://api.devrev.ai/rev-orgs.get" using cURL with the `customer` filter.

	2. Make a POST request to "https://api.devrev.ai/rev-users.create" to create a rev-user.
	2. Make a POST request to "https://api.devrev.ai/rev-users.create" to create a customer.

	In this tutorial, you will be able to retrive your account information by using the `dev-users` API. Let's get started with DevRev APIs.
	In this tutorial, you can retrieve your account information by using the `dev-users` API. Let's get started with DevRev APIs.

	In this guide, you’ll make a call to the [`dev-users.self`](/api-reference/dev-users/self) API which gets the authenticated user's information. You will retrieve the user object created for your account on DevRev. This user object contains information such as a unique identifier, full name, display name, and profile picture.
	In this guide, you make a call to the [`dev-users.self`](/api-reference/dev-users/self) API which gets the authenticated user's information. You retrieve the user object created for your account on DevRev. This user object contains information such as a unique identifier, full name, display name, and profile picture.

	The response contains `"id": "don:identity:dvrv-us-1:devo/20:devu/40",`. The `id` identifies the `devo` ID (Dev organization ID) as `devo/<devo-id>` and the `devu` ID (Dev user ID) as `devu/<devu-id>`.
	The response contains `"id": "don:identity:dvrv-us-1:devo/20:devu/40",`. The `id` identifies the `devo` ID (Dev organization ID) as `devo/<devo-id>` and the `devu` ID (Developer user ID) as `devu/<devu-id>`.

chore: Include 'Bearer' in authorization header documentation #247

chore: Include 'Bearer' in authorization header documentation #247

Uh oh!

Conversation

bdbyrne commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

🌟 EkLine Reviewer

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

github-actions bot commented Jun 4, 2025

Uh oh!

bdbyrne commented Jun 4, 2025

Uh oh!

bc-devrev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!