`metadata.nullable` is inconsistent (E.g. customer vs subscription)
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 30/100
- Issue type
- Bug
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- openapi
- Domain
- api
Research direction
Start by comparing the Customer and Subscription schema definitions for metadata, especially their required-field lists and the shared documentation shown in the issue. Confirm the intended requiredness with the project’s OpenAPI conventions, then update the specification so the schema and generated documentation agree.
Written by the indexing model from the issue text.
Description
Both the Customer and Subscription schema have a metadata property:
"metadata": {
"additionalProperties": {
"maxLength": 500,
"type": "string"
},
"description": "...",
"type": "object"
},
But the Subscription lists metadata in the required fields list:
"required": [
"metadata",
],
Does this imply that the metadata field is nullable for the customer object, but not for the subscription object?
Why is metadata required on the subscription but not the customer?
The docs both show this for both objects (no required tag):
- Dominant language
- No language data
- Stars
- 503
- Forks
- 148
- Avg merge
- 6d 14m
- Merged PRs (30d)
- 5
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from stripe/openapi
-
future
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
enhancement future
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 42/100
-
future
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
getgrav/grav-plugin-api#45 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·