Skip to content

Commit ff77f09

Browse files
shariqshariq
authored andcommitted
Promote SDK to stable v1.0.0
- Bump version from 0.0.5-beta to 1.0.0 across all config and source files - Remove duplicate Summary/API Servers/Authentication/Tutorials section from README - Remove beta SDK callout from README - Update Maturity section to reflect stable semver guarantees - Add overlay action to clear info.description to prevent section from being regenerated Made-with: Cursor
1 parent 35c6ae0 commit ff77f09

7 files changed

Lines changed: 15 additions & 91 deletions

File tree

.speakeasy/gen.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ management:
55
docVersion: 3.0.16
66
speakeasyVersion: 1.757.0
77
generationVersion: 2.866.0
8-
releaseVersion: 0.0.5-beta
8+
releaseVersion: 1.0.0
99
configChecksum: 45193cd285e175d52e0e9048482927cc
1010
repoURL: https://github.com/authlete/authlete-ruby-sdk.git
1111
installationURL: https://github.com/authlete/authlete-ruby-sdk

.speakeasy/gen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ generation:
3333
generateNewTests: true
3434
skipResponseBodyAssertions: false
3535
ruby:
36-
version: 0.0.5-beta
36+
version: 1.0.0
3737
additionalDependencies:
3838
development: {}
3939
runtime: {}

.speakeasy/speakeasy-modifications-overlay.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ info:
88
before: ""
99
type: speakeasy-modifications
1010
actions:
11+
- target: $["info"]["description"]
12+
update: ""
13+
x-speakeasy-metadata:
14+
after: cleared
15+
before: long description
16+
created_at: 1761810000000
17+
reviewed_at: 1761810000000
18+
type: description-clear
1119
- target: $["paths"]["/api/{serviceId}/auth/authorization"]["post"]
1220
update:
1321
x-speakeasy-group: authorization

Gemfile.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
authlete_ruby_sdk (0.0.5.pre.beta)
4+
authlete_ruby_sdk (1.0.0)
55
base64 (>= 0.2.0, < 1.0)
66
faraday (>= 2.14.1)
77
faraday-multipart (~> 1.2.0)

README.md

Lines changed: 1 addition & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ Developer-friendly & type-safe Ruby SDK specifically catered to leverage *Authle
1010
<br> </br>
1111
</div>
1212

13-
> [!IMPORTANT]
14-
> This is a beta SDK.
15-
1613
## 🎓 Tutorials
1714

1815
If you're new to Authlete or want to see sample implementations, these resources will help you get started:
@@ -28,85 +25,6 @@ If you have any questions or need assistance, our team is here to help:
2825
<!-- End Summary [summary] -->
2926

3027
<!-- Start Summary [summary] -->
31-
## Summary
32-
33-
Authlete API: Welcome to the **Authlete API documentation**. Authlete is an **API-first service** where every aspect of the
34-
platform is configurable via API. This documentation will help you authenticate and integrate with Authlete to
35-
build powerful OAuth 2.0 and OpenID Connect servers.
36-
37-
At a high level, the Authlete API is grouped into two categories:
38-
39-
- **Management APIs**: Enable you to manage services and clients.
40-
- **Runtime APIs**: Allow you to build your own Authorization Servers or Verifiable Credential (VC) issuers.
41-
42-
## 🌐 API Servers
43-
44-
Authlete is a global service with clusters available in multiple regions across the world:
45-
46-
- 🇺🇸 **US**: `https://us.authlete.com`
47-
- 🇯🇵 **Japan**: `https://jp.authlete.com`
48-
- 🇪🇺 **Europe**: `https://eu.authlete.com`
49-
- 🇧🇷 **Brazil**: `https://br.authlete.com`
50-
51-
Our customers can host their data in the region that best meets their requirements.
52-
53-
## 🔑 Authentication
54-
55-
All API endpoints are secured using **Bearer token authentication**. You must include an access token in every request:
56-
57-
```
58-
Authorization: Bearer YOUR_ACCESS_TOKEN
59-
```
60-
61-
### Getting Your Access Token
62-
63-
Authlete supports two types of access tokens:
64-
65-
**Service Access Token** - Scoped to a single service (authorization server instance)
66-
67-
1. Log in to [Authlete Console](https://console.authlete.com)
68-
2. Navigate to your service → **Settings****Access Tokens**
69-
3. Click **Create Token** and select permissions (e.g., `service.read`, `client.write`)
70-
4. Copy the generated token
71-
72-
**Organization Token** - Scoped to your entire organization
73-
74-
1. Log in to [Authlete Console](https://console.authlete.com)
75-
2. Navigate to **Organization Settings****Access Tokens**
76-
3. Click **Create Token** and select org-level permissions
77-
4. Copy the generated token
78-
79-
> ⚠️ **Important Note**: Tokens inherit the permissions of the account that creates them. Service tokens can only
80-
> access their specific service, while organization tokens can access all services within your org.
81-
82-
### Token Security Best Practices
83-
84-
- **Never commit tokens to version control** - Store in environment variables or secure secret managers
85-
- **Rotate regularly** - Generate new tokens periodically and revoke old ones
86-
- **Scope appropriately** - Request only the permissions your application needs
87-
- **Revoke unused tokens** - Delete tokens you're no longer using from the console
88-
89-
### Quick Test
90-
91-
Verify your token works with a simple API call:
92-
93-
```bash
94-
curl -X GET https://us.authlete.com/api/service/get/list \
95-
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
96-
```
97-
98-
## 🎓 Tutorials
99-
100-
If you're new to Authlete or want to see sample implementations, these resources will help you get started:
101-
102-
- [Getting Started with Authlete](https://www.authlete.com/developers/getting_started/)
103-
- [From Sign-Up to the First API Request](https://www.authlete.com/developers/tutorial/signup/)
104-
105-
## 🛠 Contact Us
106-
107-
If you have any questions or need assistance, our team is here to help:
108-
109-
- [Contact Page](https://www.authlete.com/contact/)
11028
<!-- End Summary [summary] -->
11129

11230
<!-- Start Table of Contents [toc] -->
@@ -606,9 +524,7 @@ end
606524

607525
## Maturity
608526

609-
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
610-
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
611-
looking for the latest version.
527+
This SDK is stable and follows [semantic versioning](https://semver.org/). Minor and patch releases will not introduce breaking changes. Breaking changes will only be introduced in a new major version.
612528

613529
## Contributions
614530

authlete_ruby_sdk.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
44

55
Gem::Specification.new do |s|
66
s.name = 'authlete_ruby_sdk'
7-
s.version = '0.0.5-beta'
7+
s.version = '1.0.0'
88
s.platform = Gem::Platform::RUBY
99
s.licenses = ['Apache-2.0']
1010
s.summary = ''

lib/authlete/sdkconfiguration.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,9 @@ def initialize(client, hooks, retry_config, timeout_ms, bearer, security_source,
9292
end
9393
@language = 'ruby'
9494
@openapi_doc_version = '3.0.16'
95-
@sdk_version = '0.0.5-beta'
95+
@sdk_version = '1.0.0'
9696
@gen_version = '2.866.0'
97-
@user_agent = 'speakeasy-sdk/ruby 0.0.5-beta 2.866.0 3.0.16 authlete_ruby_sdk'
97+
@user_agent = 'speakeasy-sdk/ruby 1.0.0 2.866.0 3.0.16 authlete_ruby_sdk'
9898
end
9999

100100
sig { returns([String, T::Hash[Symbol, String]]) }

0 commit comments

Comments
 (0)