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

First shot at REST docs #1046

Merged
merged 8 commits into from
Mar 16, 2019
Merged

First shot at REST docs #1046

merged 8 commits into from
Mar 16, 2019

Conversation

whikloj
Copy link
Member

@whikloj whikloj commented Mar 5, 2019

GitHub Issue: #1040

What does this Pull Request do?

Adds some documentation around the use of REST with Drupal 8 and Islandora 8.

What's new?

Docs.

How should this be tested?

Read it for typos, clarity and stupidity. Provide any and all suggestions. Additional PRs will cover PATCH and DELETE.

This hopefully covers

  • REST API Overview
  • Retrieving Data with GET
  • Creating nodes with POST
  • Adding Media to Nodes with PUT

in the Documentation sprint spreadsheet (https://docs.google.com/spreadsheets/d/1wI_K5Y0XJSIBXoJ84VxObcy8TT07TuypIE_P3C0rnzU/edit#gid=0)

Interested parties

@Islandora-CLAW/committers

@mjordan
Copy link
Contributor

mjordan commented Mar 5, 2019

I've signed up to review this and will do so in the next few days.

@mjordan mjordan self-requested a review March 5, 2019 23:42
Copy link
Contributor

@mjordan mjordan left a comment

Choose a reason for hiding this comment

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

Looks good to me so far.

docs/technical-documentation/rest-get.md Show resolved Hide resolved
@mjordan
Copy link
Contributor

mjordan commented Mar 15, 2019

Won't have a chance to test the DELETE docs today but they look good. Can test over the weekend though.

@whikloj
Copy link
Member Author

whikloj commented Mar 15, 2019

I promise this PR is now finished, pending any review suggestions/comments. I will not add any new content to this PR.

@mjordan
Copy link
Contributor

mjordan commented Mar 16, 2019

All tested, merging. Nice work @whikloj!

@mjordan mjordan merged commit c4cbab2 into Islandora:master Mar 16, 2019
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.

5 participants