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
When communicating across organizations, it can be awkward to say "the
POST /test-interface/datasets/:testDatasetIdentifier/opportunitiesendpoint".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 /test-interface/datasets/:testDatasetIdentifierPOST /test-interface/datasets/:testDatasetIdentifier/opportunitiesPOST /test-interface/actions