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

Name the Test Interface Endpoints? #13

Open
lukehesluke opened this issue Jan 25, 2022 · 0 comments
Open

Name the Test Interface Endpoints? #13

lukehesluke opened this issue Jan 25, 2022 · 0 comments

Comments

@lukehesluke
Copy link
Contributor

lukehesluke commented Jan 25, 2022

When communicating across organizations, it can be awkward to say "the POST /test-interface/datasets/:testDatasetIdentifier/opportunities endpoint".

It would be useful if they had clear names like "Create Test Opportunity", etc. In the same way that the Open Booking API spec has defined names for endpoints e.g. "Order Deletion".

These names should be clearly shown in the reference doc

Suggestions for names:

  • Delete Dataset - DELETE /test-interface/datasets/:testDatasetIdentifier
  • Create Test Opportunity - POST /test-interface/datasets/:testDatasetIdentifier/opportunities
  • Simulate Test Action - POST /test-interface/actions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant