Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add /store endpoint to API schema #693

Merged
merged 2 commits into from
Nov 12, 2021
Merged

Conversation

yusefnapora
Copy link
Contributor

I started to add a note about content types to the API docs, but it seems that the /store endpoint wasn't in the schema, just /upload.

So this adds docs for the /store endpoint based on what I could glean from the code. Someone should probably look it over to make sure it's correct.

May need some formatting tweaks and so on - I wasn't able to run the website build locally, since my env isn't set up, so I haven't seen it rendered yet.

Also closes #490 - we actually allow all file types now, but I added a recommendation to only use images for the image field.

@yusefnapora
Copy link
Contributor Author

Hmm, I just realized that I didn't add docs for the response body. Will add tomorrow.

@alanshaw
Copy link
Contributor

alanshaw commented Nov 8, 2021

@yusefnapora ping

Copy link
Contributor

@Gozala Gozala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few suggestions to simplify things a bit, otherwise looks great! Thanks for doing this.

packages/website/public/schema.yml Outdated Show resolved Hide resolved
packages/website/public/schema.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@alanshaw alanshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please include @Gozala's changes before merging. Otherwise this is great.

packages/website/public/schema.yml Outdated Show resolved Hide resolved
packages/website/public/schema.yml Outdated Show resolved Hide resolved
packages/website/public/schema.yml Outdated Show resolved Hide resolved
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Nov 12, 2021

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: a9c2353
Status: ✅  Deploy successful!
Preview URL: https://0800a916.nft-storage-1at.pages.dev

View logs

@yusefnapora yusefnapora merged commit 82560e3 into main Nov 12, 2021
@yusefnapora yusefnapora deleted the feat/docs-mime-types branch November 12, 2021 16:13
@Gozala Gozala mentioned this pull request Nov 15, 2021
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Specify what file types are allowed in HTTP API docs
3 participants