netlify / netlify/open-api

Mark properties as required when it makes sense.

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement specification
Dominant language
Go
Stars
323
Forks
133
Avg merge
2d 8h
Merged PRs (30d)
2

Description

We should mark properties in the definitions as required when it's necessary. That way the generator will create validations for all the POST endpoints to verify those fields in the client side.

See the simple model example: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#simple-model

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the definitions and the linked OpenAPI simple model example, then trace how the generator handles POST endpoints and client-side validations. Done means the necessary properties are marked as required and the generator creates validations for those fields.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.