-
Notifications
You must be signed in to change notification settings - Fork 45
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
FORMS-1327: Add proxy, externalAPI and adminExternalAPI to open api spec #1537
FORMS-1327: Add proxy, externalAPI and adminExternalAPI to open api spec #1537
Conversation
app/src/docs/v1.api-spec.yaml
Outdated
endpointUrl: | ||
type: string | ||
format: url | ||
description: Name of the ExternalApi - unique per form. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe change to "URL endpoint used for the external api"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch, thanks. Fixing.
app/src/docs/v1.api-spec.yaml
Outdated
endpointUrl: | ||
type: string | ||
format: url | ||
description: Name of the ExternalApi - unique per form. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe change to "URL endpoint used for the external api"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See above. Thanks.
Signed-off-by: Jason Sherman <[email protected]>
Reading the deployed documentation might help prevent errors due to formatting (and make the reading a little easier). |
Description
Updating the Open API spec to include apis related to External API.
These include the calls for :
Type of Change
docs (change to documentation
Checklist
Further comments