Skip to content

feat: update revenue endpoint auth #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DmitryAnansky wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: update revenue endpoint auth #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion @theme/ext/use-configure-replay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ type ContextProps = {
userClaims: UserClaims;
};

const SCOPES = ['menu:read', 'menu:write', 'orders:read', 'orders:write'];
const SCOPES = ['menu:read', 'menu:write', 'orders:read', 'orders:write', 'revenue:read'];
const BASE_URL = 'https://cafe.cloud.redocly.com';
const CLIENT_NAME = 'auth';

Expand Down
2 changes: 2 additions & 0 deletions openapi/cafe.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,15 @@ components:
menu:write: Write access to menu items (create, delete)
orders:read: Read access to orders
orders:write: Write access to orders (create, update, delete)
revenue:read: Read access to revenue statistics
clientCredentials:
tokenUrl: https://cafe.cloud.redocly.com/oauth2/token
scopes:
menu:read: Read access to menu items and images
menu:write: Write access to menu items (create, delete)
orders:read: Read access to orders
orders:write: Write access to orders (create, update, delete)
revenue:read: Read access to revenue statistics
ApiKey:
type: apiKey
name: X-API-Key
Expand Down
1 change: 1 addition & 0 deletions openapi/components/schemas/OAuth2Client.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ properties:
- menu:write
- orders:read
- orders:write
- revenue:read
description: List of scopes (registered metadata).
grantTypes:
type: array
Expand Down
1 change: 1 addition & 0 deletions openapi/components/schemas/RegisterClientObject.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ properties:
- menu:write
- orders:read
- orders:write
- revenue:read
description: List of scopes.
grantTypes:
type: array
Expand Down
1 change: 1 addition & 0 deletions openapi/paths/oauth2_register.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ post:
- menu:write
- orders:read
- orders:write
- revenue:read
Copy link
Copy Markdown

@redocly redocly Bot Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description still lists "(menu:read, menu:write, orders:read, orders:write)" as all available scopes. It should be updated to include the newly added "revenue:read" scope for consistency with the schema.

grantTypes:
- client_credentials
responses:
Expand Down
2 changes: 2 additions & 0 deletions openapi/paths/revenue.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ get:
operationId: getRevenue
security:
- ApiKey: []
- OAuth2:
- revenue:read
Copy link
Copy Markdown

@redocly redocly Bot Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ApiKey remains an alternative to OAuth2 for the sensitive /revenue endpoint. Since ApiKey lacks scope restrictions, it could allow over-privileged access, bypassing the granular revenue:read scope intended for this financial data.

parameters:
- name: startDate
in: query
Expand Down