JSON:API: `JsonApiCollectionBaseSchemaNoPagination` declares `data` as `type: array` without `items`
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
调研方向
从 JsonApi\JsonSchema\SchemaFactory::buildSchema() 开始，找到 COLLECTION_BASE_SCHEMA_NAME_NO_PAGINATION 的定义，其中 data 被声明为 type: array 且没有 items。使用 Book 示例运行 bin/console api:openapi:export 复现问题，并用 OpenAPI 3.0 验证器检查输出。当 data 具有 items 模式（例如 {"type": "object"}）、3.0 文档通过验证且现有的 JSON:API 模式测试仍然通过时，即完成。
由索引模型根据 Issue 内容生成。
描述
API Platform version(s) affected
4.4.4
Description
When pagination is disabled on a GetCollection operation, the JSON:API collection response refers to JsonApiCollectionBaseSchemaNoPagination. In that schema, data is {"type": "array"} with no items.
OpenAPI 3.0 requires items when type is array, so 3.0 validators and some code generators reject the document. In 3.1 and 3.2 the schema is valid, but it says nothing about the members.
How to reproduce
#[ApiResource(operations: [
new Get(provider: [self::class, 'provide']),
new GetCollection(paginationEnabled: false, provider: [self::class, 'provideAll']),
])]
final class Book
{
public function __construct(public int $id = 1, public string $title = 'Dune') {}
public static function provide(): self { return new self(); }
/** @return list<self> */
public static function provideAll(): array { return [new self()]; }
}
Generated schema (shortened):
"JsonApiCollectionBaseSchemaNoPagination": {
"type": "object",
"properties": {
"links": { "...": "..." },
"meta": { "...": "..." },
"data": { "type": "array" }
},
"required": ["data"]
}
Expected: data has an items schema, for example {"type": "object"}. The concrete collection schema can still narrow it with allOf.
Possible Solution
Add 'items' => ['type' => 'object'] to data in the COLLECTION_BASE_SCHEMA_NAME_NO_PAGINATION definition in JsonApi\JsonSchema\SchemaFactory::buildSchema().
Additional Context
Checked on api-platform/core v4.4.4, Symfony 7.4, PHP 8.5, in an empty Symfony app. The code of JsonApi\JsonSchema\SchemaFactory on main is the same as in v4.4.4.
The app has only FrameworkBundle, TwigBundle and ApiPlatformBundle, with this config:
$c->extension('api_platform', [
'mapping' => ['paths' => ['%kernel.project_dir%/src/ApiResource']],
'formats' => ['jsonapi' => ['application/vnd.api+json']],
'docs_formats' => ['jsonopenapi' => ['application/vnd.openapi+json']],
'doctrine' => ['enabled' => false],
]);
The spec comes from bin/console api:openapi:export.
- 主要语言
- PHP
- 星标
- 2.6k
- 派生
- 989
- 平均合并
- 1 天 23 小时
- 30 天内合并 PR
- 102
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
api-platform/core 的其他 Issue
-
JSON:API: resource schemas (`*.jsonapi`) have `properties` but no `type: object`可能已有人在做 @ousamabenyounes 于 2 天前认领。 未关闭
难度 2/5 1 小时以内 新手友好度 80/100
api-platform/core#8701 ·
维护者通常 1 天内回复
-
api:openapi:export --spec-version=3.0.0 outputs `webhooks`, which is invalid in OpenAPI 3.0可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
api-platform/core#8690 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 85/100
api-platform/core#8680 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 68/100
api-platform/core#8725 ·
维护者通常 1 天内回复
-
[Json-Schema] Nested resources lost externalDoc and description data可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 3/5 1-2 天 新手友好度 68/100
api-platform/core#8721 ·
维护者通常 1 天内回复
查看 api-platform/core 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 84/100
nextcloud/integration_openai#446 ·
-
bug customer-reported
难度 2/5 1-3 小时 新手友好度 76/100
MagnaCapax/PMSS#1101 ·
维护者通常 5 天内回复
-
InvoiceSettled is answered 200 when the invoice cannot be re-fetched, so BTCPay never redelivers it未关闭
难度 2/5 1-3 小时 新手友好度 76/100
btcpayserver/woocommerce-greenfield-plugin#93 ·
维护者通常 1 天内回复
-
kind/bug status/triage
难度 2/5 1-3 小时 新手友好度 68/100
-
🐛 [Bug] Bulk CSV import stores hide_from_combined_view=FALSE as a string, which hides every account from Sent, Junk, Trash and Drafts可能已有人在做 @exSnake 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复