aha_builder_core 1.0.11 → 1.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e6e28bca46f39adb4867003b15c833849411798457acf1e1cd7992fbd5aacf8f
4
- data.tar.gz: e408177a51f230e9bb730773a3e8ccd3d5748527098593d52b97b7ed0b282091
3
+ metadata.gz: 6f587457e1e82ad9b4a22fd94b57e5bbd05e5ff6763f6bae6e085fac11393f1e
4
+ data.tar.gz: 7ef22938cdbc4c7a6e39a9c60c5534457db865c96a5fffd3f857e8d21e2c90c7
5
5
  SHA512:
6
- metadata.gz: ab9432062bfc10636c3c6b9ad84c56b2d3535fa7ddd74808a56a7efb5af6a86b631520efc3ea6e726bcc92f1a20fbfea200edcd19a131b59af780e5524406c2a
7
- data.tar.gz: 93c391bcc6ca38d2143d2eb47cd7cec2db3d94c9406a0f6db4fc27418ad546281751318ab77659bcf9af87311fbc2eea29eafe8ca6a0e8da64c08e001f16810b
6
+ metadata.gz: 1cc85c41ce5216bbed1044ad8c2dc0425562370a536638236313bfee9d883446a01562e05fb4258d2be19bbaac9c4d93d97c0990e4704a977b7e6c3ce13c48e7
7
+ data.tar.gz: 1cd8e3729355ecb16c09ebe1a8106062aa7ec9653ebdaa040fb7e9dd5e574fe0f3ffddd47fb8229d52adbf598a53c59e73e2fff8039bfd102f8df0f39dd9a470
data/README.md CHANGED
@@ -181,23 +181,24 @@ end
181
181
 
182
182
  ## User Guide
183
183
 
184
- Access user guide documentation created in Aha! for your application:
184
+ Access user guide pages created in Aha! for your application. The user guide is made up of many pages.
185
185
 
186
186
  ```ruby
187
- # List all user guide pages (metadata only)
188
- result = Aha::UserGuide.list
189
- guides = result[:guides] # Array of guide hashes
187
+ # Get the table of contents (all pages, metadata only)
188
+ result = Aha::UserGuide.table_of_contents
189
+ pages = result[:pages] # Array of page hashes without content.
190
190
 
191
- # Get a single guide with HTML content
192
- guide = Aha::UserGuide.find(id)
193
- html_content = guide["content_html"]
191
+ # Load a specific page with HTML content
192
+ page = Aha::UserGuide.load_page(id)
193
+ html_content = page["content_html"]
194
194
  ```
195
195
 
196
- ### Guide Structure
196
+ ### Page Structure
197
197
 
198
- Each guide hash contains:
199
- - `id` - Guide ID
200
- - `name` - Guide title
201
- - `parent_id` - Parent folder ID for building navigation
202
- - `position` - Sort order
203
- - `content_html` - HTML content (only in `find` response)
198
+ Each page hash contains:
199
+ - `id` - Page ID
200
+ - `name` - Page title
201
+ - `parent_id` - Parent page ID for building table of contents hierarchy (nil for top level pages)
202
+ - `position` - Sort order (integer)
203
+ - `children_count` - Number of child pages
204
+ - `content_html` - HTML content (only in `load_page` response)
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Aha
4
4
  module Auth
5
- VERSION = "1.0.11"
5
+ VERSION = "1.0.12"
6
6
  end
7
7
  end
@@ -3,15 +3,15 @@
3
3
  module Aha
4
4
  module UserGuide
5
5
  class << self
6
- def list
7
- response = client.send(:get, "/api/core/guides")
6
+ def table_of_contents
7
+ response = client.send(:get, "/api/core/user_guide/table_of_contents")
8
8
  {
9
- guides: response["guides"] || []
9
+ pages: response["pages"] || []
10
10
  }
11
11
  end
12
12
 
13
- def find(id)
14
- client.send(:get, "/api/core/guides/#{id}")
13
+ def load_page(id)
14
+ client.send(:get, "/api/core/user_guide/pages/#{id}")
15
15
  end
16
16
 
17
17
  private
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aha_builder_core
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.11
4
+ version: 1.0.12
5
5
  platform: ruby
6
6
  authors:
7
7
  - Aha! Labs Inc.