mattpolzin / mattpolzin/JSONAPI-OpenAPI

sort out test properties "skipExample" such that request & response and multiple examples are accounted for.

未关闭
#9 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Swift
星标
12
派生
1
PR 合并指标
30 天内没有已合并 PR

描述

test properties currently just allow you to skip using the response example to validate response data or not.

  • there needs to be a way to use a request example as request body or not (and validate that it matches the schema for the request).
  • there needs to be a way to support multiple labeled examples instead of only supporting a single example.

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先定位对 skipExample 测试属性的处理,并了解当前如何使用响应示例。实现对独立使用和验证请求示例的支持,以及对多个带标签的请求示例和响应示例的支持;当两个示例方向和多个标签都得到正确表示时,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
openapi, swift
领域
documentation
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。