diff --git a/README.md b/README.md index f882873..58772df 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # YNAB API Ruby Library -[![Continuous Integration](https://github.com/ynab/ynab-sdk-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/ynab/ynab-sdk-ruby/actions/workflows/ci.yml) +[![Build](https://github.com/ynab/ynab-sdk-ruby/actions/workflows/build-test.yml/badge.svg)](https://github.com/ynab/ynab-sdk-ruby/actions/workflows/build-test.yml) [![Gem Version](https://badge.fury.io/rb/ynab.svg)](https://rubygems.org/gems/ynab) This is the Ruby client for the YNAB API. @@ -80,6 +80,10 @@ The following methods are available in this library. | | [scheduled_transactions.get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | Returns a single scheduled transaction | | | [scheduled_transactions.create_scheduled_transaction(budget_id, data)](https://github.com/ynab/ynab-sdk-ruby/blob/master/docs/ScheduledTransactionsApi.md#create_scheduled_transaction) | Creates a single scheduled transaction | +## Versioning + +The version of this client is defined in the `ynab.gemspec` file and follows [semantic versioning](https://semver.org/). The version of this client is maintained independently and does not align with the the version of YNAB API itself (which is defined in the [OpenAPI spec](https://api.ynab.com/papi/open_api_spec.yaml)). To determine which spec version of the YNAB API was used when generating this client you can refer to the "description" in the field in the `ynab.gemspec` file. + ## License Copyright (c) 2024 You Need A Budget, LLC diff --git a/config.yaml b/config.yaml index 5a680f3..83e4b54 100644 --- a/config.yaml +++ b/config.yaml @@ -1,7 +1,7 @@ gemName: ynab moduleName: YNAB -gemSummary: YNAB API Client for Ruby -gemDescription: Ruby gem wrapper for the YNAB API. API documentation available at https://api.ynab.com. +gemSummary: Official Ruby client for the YNAB API +gemDescription: Official Ruby client for the YNAB API. API documentation available at https://api.ynab.com. gemHomepage: https://github.com/ynab/ynab-sdk-ruby gemLicense: Apache-2.0 gemAuthor: YNAB diff --git a/templates/gemspec.mustache b/templates/gemspec.mustache index 08182d7..80f38ee 100644 --- a/templates/gemspec.mustache +++ b/templates/gemspec.mustache @@ -15,7 +15,7 @@ Gem::Specification.new do |s| s.email = ["{{gemAuthorEmail}}{{^gemAuthorEmail}}{{infoEmail}}{{/gemAuthorEmail}}"] s.homepage = "{{gemHomepage}}{{^gemHomepage}}https://openapi-generator.tech{{/gemHomepage}}" s.summary = "{{gemSummary}}{{^gemSummary}}{{{appName}}} Ruby Gem{{/gemSummary}}" - s.description = "{{gemDescription}}{{^gemDescription}}{{{appDescription}}}{{^appDescription}}{{{appName}}} Ruby Gem{{/appDescription}}{{/gemDescription}} Generated from server specification version {{version}} using OpenAPI Generator version {{generatorVersion}}." + s.description = "{{gemDescription}}{{/gemDescription}} Generated from server specification version {{version}}." s.license = "{{{gemLicense}}}{{^gemLicense}}Unlicense{{/gemLicense}}" s.required_ruby_version = "{{{gemRequiredRubyVersion}}}{{^gemRequiredRubyVersion}}>= 2.7{{/gemRequiredRubyVersion}}" s.metadata = {{{gemMetadata}}}{{^gemMetadata}}{}{{/gemMetadata}}