2020-09-14 API Working Group meeting notes

Date

Sep 14, 2020

Participants

• @Alicia Detelich

• Bobbi Fox

• Eric Hanson

• David W. Hodges

• @Dave Mayo (Unlicensed)

• Don Mennerich

• Corey Schmidt

• @Trevor Thornton

• @Lora Woodford

Goals

• Catch up

• Discuss plan for implementation

• Determine next steps

Discussion topics

• Review work from last term

  • Demo/training videos: API docs training

  • Spreadsheet to track the work: https://docs.google.com/spreadsheets/d/1VTt6CJNIRkOkXZhtbHMedUQay16QiE1QhI2rWEPCXB8/edit?usp=sharing

• Each person should select a controller (or a set of related endpoints) to work on (based on how needy the existing info is, and personal preference) and add their name in the “Volunteer” column in the corresponding rows on the spreadsheet

• Enhancements can be added 2 ways:

  • Roll your own pull request:

    • Fork AS master

    • create a branch for your changes

    • make changes and test

    • create a PR to ArchivesSpace from the branch

  • Provide info to Dave to roll into a PR:

    • Add documentation and/or examples in the “Documentations” and/or “Examples” tab on the spreadsheet

    • Use comments to @ Dave to alert him to the addition

    • Dave will incorporate changes into a PR

• Any improvements are improvements - don’t stress about making things perfect and totally complete

• Usage examples can be:

  • curl commands

  • Python (using ArchivesSnake)

  • Other (Ruby, Javascript, PHP) - people seem to prefer Python

• Since CURL us the de facto default, if there is no CURL example some default text should display to say so - Lora will write this?

• We’ll use the group email list for communication

  • Strongly consider sharing your work with the group via the list before submitting a PR

  • Feel free to ask questions of the group, and feel obliged to offer answers if you have them

  • We’ll see how effectively we can work over email alone, in lieu of regularly recurring meetings

Action items

Decisions