[Json-Schema] Nested resources lost externalDoc and description data
维护者通常 1 天内回复
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 68/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- php
调研方向
Start by reading the change in src/Hydra/JsonSchema/SchemaFactory.ph introduced by #8652, which the report identifies as the source of the regression. Reproduce the example with nested SchemaThing resources and compare the generated JSON OpenAPI output before and after the change. Done means the nested resource retains its documentation and externalDocs data.
由索引模型根据 Issue 内容生成。
描述
API Platform version(s) affected: 5.0.4
Description
We have some shared api schemas that are linked to schema.org specs, and the generated jsonopenapi spec file contained this information. But after updating to the latest version, we lost these details.
Both the documentation and externalDocs fields are now empty.
screenshots
Before:After:
How to reproduce
#[Get(provider: EntityStateProvider::class, processor: EntityStateProcessor::class)]
class Entity
{
public function __construct(
#[ApiProperty(identifier: true)]
public int $id,
#[ApiProperty(readableLink: true)]
public SchemaThing $thing
)
{
}
}
#[ApiResource(description: "A schema type", types: ['https://schema.org/Thing'], operations: [])]
class SchemaThing
{
#[ApiProperty(description: "The name of the item.", iris: ['https://schema.org/name'])]
public string $name;
#[ApiProperty(description: "An alias for the item.", iris: ['https://schema.org/alternateName'])]
public string $alternateName;
}
Additional Context
If I revert the change in src/Hydra/JsonSchema/SchemaFactory.ph by #8652 the issue is fixed
- 主要语言
- PHP
- 星标
- 2.6k
- 派生
- 988
- 平均合并
- 1 天 19 小时
- 30 天内合并 PR
- 108
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
api-platform/core 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
api-platform/core#8744 ·
维护者通常 1 天内回复
-
JSON:API: resource schemas (`*.jsonapi`) have `properties` but no `type: object`可能已有人在做 @ousamabenyounes 于 6 天前认领。 未关闭
难度 2/5 1 小时以内 新手友好度 80/100
api-platform/core#8701 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 50/100
api-platform/core#8704 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 62/100
api-platform/core#8703 ·
维护者通常 1 天内回复
-
难度 5/5 一周以上 新手友好度 8/100
api-platform/core#8697 ·
维护者通常 1 天内回复
查看 api-platform/core 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 64/100
维护者通常 1 天内回复
-
PHP SDK drops the API path prefix when a custom base URL has no trailing slash可能已有人在做 @Winoren 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
langgenius/dify#44568 · 1 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
1. to develop bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
awslabs/aidlc-workflows#2921 ·
维护者通常 1 天内回复
-
Bug Status: Needs Triage
难度 2/5 1-3 小时 新手友好度 73/100
维护者通常 1 天内回复