Skip to content

DISCORD_API_V10_COMPATIBILITY.md

Latest commit

 

History

History
180 lines (140 loc) · 5.38 KB

DISCORD_API_V10_COMPATIBILITY.md

File metadata and controls

180 lines (140 loc) · 5.38 KB

Discord API v10 Compatibility Report

Overview

This document details the compatibility status of the service_description-v10.json file with Discord API version 10.

Test Results

Status: ✅ COMPATIBLE

All compatibility tests pass successfully:

  • 8 tests executed
  • 557 assertions validated
  • 0 failures

Changes from Discord API v9 to v10

1. Base URI and Version

  • Base URI: Updated from https://discord.com/api/v9 to https://discord.com/api/v10
  • Version: Updated from 9 to 10

2. Critical Breaking Changes

Message Embed Parameter (Breaking Change)

The most significant change in Discord API v10 is the transition from singular embed to plural embeds:

Affected Operations:

  • channel/createMessage
  • channel/editMessage
  • webhook/executeWebhook
  • webhook/executeSlackCompatibleWebhook (if applicable)

v9 Parameter:

{
  "embed": {
    "type": "object",
    "description": "embedded rich content"
  }
}

v10 Parameter:

{
  "embeds": {
    "type": "array",
    "description": "embedded rich contents"
  }
}

Impact:

  • ⚠️ Breaking Change: Code using the singular embed parameter will need to be updated to use embeds (plural) as an array
  • This allows messages to contain multiple embeds (up to 10 per message)
  • Existing code must be migrated from embed: {...} to embeds: [{...}]

Validation Tests Performed

1. Basic Configuration Tests

  • ✅ Base URI correctly set to /api/v10
  • ✅ Version number correctly set to 10

2. v10-Specific Changes

  • ✅ createMessage operation uses embeds (array) parameter
  • ✅ editMessage operation uses embeds (array) parameter
  • ✅ embed (singular) parameter has been removed from message operations

3. Operation Compatibility

  • ✅ All v9 operations still exist in v10 (threads, interactions, application commands)
  • ✅ All operations map to valid PHP interface methods
  • ✅ All response types map to valid model classes
  • ✅ Return type annotations match service description

4. Model Compatibility

  • ✅ All model resources map to valid PHP model classes
  • ✅ All model properties exist as PHP class properties
  • ✅ No model schema changes required

5. Critical Operations

  • ✅ Guild operations (createGuild, getGuild, modifyGuild)
  • ✅ Channel operations (getChannel, modifyChannel, createMessage, editMessage)
  • ✅ User operations (getCurrentUser)
  • ✅ Application command operations (slash commands)
  • ✅ Thread operations (startThreadFromMessage)
  • ✅ Interaction operations (createInteractionResponse)

Resources and Operations Summary

The v10 service description contains:

  • 13 resource types: guild, channel, user, webhook, voice, emoji, invite, gateway, oauth2, audit-log, permissions, application-command, interaction
  • 121 total operations across all resources
  • 12 model resources with comprehensive property definitions

No Changes Required

The following remain unchanged from v9:

  • ✅ Total number of operations
  • ✅ Total number of resources
  • ✅ Model schemas and structures
  • ✅ Operation URLs and HTTP methods
  • ✅ Authentication mechanisms
  • ✅ Response types and formats

Recommendations

For Developers Using RestCord

  1. Update Message Creation/Editing Code:

    // OLD (v9):
$message = $discord->channel->createMessage([
    'channel.id' => $channelId,
    'content' => 'Hello',
    'embed' => [
        'title' => 'My Embed',
        'description' => 'Description'
    ]
]);

// NEW (v10):
$message = $discord->channel->createMessage([
    'channel.id' => $channelId,
    'content' => 'Hello',
    'embeds' => [
        [
            'title' => 'My Embed',
            'description' => 'Description'
        ]
    ]
]);

  2. Multiple Embeds Support: You can now send multiple embeds in a single message:

    $message = $discord->channel->createMessage([
    'channel.id' => $channelId,
    'content' => 'Multiple embeds!',
    'embeds' => [
        ['title' => 'First Embed'],
        ['title' => 'Second Embed'],
        ['title' => 'Third Embed']
    ]
]);

  3. Testing: Run the compatibility test suite:

    ./vendor/bin/phpunit tests/ServiceDescriptionV10Test.php

Test Coverage

A comprehensive test suite has been created at tests/ServiceDescriptionV10Test.php to validate:

  1. testBaseUri() - Validates correct v10 base URI
  2. testVersion() - Validates version number is 10
  3. testV10EmbedsParameter() - Validates embed → embeds parameter change
  4. testV9OperationsExistInV10() - Ensures v9 features still work
  5. testOperationResources() - Validates all operations and interfaces
  6. testModels() - Validates all models and properties
  7. testCriticalV10Operations() - Validates critical API operations
  8. testWebhookEmbedsParameter() - Validates webhook embed parameters

Conclusion

The service_description-v10.json file is fully compatible with Discord API v10. The implementation correctly reflects the Discord API v10 specification, with proper handling of the breaking change from embed to embeds.

All operations, models, and interfaces are properly defined and validated. The library is ready for use with Discord API v10.

Report Generated: 2026-03-13 Test Framework: PHPUnit 8.5.52 PHP Version: 8.3.6 RestCord Version: Latest