netlify / netlify/open-api

siteSetup contains more properties than is needed for createSite operation

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

Nobody has claimed this yet.

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

Description

The createSite operation in the Open API specification uses the siteSetup definition for the body but that object appears to contain many more properties than are relevant for the operation. The API docs only mention name, custom_domain, password, force_ssl, processing_settings (see #47), and repo. Wondering if a new object definition should be created and referenced for the createSite operation?

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 locating the createSite operation and its siteSetup definition in the Open API specification. Compare the definition's properties with the properties listed in the issue and determine whether a separate request object is needed; done means createSite references an appropriately scoped schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.