tweak readme and regen

walker-tx · Feb 2, 2025 · 884bfd1 · 884bfd1
1 parent 8a1aa5a
commit 884bfd1
Show file tree

Hide file tree

Showing 8 changed files with 47 additions and 25 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -5,8 +5,9 @@ management:
   docVersion: 1.0.0
   speakeasyVersion: 1.481.1
   generationVersion: 2.500.5
-  releaseVersion: 0.0.1
-  configChecksum: d7178c61a36454565e0284db323dfa35
+  releaseVersion: 0.0.2
+  configChecksum: d1ccbfa8ce4f4dc2214d9593ca9278f9
+  published: true
 features:
   typescript:
     additionalDependencies: 0.1.0
@@ -118,6 +119,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     CompactNotation:
       parameters:
         query:
@@ -141,6 +143,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     ChapterRange:
       parameters:
         query:
@@ -164,6 +167,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     NumericalEncoding:
       parameters:
         query:
@@ -187,6 +191,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     DigitalRange:
       parameters:
         query:
@@ -210,6 +215,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     MultiReference:
       parameters:
         query:
@@ -233,6 +239,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     StructuredDigital:
       parameters:
         query:
@@ -256,6 +263,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     "":
       parameters:
         query:
@@ -279,6 +287,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
   getPassageText:
     StandardReference:
       parameters:
@@ -306,6 +315,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     CompactNotation:
       parameters:
         query:
@@ -332,6 +342,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     ChapterRange:
       parameters:
         query:
@@ -358,6 +369,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     NumericalEncoding:
       parameters:
         query:
@@ -384,6 +396,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     DigitalRange:
       parameters:
         query:
@@ -410,6 +423,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     MultiReference:
       parameters:
         query:
@@ -436,6 +450,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     StructuredDigital:
       parameters:
         query:
@@ -462,6 +477,7 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
     "":
       parameters:
         query:
@@ -488,5 +504,6 @@ examples:
       responses:
         "400":
           application/json: {"code": "<value>", "message": "<value>"}
+        "200": {}
 examplesVersion: 1.0.0
 generatedTests: {}
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -16,7 +16,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: true
 typescript:
-  version: 0.0.1
+  version: 0.0.2
   additionalDependencies:
     dependencies: {}
     devDependencies: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -2,7 +2,7 @@ speakeasyVersion: 1.481.1
 sources:
     ESV.org API:
         sourceNamespace: esv-org-api
-        sourceRevisionDigest: sha256:64279f2aa93b4d488d8f63e8c690526e80c2bde4b1364c2334c4c2d130c0c0ee
+        sourceRevisionDigest: sha256:88b789e4ea4ea9e7c89c83080b3325bacdfb1d93c80671b41dbc8b189c56cad8
         sourceBlobDigest: sha256:c96509f88bb05b1cbcdc3ae20cbf9d1a1705cb5c3dbc03279cca63cf60273aed
         tags:
             - latest
@@ -11,10 +11,10 @@ targets:
     esv:
         source: ESV.org API
         sourceNamespace: esv-org-api
-        sourceRevisionDigest: sha256:64279f2aa93b4d488d8f63e8c690526e80c2bde4b1364c2334c4c2d130c0c0ee
+        sourceRevisionDigest: sha256:88b789e4ea4ea9e7c89c83080b3325bacdfb1d93c80671b41dbc8b189c56cad8
         sourceBlobDigest: sha256:c96509f88bb05b1cbcdc3ae20cbf9d1a1705cb5c3dbc03279cca63cf60273aed
         codeSamplesNamespace: esv-org-api-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:684d8f09adaf6848e2a61a6e9539318a3eec88e90532b3e8c2e8ca540ba1922c
+        codeSamplesRevisionDigest: sha256:6124936c4ebe58912f7e6624329a3309a5eac86de75e5b77b42fe693a38c9aaa
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
@@ -28,6 +28,9 @@ workflow:
         esv:
             target: typescript
             source: ESV.org API
+            publish:
+                npm:
+                    token: $npm_token
             codeSamples:
                 registry:
                     location: registry.speakeasyapi.dev/walker/esv/esv-org-api-typescript-code-samples

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# esv-sdk
+# Esv.org TypeScript SDK
 
-Developer-friendly & type-safe Typescript SDK specifically catered to leverage *esv-sdk* API.
+Developer-friendly & type-safe Typescript SDK specifically catered to leverage *Esv.org* API.
 
 <div align="left">
     <a href="https://www.speakeasy.com/?utm_source=esv-sdk&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
@@ -11,8 +11,14 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
 
 
 <br /><br />
-> [!IMPORTANT]
-> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/walker/esv). Delete this section before > publishing to a package manager.
+
+## Summary
+
+ESV.org API: The ESV API provides access to the ESV text, with a customizable presentation in  multiple formats. You will need an HTTP client in your programming language of  choice to use the API.
+
+This is not an official SDK.
+
+<!-- End Summary [summary] -->
 
 <!-- Start Summary [summary] -->
 ## Summary
@@ -23,7 +29,7 @@ ESV.org API: The ESV API provides access to the ESV text, with a customizable pr
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
 <!-- $toc-max-depth=2 -->
-* [esv-sdk](#esv-sdk)
+* [Esv.org TypeScript SDK](#esvorg-typescript-sdk)
   * [SDK Installation](#sdk-installation)
   * [Requirements](#requirements)
   * [SDK Example Usage](#sdk-example-usage)
@@ -44,34 +50,30 @@ ESV.org API: The ESV API provides access to the ESV text, with a customizable pr
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-> [!TIP]
-> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
-
-
 The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
 
 ### NPM
 
 ```bash
-npm add <UNSET>
+npm add esv-sdk
 ```
 
 ### PNPM
 
 ```bash
-pnpm add <UNSET>
+pnpm add esv-sdk
 ```
 
 ### Bun
 
 ```bash
-bun add <UNSET>
+bun add esv-sdk
 ```
 
 ### Yarn
 
 ```bash
-yarn add <UNSET> zod
+yarn add esv-sdk zod
 
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.

diff --git a/jsr.json b/jsr.json
@@ -2,7 +2,7 @@
 
 {
   "name": "esv-sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "esv-sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {

diff --git a/src/lib/config.ts b/src/lib/config.ts
@@ -57,7 +57,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.0.1",
+  sdkVersion: "0.0.2",
   genVersion: "2.500.5",
-  userAgent: "speakeasy-sdk/typescript 0.0.1 2.500.5 1.0.0 esv-sdk",
+  userAgent: "speakeasy-sdk/typescript 0.0.2 2.500.5 1.0.0 esv-sdk",
 } as const;