Merge pull request #209 from makeplane/feat-oauth_scopes_docs

[SILO-952] feat: add OAuth scopes support docs

Author: Saurabhkmr98

docs/.vitepress/config.mts

@@ -141,7 +141,7 @@ export default withMermaid(defineConfig({
     nav: [
       { text: 'Self-hosting', link: '/self-hosting/overview' },
       { text: 'API Reference', link: '/api-reference/introduction' },
-      { text: 'Build and extend', link: '/dev-tools/build-plane-app' },
+      { text: 'Build and extend', link: '/dev-tools/build-plane-app/overview' },
       { text: 'Plane Docs', link: 'https://docs.plane.so' },
       { text: 'Sign in', link: 'https://app.plane.so/sign-in' }
     ],
@@ -649,7 +649,17 @@ export default withMermaid(defineConfig({
         {
           text: 'Build and extend Plane',
           items: [
-            { text: 'Build Plane App', link: '/dev-tools/build-plane-app' },
+            {
+              text: 'Build Plane App', collapsed: false, items: [
+                { text: 'Overview', link: '/dev-tools/build-plane-app/overview' },
+                { text: 'Create an OAuth application', link: '/dev-tools/build-plane-app/create-oauth-application' },
+                { text: 'Choose token Flow', link: '/dev-tools/build-plane-app/choose-token-flow' },
+                { text: 'Handling webhooks', link: '/dev-tools/build-plane-app/webhooks' },
+                { text: 'OAuth scopes', link: '/dev-tools/build-plane-app/oauth-scopes' },
+                { text: 'SDKs', link: '/dev-tools/build-plane-app/sdks' },
+                { text: 'Complete examples', link: '/dev-tools/build-plane-app/examples' }
+              ]
+            },
             {
               text: 'Agents',
               collapsed: false,

docs/api-reference/customer/add-customer-property.md

@@ -130,6 +130,14 @@ External ID from the external source.
 </div>
 </div>
 
+<div class="params-section">
+
+### Scopes
+
+`customers.properties:write`
+
+</div>
+
 </div>
 <div class="api-right">
 
@@ -140,6 +148,7 @@ External ID from the external source.
 curl -X POST \
   "https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/" \
   -H "X-API-Key: $PLANE_API_KEY" \
+  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
   -H "Content-Type: application/json" \
   -d '{
   "name": "example-name",
@@ -237,3 +246,4 @@ const data = await response.json();
 
 </div>
 </div>
+

docs/api-reference/customer/add-customer-request.md

@@ -58,6 +58,14 @@ Description of the request.
 </div>
 </div>
 
+<div class="params-section">
+
+### Scopes
+
+`customers.requests:write`
+
+</div>
+
 </div>
 <div class="api-right">
 
@@ -68,6 +76,7 @@ Description of the request.
 curl -X POST \
   "https://api.plane.so/api/v1/workspaces/my-workspace/customers/{customer_id}/requests/" \
   -H "X-API-Key: $PLANE_API_KEY" \
+  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
   -H "Content-Type: application/json" \
   -d '{
   "title": "example-title",

docs/api-reference/customer/add-customer.md

@@ -52,6 +52,14 @@ Email address of the customer.
 </div>
 </div>
 
+<div class="params-section">
+
+### Scopes
+
+`customers:write`
+
+</div>
+
 </div>
 <div class="api-right">
 
@@ -62,6 +70,7 @@ Email address of the customer.
 curl -X POST \
   "https://api.plane.so/api/v1/workspaces/my-workspace/customers/" \
   -H "X-API-Key: $PLANE_API_KEY" \
+  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
   -H "Content-Type: application/json" \
   -d '{
   "name": "example-name",

docs/api-reference/customer/delete-customer-property.md

@@ -37,6 +37,14 @@ The unique identifier for the customer property.
 </div>
 </div>
 
+<div class="params-section">
+
+### Scopes
+
+`customers.properties:write`
+
+</div>
+
 </div>
 <div class="api-right">
 
@@ -46,7 +54,8 @@ The unique identifier for the customer property.
 ```bash
 curl -X DELETE \
   "https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/{property_id}/" \
-  -H "X-API-Key: $PLANE_API_KEY"
+  -H "X-API-Key: $PLANE_API_KEY" \
+  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
 ```
 
 </template>

docs/api-reference/customer/delete-customer-request.md

@@ -43,6 +43,14 @@ The unique identifier for the request.
 </div>
 </div>
 
+<div class="params-section">
+
+### Scopes
+
+`customers.requests:write`
+
+</div>
+
 </div>
 <div class="api-right">
 
@@ -53,6 +61,7 @@ The unique identifier for the request.
 curl -X DELETE \
   "https://api.plane.so/api/v1/workspaces/my-workspace/customers/{customer_id}/requests/{request_id}/" \
   -H "X-API-Key: $PLANE_API_KEY"
+  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
 ```
 
 </template>

docs/api-reference/customer/delete-customer.md

@@ -37,6 +37,14 @@ The unique identifier for the customer.
 </div>
 </div>
 
+<div class="params-section">
+
+### Scopes
+
+`customers:write`
+
+</div>
+
 </div>
 <div class="api-right">
 
@@ -46,7 +54,8 @@ The unique identifier for the customer.
 ```bash
 curl -X DELETE \
   "https://api.plane.so/api/v1/workspaces/my-workspace/customers/{customer_id}/" \
-  -H "X-API-Key: $PLANE_API_KEY"
+  -H "X-API-Key: $PLANE_API_KEY" \
+  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
 ```
 
 </template>

docs/api-reference/customer/get-customer-detail.md

@@ -37,6 +37,14 @@ The unique identifier for the customer.
 </div>
 </div>
 
+<div class="params-section">
+
+### Scopes
+
+`customers:read`
+
+</div>
+
 </div>
 <div class="api-right">
 
@@ -47,6 +55,7 @@ The unique identifier for the customer.
 curl -X GET \
   "https://api.plane.so/api/v1/workspaces/my-workspace/customers/{customer_id}/" \
   -H "X-API-Key: $PLANE_API_KEY"
+  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
 ```
 
 </template>

docs/api-reference/customer/get-customer-property-detail.md

@@ -37,6 +37,14 @@ The unique identifier for the customer property.
 </div>
 </div>
 
+<div class="params-section">
+
+### Scopes
+
+`customers.properties:read`
+
+</div>
+
 </div>
 <div class="api-right">
 
@@ -47,6 +55,7 @@ The unique identifier for the customer property.
 curl -X GET \
   "https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/{property_id}/" \
   -H "X-API-Key: $PLANE_API_KEY"
+  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
 ```
 
 </template>

docs/api-reference/customer/get-customer-property-value.md

@@ -43,6 +43,14 @@ The unique identifier for the customer property.
 </div>
 </div>
 
+<div class="params-section">
+
+### Scopes
+
+`customers.property_values:read`
+
+</div>
+
 </div>
 <div class="api-right">
 
@@ -53,6 +61,7 @@ The unique identifier for the customer property.
 curl -X GET \
   "https://api.plane.so/api/v1/workspaces/my-workspace/customers/{customer_id}/property-values/{property_id}/" \
   -H "X-API-Key: $PLANE_API_KEY"
+  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
 ```
 
 </template>