Card API Review Level 1

[christiangmehling]

Goal

In this Pull Request all feedback to the proposed Level 1 of the SFTI Common API Card API is collected. When all feedback is incorporated a version 1.0 of the standard will be published.

Instructions

Please review the files cardInfoAPI-Level1.yaml and operationalGuide.md. The cardInfoAPI.yaml can be ignored.

The cardInfoAPI-Level1.yaml is the Swagger specification. For easier readability you can review the file in the Swagger Editor view: Link

The operationalGuide.md is the markdown version of the Operational Guide. For easier readability you can either select to "Display the rich diff" directly in the Pull Request or in the Wiki (pages in section "API specific Information").

In order to capture a comment on the files please follow the general GitHub instructions here: GitHub Docs - Review proposed changes
You might also be interested in the GitHub Docs section about Comment on a PR or View a PR review.

Note that you can also vote and react to existing comments. Please use this functionality to make it easier for the core team to consolidate the feedback.

Every user with a GitHub login can comment, no special access rights are needed.

Timeline

The review is open until 28th June. The Card API core team will review the received feedback afterwards and seek alignment with individual reviewers where needed.

[christiangmehling]

Dear Reviewer

thank you for your valuable feedback. Please provide your feedback on the corresponding point in this file and include your feedback in the follow structure:

• Title:
• Question/Feedback:
• Suggestion for improvement:

Please start with describing your Feedback or asking your Question regarding a specific component in the spec. For overall questions or remarks please use the comment function for the whole file. Make sure your feedback is not collected already, if so, please like the feedback or add further issues or clarifications as reply to the comment.

It might be very helpful if you suggest improvements for the core team to elaborate your feedback. Thus we ask you to share all your relevant thoughts on this topic and feel free to share any solutions to your issue. This will improve further discussion and allow people to refactor your suggestions. The core team will come back to your feedback as needed.

[aba-ellinger]

Thanks for the good work.

[MartinRenggli]

It is important that the operational guide is solidly defined before APIs are finally defined. Currently, the quality of this guide is not yet sufficient. Some basic clarifications and enhancements are still required before the APIs are addressed. Otherwise, there is a risk that the foundation will need to be improved again and again.