netlify / netlify/open-api

Scope post_processing vs post-processing

Open Beginner friendly
#578 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The documentation of getEnvVars lists the scope post-processing whereas for getSiteEnvVars it's post_processing.

This should be consistent. I assume that post-processing is wrong, because running netlify api getEnvVars does also list post_processing. (I found 7 occurrences of post-processing in current sources though.)

See also
https://github.com/netlify/open-api/blob/d582bdbbc73abbe8bdaf5411a35f9b11282009fa/swagger.yml#L250
vs
https://github.com/netlify/open-api/blob/d582bdbbc73abbe8bdaf5411a35f9b11282009fa/swagger.yml#L358

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 in swagger.yml at the getEnvVars and getSiteEnvVars entries linked in the issue, then search the specification for all seven occurrences of post-processing. Confirm the scope spelling against the CLI behavior described in the issue and update the inconsistent documentation so the scope is consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.