ryan
/
progenitor
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use toml instead of diff for toml code snippets (#743) 

Use the toml syntax highlighter and format the code snippets as toml
instead of diff, so users can copy-paste it more easily, without having
to edit out the diff makers (+) by hand when they add the snippets to
their Cargo.toml / etc.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
This commit is contained in:
Matthias Beyer 2024-03-19 18:32:04 +01:00 committed by GitHub
parent d3514fcfc4
commit 090dd361fc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -36,42 +36,42 @@ generate_api!("path/to/openapi_document.json");
You'll need to add the following to `Cargo.toml`: You'll need to add the following to `Cargo.toml`:
```diff ```toml
[dependencies] [dependencies]
+futures = "0.3" futures = "0.3"
+progenitor = { git = "https://github.com/oxidecomputer/progenitor" } progenitor = { git = "https://github.com/oxidecomputer/progenitor" }
+reqwest = { version = "0.11", features = ["json", "stream"] } reqwest = { version = "0.11", features = ["json", "stream"] }
+serde = { version = "1.0", features = ["derive"] } serde = { version = "1.0", features = ["derive"] }
``` ```
In addition, if the OpenAPI document contains string types with the `format` In addition, if the OpenAPI document contains string types with the `format`
field set to `date` or `date-time`, include field set to `date` or `date-time`, include
```diff ```toml
[dependencies] [dependencies]
+chrono = { version = "0.4", features = ["serde"] } chrono = { version = "0.4", features = ["serde"] }
``` ```
Similarly, if there is a `format` field set to `uuid`: Similarly, if there is a `format` field set to `uuid`:
```diff ```toml
[dependencies] [dependencies]
+uuid = { version = "1.0.0", features = ["serde", "v4"] } uuid = { version = "1.0.0", features = ["serde", "v4"] }
``` ```
And if there are any websocket channel endpoints: And if there are any websocket channel endpoints:
```diff ```toml
[dependencies] [dependencies]
+base64 = "0.21" base64 = "0.21"
+rand = "0.8" rand = "0.8"
``` ```
If types include regular expression validation: If types include regular expression validation:
```diff ```toml
[dependencies] [dependencies]
+regress = "0.4.1" regress = "0.4.1"
``` ```
The macro has some additional fancy options to control the generated code: The macro has some additional fancy options to control the generated code:
@ -129,18 +129,18 @@ include!(concat!(env!("OUT_DIR"), "/codegen.rs"));
You'll need to add the following to `Cargo.toml`: You'll need to add the following to `Cargo.toml`:
```diff ```toml
[dependencies] [dependencies]
+futures = "0.3" futures = "0.3"
+progenitor-client = { git = "https://github.com/oxidecomputer/progenitor" } progenitor-client = { git = "https://github.com/oxidecomputer/progenitor" }
+reqwest = { version = "0.11", features = ["json", "stream"] } reqwest = { version = "0.11", features = ["json", "stream"] }
+serde = { version = "1.0", features = ["derive"] } serde = { version = "1.0", features = ["derive"] }
[build-dependencies] [build-dependencies]
+prettyplease = "0.1.25" prettyplease = "0.1.25"
+progenitor = { git = "https://github.com/oxidecomputer/progenitor" } progenitor = { git = "https://github.com/oxidecomputer/progenitor" }
+serde_json = "1.0" serde_json = "1.0"
+syn = "1.0" syn = "1.0"
``` ```
(`chrono`, `uuid`, `base64`, and `rand` as above) (`chrono`, `uuid`, `base64`, and `rand` as above)