Skip to content

Commit

Permalink
fix #2
Browse files Browse the repository at this point in the history
  • Loading branch information
diacritics-owo committed Sep 5, 2024
1 parent 58e884d commit 8218a88
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
4 changes: 4 additions & 0 deletions .openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
README.md
git_push.sh
.travis.yml

# modified code - handle with care
src/apis/mod.rs
src/apis/configuration.rs
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ A client library for the Modrinth API, generated with openapi-generator

The major and minor versions of this library correspond directly to the version of the Modrinth API (the patch version may be separate). The earliest supported version of the API is 2.7.0.

## Usage Notes

- When using a token, use `Configuration::with_api_key`.

## Documentation

It is generally not necessary, as most things are self-explanatory, but if you do need to view the documentation, generate the library (see [Developing](#developing)) and view the `docs` folder.
Expand All @@ -18,6 +22,6 @@ It is generally not necessary, as most things are self-explanatory, but if you d

To generate the client library, run `deno task gen`. This will use openapi-generator (located at `openapi/openapi-generator.jar`) to generate the library from the Modrinth API spec (located at `openapi/openapi-generator.jar`, downloadable from <https://docs.modrinth.com/>).

Post-processing of the generated files is done within `openapi/gen.ts`. Edit `dependencies.toml`, `tests.rs`, or `package.toml` to add dev dependencies, edit tests, and add package metadata, respectively.
Post-processing of the generated files is done within `openapi/gen.ts`. Edit `dependencies.toml`, `tests.rs`, or `package.toml` to add dev dependencies, edit tests, and add package metadata, respectively. If you need to make deeper modifications to code, edit the file directly and add it to `.openapi-generator-ignore`.

When updating the API version, remember to also update `openapi/config.yaml`.
2 changes: 1 addition & 1 deletion openapi/config.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
packageName: 'modrinth-api'
avoidBoxedModels: true
packageVersion: 2.7.0
packageVersion: 2.7.1

0 comments on commit 8218a88

Please sign in to comment.