From 8218a88f08ce8f8bc520f812b0cb3b3189908078 Mon Sep 17 00:00:00 2001 From: diacritics-owo <176600453+diacritics-owo@users.noreply.github.com> Date: Thu, 5 Sep 2024 11:42:45 +0530 Subject: [PATCH] fix #2 --- .openapi-generator-ignore | 4 ++++ README.md | 6 +++++- openapi/config.yaml | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore index bf42c17..f31b00a 100644 --- a/.openapi-generator-ignore +++ b/.openapi-generator-ignore @@ -1,3 +1,7 @@ README.md git_push.sh .travis.yml + +# modified code - handle with care +src/apis/mod.rs +src/apis/configuration.rs diff --git a/README.md b/README.md index 87b89b2..5c14b2c 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 ). -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`. diff --git a/openapi/config.yaml b/openapi/config.yaml index f2f1056..1e8abd3 100644 --- a/openapi/config.yaml +++ b/openapi/config.yaml @@ -1,3 +1,3 @@ packageName: 'modrinth-api' avoidBoxedModels: true -packageVersion: 2.7.0 +packageVersion: 2.7.1