api-regulator 0.1.28 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4adbf41faf31da6c2dfd0ac4fa34753b1b145e4a54fe150716b248c0bb2ca8f
-  data.tar.gz: 3bf906b1cc68f8729c8593fda4af679525999b6d4ed27f8036b96a9b4a90466a
+  metadata.gz: 8bcf52fc47c491d424f53b82688cfa8a3f0b78b62460267f1ad81abcf695827d
+  data.tar.gz: 1bb55ea5e11bff7fce98874adf0ca5d79db2431eabf4cafdaaf2dec7b4bb6fa4
 SHA512:
-  metadata.gz: 92cf6b80afec1af5113edb3ac6dfd64211931a3c47ade5b5aad032ed6c35343357cc158eebe7e5a27fb4a65ca600584bb64cbfaf36eb6532ebd721c98588157d
-  data.tar.gz: 1a5e008679121223946897c93b2a89efd1be92c267b4b5ffb07e484c35938236f842ba1fd2e9eea9c5de60bc1a5e931a95f207e348abe4062fde7a4f2d6a1227
+  metadata.gz: c872be90e74a524e316958afc1486464612854794ca86f0fe78aef6ea9a67bc1779870eecd7fc8750987e0a5f3b2ca5a99c7af6047add3f3fb83d0e86c326d8b
+  data.tar.gz: e55567f1b2c788bae49bb536aee0aa10e9f6fa6c490ec04632c42a0b6acb0fb2758c54ef6c7944806aeb3453c197cf2bce749977c324d523dbca1c88eb19bf44

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-regulator (0.1.28)
+    api-regulator (1.0.0)
       activemodel (~> 8.0)
       activesupport (~> 8.0)
 

data/README.md

@@ -13,7 +13,7 @@ ApiRegulator leverages **Active Model validations** for parameter validation, ma
 - **🏷️ API Versioning**: Support multiple API versions with selective parameter inclusion
 - **🔒 Security Schemes**: Define authentication and authorization schemes
 - **🔄 Shared Schemas**: Reuse common response and parameter schemas across multiple endpoints
-- **📚 ReadMe Integration**: Built-in tasks for uploading documentation to ReadMe.com
+- **📚 ReadMe Integration**: Built-in tasks for generating OpenAPI specs and seamless integration with rdme CLI for uploading to ReadMe.com
 - **🛡️ Parameter Validation**: Strict validation with helpful error messages for unexpected parameters
 - **📄 Custom Page Management**: Upload and manage documentation pages alongside API specs
 
@@ -27,6 +27,20 @@ gem 'api_regulator'
 
 Run `bundle install` to install the gem.
 
+### Optional: Install rdme CLI for ReadMe Integration
+
+For uploading documentation to ReadMe, install the rdme CLI:
+
+```bash
+npm install -g rdme
+```
+
+Or as a project dependency:
+
+```bash
+npm install rdme --save-dev
+```
+
 ## Setup
 
 ### 1. Create an Initializer
@@ -91,7 +105,7 @@ class Api::V1::CustomersController < Api::ApplicationController
     # Path parameters
     param :organization_id, :string, location: :path, presence: true
 
-    # Query parameters  
+    # Query parameters
     param :expand, :string, location: :query, desc: "Comma-separated list of fields to expand"
 
     # Body parameters
@@ -101,7 +115,7 @@ class Api::V1::CustomersController < Api::ApplicationController
       param :email, :string, presence: true, format: { with: ApiRegulator::Formats::EMAIL }
       param :ssn, :string, presence: true, length: { is: 9 }
       param :date_of_birth, :string, format: { with: ApiRegulator::Formats::DATE }
-      
+
       # Nested objects
       param :address, :object do
         param :street, :string, presence: true
@@ -134,7 +148,7 @@ class Api::V1::CustomersController < Api::ApplicationController
 
   def create
     validate_params! # Validates against DSL definition
-    
+
     customer = Customer.create!(api_params[:customer])
     render json: { customer: customer }, status: :created
   end
@@ -146,7 +160,7 @@ end
 #### Conditional Requirements
 
 ```ruby
-param :ssn, :string, presence: { 
+param :ssn, :string, presence: {
   required_on: [:create, :update],           # Required only for these actions
   required_except_on: [:show]                # Required except for these actions
 }
@@ -234,11 +248,11 @@ Define webhook payloads using the same DSL:
 
 ```ruby
 class WebhookDefinitions < Api::ApplicationController
