Skip to content

chore(preview-middleware):adjust readme #3134

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.

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
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

heimwege
Copy link
Contributor

@heimwege heimwege commented Apr 16, 2025

  • correct some wrong default values
  • add default value columns everywhere
  • separate value type and requirement type in different columns
  • move requirement type from description and former type column to the new requirement type column
  • rephrasing some descriptions

Copy link

changeset-bot bot commented Apr 16, 2025

🦋 Changeset detected

Latest commit: 5db6a75

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@sap-ux/preview-middleware Patch
@sap-ux/create Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@heimwege heimwege added the preview-middleware @sap-ux/preview-middleware label Apr 16, 2025
@heimwege heimwege requested a review from ytpo-lyne April 16, 2025 14:20
@heimwege heimwege marked this pull request as ready for review April 16, 2025 14:21
@heimwege heimwege requested a review from a team as a code owner April 16, 2025 14:21
@ytpo-lyne ytpo-lyne requested a review from lfindlaysap April 16, 2025 16:19
ytpo-lyne
ytpo-lyne previously approved these changes Apr 16, 2025
Copy link
Contributor

@ytpo-lyne ytpo-lyne left a comment

Choose a reason for hiding this comment

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

  • update for readMe looks nice
  • changeset exist

Thanks @heimwege, approving.

@ytpo-lyne ytpo-lyne removed the request for review from lfindlaysap April 16, 2025 16:22
Copy link
Contributor

@lfindlaysap lfindlaysap left a comment

Choose a reason for hiding this comment

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

@heimwege, here are my suggestions.

| `scp` | `boolean` optional | If set to true the proxy will execute the required OAuth routine for the ABAP environment on SAP BTP |
| Option | Value Type | Requirement Type | Default Value | Description |
| ------------- |------------|-----------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| `url` | `string` | mandatory (local) | `undefined` | Mandatory URL pointing to the backend system. *Not required if destination is provided and the proxy is running SAP Business Application Studio |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `url` | `string` | mandatory (local) | `undefined` | Mandatory URL pointing to the backend system. *Not required if destination is provided and the proxy is running SAP Business Application Studio |
| `url` | `string` | mandatory (local) | `undefined` | Mandatory URL pointing to the back-end system. *Not required if destination is provided and the proxy is running SAP Business Application Studio |

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is it backend, back-end or back end?

| Option | Value Type | Requirement Type | Default Value | Description |
| ------------- |------------|-----------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| `url` | `string` | mandatory (local) | `undefined` | Mandatory URL pointing to the backend system. *Not required if destination is provided and the proxy is running SAP Business Application Studio |
| `destination` | `string` | mandatory (if no url) | `undefined` | Required if the backend system is available as destination in SAP Business Application Studio. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `destination` | `string` | mandatory (if no url) | `undefined` | Required if the backend system is available as destination in SAP Business Application Studio. |
| `destination` | `string` | mandatory (if no URL) | `undefined` | Required if the back-end system is available as destination in SAP Business Application Studio. |

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is it backend, back-end or back end?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
preview-middleware @sap-ux/preview-middleware
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants