Review docs for createSite endpoint - repo id type
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 323
- Forks
- 133
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 2
Description
A customer in the forums mentioned that they were trying to use the createSite endpoint to connect to a Bitbucket repo. They were confused as the open-api docs say the repo id (in the repoInfo object) should be an integer but they could only find a string value from Bitbucket.
The string value worked correctly for the user and Fool was able to confirm that both integer and string are accepted on Slack.
This issue is to review whether we might be able to update the docs to include both types (and update the docs, if possible). Also relates to https://github.com/netlify/open-api/issues/131.
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.
Research direction
Start with the createSite operation in the OpenAPI documentation and inspect the repoInfo object, especially the repo id type. Confirm whether the endpoint accepts both integer and string values, then update the documentation to describe both accepted types if the specification permits it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100