-  webhook :customer_created, 
+  webhook :customer_created,
     desc: "Fired when a new customer is created",
     title: "Customer Created",
     tags: ["customers", "webhooks"] do
-    
+
     param :event, :string, desc: "Event name"
     param :timestamp, :string, desc: "ISO 8601 timestamp"
     param :data do
@@ -299,7 +313,7 @@ end
 ```ruby
 def create
   validate_params! # Raises ApiRegulator::InvalidParams or ApiRegulator::UnexpectedParams
-  
+
   # Access validated and type-converted parameters
   customer_data = api_params[:customer]
   # Process with confidence that data is valid
@@ -314,16 +328,16 @@ class Api::ApplicationController < ActionController::API
   include ApiRegulator::ControllerMixin
 
   rescue_from ApiRegulator::InvalidParams do |exception|
-    render json: { 
+    render json: {
       errors: exception.errors.messages,
-      message: "Validation failed" 
+      message: "Validation failed"
     }, status: :unprocessable_entity
   end
 
   rescue_from ApiRegulator::UnexpectedParams do |exception|
-    render json: { 
+    render json: {
       errors: exception.details,
-      message: "Unexpected parameters provided" 
+      message: "Unexpected parameters provided"
     }, status: :bad_request
   end
 end
@@ -331,6 +345,18 @@ end
 
 ## OpenAPI Documentation Generation
 
+### Validate OpenAPI Specification
+
+Before uploading, validate your OpenAPI specification using rdme:
+
+```bash
+# Validate the generated OpenAPI spec
+rdme openapi validate doc/openapi.yaml
+
+# Validate with specific version
+rdme openapi validate doc/openapi.yaml --version=v1.0
+```
+
 ### Generate Documentation
 
 ```bash
@@ -346,23 +372,84 @@ rake api_docs:generate_all
 
 ### Upload to ReadMe
 
