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

traviscarden created an issue. See original summary.

traviscarden’s picture

Issue summary: View changes
wim leers’s picture

Version: » 0.x-dev
Component: Page builder » Internal HTTP API
Priority: Normal » Critical
Issue tags: +DX (Developer Experience), +maintainability
Related issues: +#3486203: Integrate saving sections with the backend: (de)normalize Pattern config entities using the client-side data model
wim leers’s picture

Also:

Add test coverage for \Drupal\experience_builder\Controller\ApiComponentsController this will also give us OpenAPI validation of the response

— @larowlan at #3499536: Move PropSourceEndpointTest to XbConfigEntityHttpApiTest::testComponent(), emphasis mine.

longwave’s picture

wim leers’s picture

wim leers’s picture

Title: Lay out a strategy for OpenAPI integration » Document where the cut-off lies of where OpenAPI validation ends and entity validation begings
Component: Internal HTTP API » Documentation
Assigned: traviscarden » wim leers
Priority: Critical » Major

I think only docs remain.

traviscarden’s picture

Title: Document where the cut-off lies of where OpenAPI validation ends and entity validation begings » Document where the cut-off lies of where OpenAPI validation ends and entity validation begins
lauriii’s picture

Issue tags: -stable blocker

Project: Experience Builder » Drupal Canvas
Version: 0.x-dev » 1.x-dev

Experience Builder has been renamed to Drupal Canvas in preparation for its beta release. You can now track issues on the new project page.

wim leers’s picture

Assigned: wim leers » Unassigned

Unassigning per #3558237: Simplify Code Owners configuration. Doesn't need to be me 😊