Shopify / Shopify/shipit-engine
Documentation on API Usage
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.5k
- Forks
- 154
- Avg merge
- 2h 26m
- Merged PRs (30d)
- 3
Description
We are interested in adding some slack integrations for certain features like locking stacks. I saw that there is some Api controllers, but it wasn't clear to me the correct way to be using them or if they are supposed to be used for integrations or of they are internal. Is there any documentation on using the shipit API? Would creating an ApiClient and using the token be good use of the api controllers?
Thank you
Contributor guide
No contributing guide indexed for this repository
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 by reading the API controllers and the ApiClient and token usage mentioned in the issue. No specific files or tests are named, so first identify the public entry points and determine whether they support integrations. Done means documenting the supported API usage, authentication flow, and relevant locking-stack examples.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100