-Set up your ReadMe credentials:
+ApiRegulator integrates with [rdme](https://github.com/readmeio/rdme), ReadMe's official CLI tool, for modern, secure, and reliable documentation management.
+
+#### Installation
+
+Install the rdme CLI globally:
+
+```bash
+npm install -g rdme
+```
+
+Or install it as a project dependency:
+
+```bash
+npm install rdme --save-dev
+```
+
+#### Authentication
+
+Authenticate with ReadMe using the CLI:
+
+```bash
+rdme login
+```
+
+Alternatively, set your API key as an environment variable:
 
 ```bash
 export RDME_API_KEY="your_readme_api_key"
 ```
 
+#### Upload Commands
+
+**Recommended approach using rdme CLI:**
+
 ```bash
-# Upload API specification
-rake api_docs:upload
+# Generate and upload everything using rdme (RECOMMENDED)
+rake api_docs:publish_rdme
 
-# Upload custom documentation pages (with YAML frontmatter)
+# Or step by step:
+rake api_docs:generate
+rake api_docs:upload_rdme
+rdme docs upload doc/
+```
+
+**Legacy approach (may not work with ReadMe API v2):**
+
+```bash
+# Generate OpenAPI specification
+rake api_docs:generate
+
+# Upload using legacy rake tasks (deprecated)
+rake api_docs:upload
 rake api_docs:upload_pages
+```
+
+#### Migration from Legacy Tasks
+
+If you're experiencing 404 errors with the legacy upload tasks, migrate to rdme CLI:
+
+```bash
+# Run the migration script
+./scripts/migrate_to_rdme.sh
 
-# Generate and upload everything
-rake api_docs:publish
+# Or manually:
+npm install -g rdme
+rdme login
+rake api_docs:publish_rdme
 ```
 
+**rdme CLI Features:**
+
+- Modern ReadMe API v2 integration
+- Bearer token authentication (more secure)
+- Better performance and reliability
+- Support for ReadMe Refactored features
+- Branch-based versioning
+- Built-in validation and error handling
+
 ### Custom Documentation Pages
 
 Create markdown files in your `docs_path` with YAML frontmatter:
@@ -380,14 +467,60 @@ hidden: false
 Your API documentation content here...
 ```
 
+### GitHub Actions Integration
+
+Use rdme in your GitHub Actions workflow for automated documentation updates:
+
+```yaml
+name: Update API Documentation
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  update-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install
+
+      - name: Generate and upload API documentation
+        run: rake api_docs:publish_rdme
+        env:
+          RDME_API_KEY: ${{ secrets.RDME_API_KEY }}
+```
+
 ### ReadMe Integration Features
 
 ```bash
-# Fetch available categories
-rake api_docs:fetch_categories
+# Validate OpenAPI specification
+rdme openapi validate doc/openapi.yaml
+
+# Upload OpenAPI spec using rake task (recommended)
+rake api_docs:upload_rdme
 
 # Upload with specific version
-VERSION=v2.0 rake api_docs:upload
+VERSION=v2.0 rake api_docs:upload_rdme
+
+# Upload directly with rdme CLI
+rdme openapi upload doc/openapi.yaml --version=v2.0
+
+# Fetch available categories
+rdme categories list
 ```
 
 ## Built-in Format Validators
@@ -396,7 +529,7 @@ ApiRegulator includes common format validators:
 
 ```ruby
 ApiRegulator::Formats::DATE          # ISO 8601 date format
-ApiRegulator::Formats::DATETIME      # ISO 8601 datetime format  
+ApiRegulator::Formats::DATETIME      # ISO 8601 datetime format
 ApiRegulator::Formats::EMAIL         # Email address validation
 ApiRegulator::Formats::ZIP_CODE      # US ZIP code (12345 or 12345-6789)
 ApiRegulator::Formats::URI           # URI format validation
@@ -426,11 +559,11 @@ RSpec.describe Api::V1::CustomersController do
       params = {
         customer: {
           first_name: "John",
-          last_name: "Doe", 
+          last_name: "Doe",
           email: "john@example.com"
         }
       }
-      
+
       post "/api/v1/customers", params: params
       expect(response).to have_http_status(:created)
     end
@@ -444,22 +577,22 @@ end
 ApiRegulator.configure do |config|
   # Base URL for all API endpoints (default: "api/v1")
   config.api_base_url = "/api/v1"
-  
+
   # Application name shown in documentation (default: "API Documentation")
   config.app_name = "My API"
-  
+
   # Directory for documentation files (default: "doc")
   config.docs_path = Rails.root.join("doc").to_s
-  
+
   # Version mapping for ReadMe (optional)
   config.versions = {
     "v1.0" => "readme_spec_id_1",
     "v2.0" => "readme_spec_id_2"
   }
-  
+
   # Default version when none specified (optional)
   config.default_version = "v1.0"
-  
+
   # Server definitions for OpenAPI spec (optional)
   config.servers = [
     { url: "https://api.example.com", description: "Production" },
@@ -476,7 +609,7 @@ end
 # Define version-specific endpoints
 api self, :create, versions: [:v1, :v2] do
   param :name, :string, presence: true
-  param :email, :string, presence: true, versions: [:v1, :v2] 
+  param :email, :string, presence: true, versions: [:v1, :v2]
   param :phone, :string, versions: [:v2]  # Only in v2
 end
 ```
@@ -487,7 +620,7 @@ end
 api self, :create do
   # This endpoint requires authentication
   security [{ bearer_auth: [] }]
-  
+
   param :customer do
     param :name, :string, presence: true
   end
@@ -500,12 +633,61 @@ end
 def update
   # Validate with specific context
   validate_params!
-  
+
   # The validation context is automatically set to the action name (:update)
   # This allows conditional validations based on the action
 end
 ```
 
+## Troubleshooting
+
+### Common Issues
+
+#### 404 Error When Uploading Pages
+
+If you get a 404 error when uploading documentation pages:
+
+```
+Failed to upload page 'Webhooks'!
+Response Code: 404
+```
+
+**Solution:** The legacy rake tasks may not work with ReadMe API v2. Use rdme CLI instead:
+
+```bash
+# Install and authenticate with rdme
+npm install -g rdme
+rdme login
+
+# Use the recommended approach
+rake api_docs:publish_rdme
+```
+
+#### Authentication Issues
+
+If you get authentication errors:
+
+```bash
+# Check your authentication status
+rdme whoami
+
+# Re-authenticate if needed
+rdme logout
+rdme login
+```
+
+#### OpenAPI Validation Errors
+
+Validate your OpenAPI spec before uploading:
+
+```bash
+# Validate the generated spec
+rdme openapi validate doc/openapi.yaml
+
+# Check for common issues
+rdme openapi validate doc/openapi.yaml --verbose
+```
+
 ## Error Reference
 
 - `ApiRegulator::InvalidParams`: Raised when request parameters fail validation

data/lib/api_regulator/configuration.rb

@@ -4,7 +4,7 @@ module ApiRegulator
 
     def initialize
       # Set default values
-      @api_base_url = "api/v1"
+      @api_base_url = "api/v2"
       @app_name = "API Documentation"
       @docs_path = "doc"
       @servers = []

data/lib/api_regulator/open_api_generator.rb

@@ -30,12 +30,12 @@ module ApiRegulator
         openapi: '3.1.0', # Explicitly target OpenAPI 3.1.0
         info: {
           title: ApiRegulator.configuration.app_name,
-          description: 'Generated by ApiRegulator'
+          description: 'Generated by ApiRegulator',
+          version: version.presence || '1.0.0'
         },
         servers: ApiRegulator.configuration.servers,
         paths: {}
       }
-      final_schema[:info][:version] = version if version.present?
 
       add_components
       add_security

data/lib/api_regulator/version.rb

@@ -1,3 +1,3 @@
 module ApiRegulator
-  VERSION = "0.1.28"
+  VERSION = "1.0.0"
 end

data/lib/tasks/api_regulator_tasks.rake

@@ -23,128 +23,116 @@ namespace :api_docs do
     end
   end
 
-  desc "Upload OpenAPI schema to ReadMe"
-  task :upload => :environment do
-    # ReadMe API key and version
-    readme_api_key = ENV['RDME_API_KEY'].presence || raise("RDME_API_KEY is not set")
-    version = ENV['VERSION'] || ApiRegulator.configuration.default_version
-
-    # ReadMe API endpoint
-    readme_api_endpoint = "https://dash.readme.com/api/v1/api-specification"
+  desc "Upload OpenAPI schema to ReadMe using rdme CLI (RECOMMENDED)"
+  task upload_rdme: :environment do
+    # Check if rdme is available
+    unless system("which rdme > /dev/null 2>&1")
+      puts "❌ rdme CLI not found. Please install it first:"
+      puts "   npm install -g rdme"
+      puts "   rdme login"
+      exit 1
+    end
 
-    # Read the OpenAPI schema file
-    schema_path =  ApiRegulator::OpenApiGenerator.schema_file_path(version: version)
+    version = ENV['VERSION'] || ApiRegulator.configuration.default_version
+    schema_path = ApiRegulator::OpenApiGenerator.schema_file_path(version: version)
+    
     unless File.exist?(schema_path)
-      raise "OpenAPI schema file not found at #{schema_path}"
+      raise "OpenAPI schema file not found at #{schema_path}. Run 'rake api_docs:generate' first."
     end
-    openapi_content = File.read(schema_path)
 
-    # Upload to ReadMe
-    require 'net/http'
-    require 'uri'
-    require 'json'
+    puts "📄 Uploading OpenAPI specification with rdme CLI..."
+    puts "   Schema: #{schema_path}"
+    puts "   Version: #{version || 'default'}"
+    puts ""
 
-    if version.present?
-      uri = URI.parse("#{readme_api_endpoint}/#{ApiRegulator.configuration.versions[version]}")
-      request = Net::HTTP::Put.new(uri)
+    # Use rdme CLI to upload
+    if system("rdme openapi upload #{schema_path}")
+      puts "✅ OpenAPI schema successfully uploaded!"
     else
-      uri = URI.parse(readme_api_endpoint)
-      request = Net::HTTP::Post.new(uri)
-    end
-    request["Authorization"] = "Basic #{Base64.strict_encode64(readme_api_key)}"
-    request["Content-Type"] = "application/json"
-    request["x-readme-version"] = version if version.present?
-    request.body = {
-      spec: JSON.parse(openapi_content)
-    }.to_json
-
-    response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-      http.request(request)
+      puts "❌ Failed to upload OpenAPI schema"
+      exit 1
     end
+  end
 
-    if response.code.to_i == 200
-      puts "OpenAPI schema successfully updated!"
-    elsif response.code.to_i == 201
-      puts "OpenAPI schema successfully created!"
-      puts "To use this for future publishing, add this to your ApiRegulator configs:"
-      puts ""
-      puts "  config.versions = {"
-      puts "    \"<versionNumber>\": \"#{JSON.parse(response.body)["_id"]}\""
-      puts "  }"
-      puts ""
+  desc "Upload OpenAPI schema to ReadMe (LEGACY - may not work with ReadMe API v2)"
+  task :upload => :environment do
+    puts "⚠️  WARNING: This rake task is deprecated and may not work with ReadMe API v2."
+    puts "   Please use the rdme CLI instead:"
+    puts "   "
+    puts "   # Install rdme CLI"
+    puts "   npm install -g rdme"
+    puts "   "
+    puts "   # Authenticate with ReadMe"
+    puts "   rdme login"
+    puts "   "
+    puts "   # Upload using rdme CLI"
+    puts "   rake api_docs:upload_rdme"
+    puts "   "
+    puts "   For more information, see: https://github.com/readmeio/rdme"
+    puts "   "
+    
+    # Check if rdme is available
+    if system("which rdme > /dev/null 2>&1")
+      puts "✅ rdme CLI is installed. Running: rake api_docs:upload_rdme"
+      Rake::Task["api_docs:upload_rdme"].invoke
     else
-      puts "Failed to upload OpenAPI schema to ReadMe!"
-      puts "Response Code: #{response.code}"
-      puts "Response Body:"
-      pp JSON.parse(response.body)
+      puts "❌ rdme CLI not found. Please install it first:"
+      puts "   npm install -g rdme"
+      exit 1
     end
   end
 
-  desc 'Generate and upload OpenAPI schema'
+  desc 'Generate and upload OpenAPI schema using rdme CLI (RECOMMENDED)'
+  task publish_rdme: :environment do
+    Rake::Task["api_docs:generate"].invoke
+    Rake::Task["api_docs:upload_rdme"].invoke
+    
+    puts "📄 Uploading documentation pages with rdme CLI..."
+    system("rdme docs upload #{ApiRegulator.configuration.docs_path}/")
+  end
+
+  desc 'Generate and upload OpenAPI schema (LEGACY - may not work with ReadMe API v2)'
   task publish: :environment do
     Rake::Task["api_docs:generate"].invoke
     Rake::Task["api_docs:upload"].invoke
-    Rake::Task["api_docs:upload_pages"].invoke
+    
+    # Check if rdme is available for uploading pages
+    if system("which rdme > /dev/null 2>&1")
+      puts "📄 Uploading documentation pages with rdme CLI..."
+      system("rdme docs upload #{ApiRegulator.configuration.docs_path}/")
+    else
+      puts "⚠️  rdme CLI not found. Skipping documentation pages upload."
+      puts "   Install rdme CLI to upload documentation pages:"
+      puts "   npm install -g rdme"
+      puts "   rdme docs upload #{ApiRegulator.configuration.docs_path}/"
+    end
   end
 
-  desc "Upload custom pages to ReadMe"
+  desc "Upload custom pages to ReadMe (DEPRECATED - Use rdme CLI instead)"
   task :upload_pages => :environment do
-    # Configuration
-    readme_api_key = ENV['RDME_API_KEY'].presence || raise("RDME_API_KEY is not set")
-    version = ENV['VERSION'] || ApiRegulator.configuration.default_version
-    base_readme_api_endpoint = "https://dash.readme.com/api/v1/docs"
-
-    # Discover all documentation files
-    pages_directory = "#{ApiRegulator.configuration.docs_path}/**/*.md"
-    page_files = Dir.glob(pages_directory)
-
-    # Iterate through each file
-    page_files.each do |file_path|
-      # Extract metadata and body
-      metadata, body = parse_markdown_file(file_path)
-      raise "No metadata found in #{file_path}" unless metadata
-
-      # Use metadata to build the API request
-      slug = metadata["slug"] || File.basename(file_path, ".md").gsub("_", "-")
-      request_body = {
-        type: "basic",
-        categorySlug: "documentation",
-        hidden: false,
-        body: body
-      }.merge(metadata)
-      request_body["slug"] ||= slug
-
-      raise("Title missing in #{file_path}") unless request_body["title"].present?
-
-      # Build the API request
-      if check_if_page_exists(slug)
-        uri = URI.parse("#{base_readme_api_endpoint}/#{slug}")
-        request = Net::HTTP::Put.new(uri)
-      else
-        uri = URI.parse("#{base_readme_api_endpoint}")
-        request = Net::HTTP::Post.new(uri)
-      end
-      request["Authorization"] = "Basic #{Base64.strict_encode64(readme_api_key)}"
-      request["Content-Type"] = "application/json"
-      request["x-readme-version"] = version if version.present?
-      request.body = request_body.compact.to_json
-
-      # Send the request
-      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-        http.request(request)
-      end
-
-      # Handle the response
-      case response.code.to_i
-      when 200
-        puts "Page '#{request_body["title"]}' successfully updated!"
-      when 201
-        puts "Page '#{request_body["title"]}' successfully created!"
-      else
-        puts "Failed to upload page '#{request_body["title"]}'!"
-        puts "Response Code: #{response.code}"
-        puts "Response Body: #{response.body}"
-      end
+    puts "⚠️  WARNING: This rake task is deprecated and may not work with ReadMe API v2."
+    puts "   Please use the rdme CLI instead:"
+    puts "   "
+    puts "   # Install rdme CLI"
+    puts "   npm install -g rdme"
+    puts "   "
+    puts "   # Authenticate with ReadMe"
+    puts "   rdme login"
+    puts "   "
+    puts "   # Upload documentation pages"
+    puts "   rdme docs upload #{ApiRegulator.configuration.docs_path}/"
+    puts "   "
+    puts "   For more information, see: https://github.com/readmeio/rdme"
+    puts "   "
+    
+    # Check if rdme is available
+    if system("which rdme > /dev/null 2>&1")
+      puts "✅ rdme CLI is installed. Running: rdme docs upload #{ApiRegulator.configuration.docs_path}/"
+      system("rdme docs upload #{ApiRegulator.configuration.docs_path}/")
+    else
+      puts "❌ rdme CLI not found. Please install it first:"
+      puts "   npm install -g rdme"
+      exit 1
     end
   end
 
@@ -152,15 +140,13 @@ namespace :api_docs do
   task :fetch_categories => :environment do
     # Configuration
     readme_api_key = ENV['RDME_API_KEY'].presence || raise("RDME_API_KEY is not set")
-    version = ENV['VERSION'] || ApiRegulator.configuration.default_version
-    readme_categories_api_endpoint = "https://dash.readme.com/api/v1/categories"
+    readme_categories_api_endpoint = "https://api.readme.com/v2/categories"
 
     # Build the API request
     uri = URI.parse(readme_categories_api_endpoint)
     request = Net::HTTP::Get.new(uri)
-    request["Authorization"] = "Basic #{Base64.strict_encode64(readme_api_key)}"
+    request["Authorization"] = "Bearer #{readme_api_key}"
     request["Content-Type"] = "application/json"
-    request["x-readme-version"] = version if version.present?
 
     # Send the request
     response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
@@ -171,7 +157,10 @@ namespace :api_docs do
     case response.code.to_i
     when 200
       puts "Categories"
-      pp JSON.parse(response.body)
+      response_data = JSON.parse(response.body)
+      # API v2 response format - returns data in a 'data' wrapper
+      categories = response_data.dig("data") || response_data
+      pp categories
     else
       puts "Failed to fetch categories"
       puts "Response Code: #{response.code}"
@@ -195,14 +184,13 @@ namespace :api_docs do
     [metadata, body]
   end
 
-  def check_if_page_exists(slug)
+  def check_if_page_exists(slug, branch = "stable")
     readme_api_key = ENV['RDME_API_KEY'].presence || raise("RDME_API_KEY is not set")
-    version = ENV['VERSION'] || ApiRegulator.configuration.default_version
-    uri = URI.parse("https://dash.readme.com/api/v1/docs/#{slug}")
+    
+    uri = URI.parse("https://api.readme.com/v2/custom_pages/#{slug}")
     request = Net::HTTP::Get.new(uri)
-    request["Authorization"] = "Basic #{Base64.strict_encode64(readme_api_key)}"
+    request["Authorization"] = "Bearer #{readme_api_key}"
     request["Content-Type"] = "application/json"
-    request["x-readme-version"] = version if version.present?
 
     # Send the request
     response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-regulator
 version: !ruby/object:Gem::Version
-  version: 0.1.28
+  version: 1.0.0
 platform: ruby
 authors:
 - Geoff Massanek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-18 00:00:00.000000000 Z
+date: 2025-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport