Problem/Motivation

The API provided by Drupal core is not easily discoverable.

Steps to reproduce

Proposed resolution

Bring a module like OpenAPI so that the API is self documenting.

Remaining tasks

User interface changes

API changes

Data model changes

Comments

nod_ created an issue. See original summary.

e0ipso’s picture

e0ipso
Primary language Catalan
Location Can Picafort
commented
Title: Expose API documentation » [PP-1] Expose API documentation
Related issues: +#3031214: Introduce "deterministic" normalizers, +#3031367: Generate JSON schema for content entity types

The problems stated some years back in https://www.lullabot.com/articles/decoupled-drupal-hard-problems-schemas still apply.

This issue is blocked by: #3031367: Generate JSON schema for content entity types, which is in turn blocked by #3031214: Introduce "deterministic" normalizers.

e0ipso’s picture

e0ipso
Primary language Catalan
Location Can Picafort
commented
Title: [PP-1] Expose API documentation » [PP-1] Expose auto-generated documentation from API schema
e0ipso’s picture

e0ipso
Primary language Catalan
Location Can Picafort
commented
Issue summary: View changes
Issue tags: +Needs issue summary update