Template API conventions for single and bulk endpoints

Takeaways

  • Naming of bulk

    • We are doing a single operation for several items in bulk

    • In Define UI we have “bulk actions” where we do operations on lists of items as well.

  • Use single endpoints by default

  • Use bulk when there is a need

  • Bulk endpoints are consistent with conventions and single endpoints

  • Bulk + Single based on generic microservices

    • Will be extended

    • Excellent code reuse, good dev speed

  • Bulk endpoints could be reworked as:

    • Now: /v3/{contextGuid}/concept/relatedConcept

    • New: /v3/{contextGuid}/concept-relatedConcept

    • Now: /v3/{contextGuid}/concept/versions

    • New: /v3/{contextGuid}/concept-versions