Skip to content

README improvements #622

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
harr1424 wants to merge 5 commits into
base: main
Choose a base branch
from
+12 −3
Open

README improvements #622

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1219ba3
README improvements
harr1424 Dec 18, 2025
3b92d60
fix lints
harr1424 Dec 18, 2025
72163ae
clarify script usage
harr1424 Dec 18, 2025
a86a2e7
clarify generated bindings should not be directly edited
harr1424 Dec 18, 2025
efb5139
clairify binding changes should not be checked in
harr1424 Dec 19, 2025
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
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Copy link
Member

@Hinton Hinton Dec 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

We should mention somewhere that you should only use the workflow and never merge manual binding changes in PRs.

https://github.com/bitwarden/sdk-internal/actions/workflows/update-api-bindings.yml

Copy link
Author

@harr1424 harr1424 Dec 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@Hinton please let me know what you think of the wording in efb5139

Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,13 @@ are:

We autogenerate the server bindings using
[openapi-generator](https://github.com/OpenAPITools/openapi-generator). To do this, we first need to
build the internal swagger documentation.
build the internal swagger documentation. This code should not be directly modified, instead see the
instructions below to generate Swagger documents and use these to generate the OpenApi bindings.

### Swagger generation

The first step is to generate the swagger documents from the root of the server repository.
The first step is to generate the swagger documents from the root of the
[server repository](https://github.com/bitwarden/server).

```bash
pwsh ./dev/generate_openapi_files.ps1
Expand All @@ -78,7 +80,8 @@ pwsh ./dev/generate_openapi_files.ps1
### OpenApi Generator

To generate a new version of the bindings, run the following script from the root of the SDK
project.
project. This requires a Java Runtime Environment, and also assumes the repositories `server` and
`sdk-internal` have the same parent directory.

```bash
./support/build-api.sh
Expand All @@ -95,6 +98,12 @@ towards modifying the templates as little as possible to ease future upgrades.
- This process also changes the `Cargo.toml` file. When creating a PR updating the bindings, please
revert (do not include) the updates to the `Cargo.toml` file.

> [!IMPORTANT] A GitHub workflow exists to
> [update the API bindings](https://github.com/bitwarden/sdk-internal/actions/workflows/update-api-bindings.yml).
> Running the scripts above can be helpful during local development, but please ensure that any
> changes to the bindings in `bitwarden-api-api` and `bitwarden-api-identity` are **not** checked
> into any pull request.

## Developer tools

This project recommends the use of certain developer tools and includes configurations for them to
Expand Down
Loading