mirror of
https://github.com/usebruno/bruno.git
synced 2026-06-29 23:54:24 +00:00
* feat: enhance Bru grammar to support response blocks and examples - Added new grammar rules for response headers, status, and body types (JSON, XML, text). - Introduced parsing logic for example blocks, allowing multiple examples with various body types. - Implemented tests for example parsing, including edge cases and complex examples with authentication. - Created fixture files for simple and complex examples to validate parsing functionality. feat: extend jsonToBru functionality to support response handling and examples - Updated jsonToBru to include parsing for response headers, status, and body types (JSON, XML, text). - Enhanced example handling to support multiple examples with various body types. - Added comprehensive tests for example parsing, including edge cases and complex scenarios with authentication. - Created fixture files for testing the new features and validating parsing functionality. move: files to fixtures folder refactor: simplify response body handling in Bru grammar and JSON conversion - Removed specific body type handling (JSON, XML, text) from grammar and semantics. - Updated response body parsing in jsonToBru to handle a unified response body format. - Adjusted tests and fixtures to reflect changes in response body structure, ensuring compatibility with the new format. feat: add response bookmarking functionality to ResponsePane - Introduced ResponseBookmark component to allow users to save responses as examples. - Added NameExampleModal for naming saved examples. - Updated ResponsePane to include the new bookmarking feature. - Implemented Redux actions to manage response examples in the collections state. - Enhanced CollectionItem to display saved examples and allow for expansion. fix: remove unnecessary padding from ExampleItem component feat: implement delete and rename functionality for examples in ExampleItem component - Added DeleteExampleModal for confirming deletion of examples. - Integrated modal for renaming examples with state management. - Enhanced ExampleItem to handle example deletion and renaming through modals. - Updated Redux actions to support example updates and deletions in the collections state. fix: example writing to disc properly fix: example parsing errors fix: request with example parsing error fix: handle examples in collections and requests feat: implement response example functionality in the application - Added ResponseExample component to handle displaying and editing response examples. - Integrated ResponseExampleRequestPane and ResponseExampleResponsePane for structured request and response handling. - Enhanced RequestTabPanel and RequestTab components to support response-example tabs. - Introduced new styled components for better UI/UX in response examples. - Updated theme files to include styles for response examples. - Implemented URL bar for editing request URLs in response examples. - Added functionality for managing headers and parameters in response examples. - Improved overall structure and organization of response example components. add styles for example url bar feat: add Checkbox component and Table-v2 for enhanced UI - Introduced a new Checkbox component for better user interaction in forms. - Added Table-v2 component to improve table rendering and resizing functionality. - Updated existing components to utilize the new Checkbox and Table-v2 for managing headers and parameters in response examples. - Enhanced styling for better visual consistency across components. - Updated theme files to include styles for the new components. feat: implement custom scrollbar styles for response example components fix: features add actions , view more feat: enhance response example functionality - Added GenerateCodeItem component for generating code snippets from response examples. - Integrated modal for code generation within ResponseExample component. - Updated ResponseExampleTopBar to handle example name and description editing. - Improved state management for response examples, including new actions for updating names and descriptions. - Enhanced ResponseExampleRequestPane to support editing and saving request details. - Refactored URL handling in ResponseExampleUrlBar to utilize example-specific data. - Improved overall user experience with better UI elements and state management. feat: enhance response example management and UI components feat: enhance editing capabilities in response example components feat: update multipart form parameter handling in response examples feat: refactor response example parameter handling and enhance UI interactions feat: introduce RadioButton component and update Checkbox usage in response examples fix: styles fix radio button styling fixed radio button styles feat: add create example from sidebar feat: enhance ResponseExample components with layout adjustments and new HeightBoundContainer feat: add Checkbox and RadioButton components with comprehensive tests for rendering, user interactions, and accessibility feat: playwright test csaes rm: comments fix: linting fix: tests refactor: update response example tests and enhance functionality fix: tests fix: e2e-tests refactor: implement hasRequestChanges utility for better change detection rm: console rm: consoles fix: lint fix: tests fix: response header disabled by default issue Feat/with bru example parser (#5892) * fix: response header disabled by default issue feat: new parsing logic fix: change test cases to accomodate new brulang add: path params features rm:consoles six: make tab permanent on double click fix width feat: add status editing feat: review fixes review fixes fix: review fixes fix: post review mv: test files fix: review * fix: lint * fix: review comments * fix: icons folder strcuture fix: tests fix: lint fix: unit tests feat: body mode selector fix: close all collections rm: example feat added tests. lang change feat: add custom status text fix: status update feat: add body mode, update tests add default name prefilled for example fix: active tab styles, prefilled name, text fixes fix : pkg lock fix: review fix: review comments fix: hide cursor when readonly fix: height fix: null body fix: response body parsing fix: test cases feat: add method support for examples fix: reponse parsing fix: update response body type when content type is updated rm : commented code feat: update parser logic fix: organize files feat: enhance examples handling in collection export and import feat: postman imports fro examples feat: enhance OpenAPI import functionality to support examples feat: support postman export fix: postman export import fix: open api tests, remove requestbody related logic rm: examples fix: move common attributes files ui fixes fix: clone issue fix: create example from request menu review fixes more review fixes mv: files, fix mode req error organize files fix:tests fix: save dot issue fix: bugs fix: postman export fix: import path params * chore:improve modal handling in environment and response example tests fix: test issues resolved * chore: update response example tests to use new fixture files and improve cleanup logic --------- Co-authored-by: Abhishek S Lal <abhishek@usebruno.com> Co-authored-by: Bijin Bruno <bijin@usebruno.com>
185 lines
6.2 KiB
JSON
185 lines
6.2 KiB
JSON
{
|
|
"meta": {
|
|
"name": "OAuth2 Examples API",
|
|
"type": "http",
|
|
"seq": "1"
|
|
},
|
|
"http": {
|
|
"method": "post",
|
|
"url": "https://api.example.com/oauth/protected",
|
|
"body": "json",
|
|
"auth": "oauth2"
|
|
},
|
|
"headers": [
|
|
{
|
|
"name": "content-type",
|
|
"value": "application/json",
|
|
"enabled": true
|
|
}
|
|
],
|
|
"auth": {
|
|
"oauth2": {
|
|
"grantType": "authorization_code",
|
|
"callbackUrl": "https://api.example.com/oauth/callback",
|
|
"authorizationUrl": "https://oauth.example.com/authorize",
|
|
"accessTokenUrl": "https://oauth.example.com/token",
|
|
"refreshTokenUrl": "https://oauth.example.com/token",
|
|
"clientId": "my-client-id",
|
|
"clientSecret": "my-client-secret",
|
|
"scope": "read write",
|
|
"state": "",
|
|
"pkce": true,
|
|
"credentialsPlacement": "header",
|
|
"credentialsId": "authorization",
|
|
"tokenPlacement": "header",
|
|
"tokenHeaderPrefix": "Bearer",
|
|
"tokenQueryKey": "access_token",
|
|
"autoFetchToken": true,
|
|
"autoRefreshToken": true
|
|
}
|
|
},
|
|
"body": {
|
|
"json": "{\n \"action\": \"test\",\n \"data\": {\n \"message\": \"Protected resource access\"\n }\n}"
|
|
},
|
|
"vars": {
|
|
"req": [
|
|
{
|
|
"name": "oauth_state",
|
|
"value": "{{$uuid}}",
|
|
"enabled": true,
|
|
"local": false
|
|
},
|
|
{
|
|
"name": "client_scopes",
|
|
"value": "read,write,admin",
|
|
"enabled": true,
|
|
"local": false
|
|
}
|
|
]
|
|
},
|
|
"script": {
|
|
"req": "const state = crypto.randomBytes(16).toString('hex');\nbru.setVar('oauth_state', state);\nbru.setVar('timestamp', Date.now());"
|
|
},
|
|
"tests": "test(\"Response should be 200\", function() {\n expect(res.getStatus()).to.eql(200);\n});\n\ntest(\"Should have user data in response\", function() {\n const body = res.getBody();\n expect(body.access_token).to.be.ok;\n});",
|
|
"examples": [
|
|
{
|
|
"name": "OAuth2 Protected Resource",
|
|
"description": "Example accessing resource protected with OAuth2 authorization code flow",
|
|
"request": {
|
|
"url": "https://api.example.com/oauth/protected",
|
|
"method": "post",
|
|
"body": {
|
|
"mode": "json",
|
|
"json": "{\n \"action\": \"fetch\",\n \"resource\": \"user_profile\"\n}"
|
|
},
|
|
"headers": [
|
|
{
|
|
"name": "authorization",
|
|
"value": "\"Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9\",",
|
|
"enabled": true
|
|
},
|
|
{
|
|
"name": "content-type",
|
|
"value": "\"application/json\"",
|
|
"enabled": true
|
|
}
|
|
]
|
|
},
|
|
"response": {
|
|
"status": "200",
|
|
"statusText": "OK",
|
|
"body": {
|
|
"type": "json",
|
|
"content": "{\n \"user\": {\n \"id\": \"123\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"scopes\": [\"read\", \"write\"]\n },\n \"token\": {\n \"access_token\": \"access_token_abc123\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n }\n}"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "OAuth2 Token Refresh",
|
|
"description": "Example demonstrating OAuth2 token refresh flow",
|
|
"request": {
|
|
"url": "https://api.example.com/oauth/token",
|
|
"method": "post",
|
|
"body": {
|
|
"mode": "json",
|
|
"json": "{\n \"grant_type\": \"refresh_token\",\n \"refresh_token\": \"refresh_token_xyz789\",\n \"client_id\": \"my-client-id\",\n \"client_secret\": \"my-client-secret\"\n}"
|
|
},
|
|
"headers": [
|
|
{
|
|
"name": "content-type",
|
|
"value": "\"application/json\",",
|
|
"enabled": true
|
|
},
|
|
{
|
|
"name": "accept",
|
|
"value": "\"application/json\"",
|
|
"enabled": true
|
|
}
|
|
]
|
|
},
|
|
"response": {
|
|
"status": "200",
|
|
"statusText": "OK",
|
|
"body": {
|
|
"type": "json",
|
|
"content": "{\n \"access_token\": \"new_access_token_def456\",\n \"refresh_token\": \"new_refresh_token_abc789\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\",\n \"scope\": \"read write\"\n}"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "OAuth2 Client Credentials",
|
|
"description": "Example using OAuth2 client credentials grant type",
|
|
"request": {
|
|
"url": "https://api.example.com/oauth/client-credentials",
|
|
"method": "post",
|
|
"body": {
|
|
"mode": "json",
|
|
"json": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"service-account\",\n \"client_secret\": \"service-secret-key\",\n \"scope\": \"admin\"\n}"
|
|
},
|
|
"headers": [
|
|
{
|
|
"name": "content-type",
|
|
"value": "\"application/json\"",
|
|
"enabled": true
|
|
}
|
|
]
|
|
},
|
|
"response": {
|
|
"status": "200",
|
|
"statusText": "OK",
|
|
"body": {
|
|
"type": "json",
|
|
"content": "{\n \"access_token\": \"service_access_token_123\",\n \"expires_in\": 7200,\n \"token_type\": \"Bearer\",\n \"scope\": \"admin\"\n}"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "OAuth2 Password Grant",
|
|
"description": "Example using OAuth2 password grant (username/password)",
|
|
"request": {
|
|
"url": "https://api.example.com/oauth/password",
|
|
"method": "post",
|
|
"body": {
|
|
"mode": "json",
|
|
"json": "{\n \"grant_type\": \"password\",\n \"username\": \"user@example.com\",\n \"password\": \"SecurePass123!\",\n \"client_id\": \"mobile-app\",\n \"client_secret\": \"mobile-app-secret\"\n}"
|
|
},
|
|
"headers": [
|
|
{
|
|
"name": "content-type",
|
|
"value": "\"application/json\"",
|
|
"enabled": true
|
|
}
|
|
]
|
|
},
|
|
"response": {
|
|
"status": "200",
|
|
"statusText": "OK",
|
|
"body": {
|
|
"type": "json",
|
|
"content": "{\n \"access_token\": \"user_access_token_456\",\n \"refresh_token\": \"user_refresh_token_789\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n}"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"docs": "This collection demonstrates OAuth2 authentication flows.\nSupports authorization code, client credentials, and password grant types.\nExamples show token refresh and protected resource access."
|
|
} |