docs(tests): Document Request Templates #569
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To make it clear that they relate to cancellation and rejection
lukehesluke
commented
Sep 8, 2023
| @@ -2,8 +2,8 @@ const { FlowStage } = require('./flow-stage'); | |||
| const { FlowStageUtils } = require('./flow-stage-utils'); | |||
|
|
|||
| /** | |||
| * @typedef {import('../../templates/u-req').UReqTemplateData} UReqTemplateData | |||
| * @typedef {import('../../templates/u-req').UReqTemplateRef} UReqTemplateRef | |||
| * @typedef {import('../../templates/cancel-order-req').CancelOrderReqTemplateData} CancelOrderReqTemplateData | |||
There was a problem hiding this comment.
This U thing must refer to an earlier part of the spec or something? I've renamed these to be clearer to newer maintainers, using language that more or less mirrors the current spec.
All the changes in every file except README.md was just a set of simple VSCode refactors
civsiv
reviewed
Sep 12, 2023
| /** | ||
| * @param {string} [orderProposalStatus] | ||
| */ | ||
| function createStandardRejectOrderProposalReq(orderProposalStatus = 'https://openactive.io/CustomerRejected') { |
There was a problem hiding this comment.
I like this rename of the file, makes a lot more sense
civsiv
approved these changes
Sep 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #566
Also:
The test/templates/README.md is already linked to from ..integration-tests/CONTRIBUTING.md in this PR: #565, so this should be visible to maintainers