2020-05-14 API Working Group meeting notes
- Trevor Thornton
Date
May 14, 2021
Participants
@Alicia Detelich
@Bobbi Fox
Eric Hanson
David W. Hodges
@Dave Mayo (Unlicensed)
Don Mennerich
@Corey Schmidt (Unlicensed)
@Trevor Thornton
@Lora Woodford
@Brian Hoffman (Unlicensed)
Goals
Meet Brian Hoffman
Figure out how to get this work done with the help of ArchivesSpace development team
Review the spreadsheet as needed: https://docs.google.com/spreadsheets/d/1VTt6CJNIRkOkXZhtbHMedUQay16QiE1QhI2rWEPCXB8/edit#gid=0
Discussion topics
How can working group members help prioritize updates to existing endpoint documentation?
How can WG members effectively share Python/ASnake examples with devs for inclusion in documentation?
What else can we do to expedite this project in the next year?
Action items
Decisions
API Documentation Working Group members will submit our recommended updates to the API documentation as JIRA tickets (one per endpoint), which the developers, in consultation with the Development Prioritization team, will address in the course of making other changes in preparation for upcoming releases. This should provide a way for the Working Group and the devs to share the load, with the WG members providing updated documentation without having to go through the process of building, testing and submitting pull requests, which may have been an inhibitor to progress up to this point.
There are improvements that can be made to the way CURL examples are generated, notably in the use of random strings as placeholder values for URIs. This, and other improvements to the build process for API docs, will be explored by the development team.
The addition of Python/ArchivesSnake examples requires further discussion. While we want to support the significant number of Python users in the community, there's some concern that this work may be beyond the scope of what the developers at Lyrasis should take on. To be continued...