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

Update id_lookup_controller.rb API Examples #2690

Merged
merged 4 commits into from Apr 29, 2022
Merged

Update id_lookup_controller.rb API Examples #2690

merged 4 commits into from Apr 29, 2022

Conversation

crugas
Copy link
Contributor

@crugas crugas commented Apr 21, 2022

Provides shell and python examples for endpoints in the id_lookup_controller.rb file.

Description

Adds examples to the 4 endpoints in the file, as well as updates the description of the :resolve parameter to better clarify usage. /repositories/:repo_id/find_by_id/resources still needs a shell example and an example searching via ARK for python.

This change is required to help users reference the API for examples when building their own code to access and take advantage of the API.

Related JIRA Ticket or GitHub Issue

N/A*

  • Will add JIRA ticket to add shell and ARK example to /repositories/:repo_id/find_by_id/resources

How Has This Been Tested?

N/A

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have read the CONTRIBUTING document.
  • I have authority to submit this code.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@crugas crugas marked this pull request as ready for review April 21, 2022 20:04
@cdibella cdibella added this to the 3.2.1 milestone Apr 27, 2022
@quoideneuf quoideneuf merged commit 813034d into archivesspace:master Apr 29, 2022
@cdibella cdibella added the community code contributed by community members not on or contracted by the ArchivesSpace program team label Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community code contributed by community members not on or contracted by the ArchivesSpace program team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants