Active
Project:
Drupal Canvas
Version:
1.x-dev
Component:
Documentation
Priority:
Major
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
6 Sep 2024 at 16:44 UTC
Updated:
17 Nov 2025 at 16:37 UTC
Jump to comment: Most recent
We have a basic implementation in place now for validating API requests and responses against our specification. Now let's look into what other opportunities are available to leverage the specification and decide what would provide enough value to pursue.
Consider the following per #3466555-11: Also validate request bodies against the OpenAPI spec:
Document where the exact cut-off lies of where OpenAPI validation ends (i.e. request/response shape validation) and "real" validation (i.e. content/config entity validation that inspects the actual values used, the "foreign keys" if you will)
Comments
Comment #2
traviscarden commentedComment #3
wim leersThis would've accelerated @f.mazeikis' work at #3486203: Integrate saving sections with the backend: (de)normalize Pattern config entities using the client-side data model by multiple days!
Comment #4
wim leersAlso:
— @larowlan at #3499536: Move PropSourceEndpointTest to XbConfigEntityHttpApiTest::testComponent(), emphasis mine.
Comment #5
longwaveOpened #3499809: Handle all paths in OpenAPI request validation as a first step.
Comment #6
wim leersI think part of this has been handled in
\Drupal\Tests\experience_builder\Unit\DxRouteConsistencyTestin #3499703: Make all XB HTTP API routes consistently prefixed, ensure they all have OpenAPI specs, and tests to keep it so.Comment #7
wim leersI think only docs remain.
Comment #8
traviscarden commentedhttps://www.youtube.com/watch?v=fWKB8zdVM-U 😉
Comment #9
lauriiiComment #11
wim leersUnassigning per #3558237: Simplify Code Owners configuration. Doesn't need to be me 😊