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

FORMS-1327: Add proxy, externalAPI and adminExternalAPI to open api spec #1537

Merged

Conversation

usingtechnology
Copy link
Collaborator

Description

Updating the Open API spec to include apis related to External API.
These include the calls for :

  • managing the External API for a form
  • CHEFS administration functions for approving External APIs
  • generating the proxy headers and calling the proxy (external) api.

Type of Change

docs (change to documentation

Checklist

  • I have read the CONTRIBUTING doc
  • I have checked that unit tests pass locally with my changes
  • I have run the npm script lint on the frontend and backend
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • I have approval from the product owner for the contribution in this pull request

Further comments

endpointUrl:
type: string
format: url
description: Name of the ExternalApi - unique per form.
Copy link
Collaborator

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"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, thanks. Fixing.

endpointUrl:
type: string
format: url
description: Name of the ExternalApi - unique per form.
Copy link
Collaborator

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"?

Copy link
Collaborator Author

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]>
@WalterMoar
Copy link
Collaborator

Reading the deployed documentation might help prevent errors due to formatting (and make the reading a little easier).

@usingtechnology usingtechnology merged commit 9f12655 into bcgov:main Dec 5, 2024
5 checks passed
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

Successfully merging this pull request may close these issues.

3 participants