Skip to content

Conversation

@eddalmond1
Copy link
Collaborator

@eddalmond1 eddalmond1 commented Mar 21, 2025

Description

Experimenting with using existing tooling to generate a postman collection, driven entirely off the specification file. I opted for https://github.com/apideck-libraries/portman/ mainly because it uses openapi-to-postman but was 'friendlier' in terms of actually generating the examples in the specification in the postman collection. There's a lot of extra functionality we might explore as well, if we decide it's a good fit for us (contract tests and nice CI/CD integration, for example).

Context

We ideally would provide a postman collection to our consumers to aid in their development and testing.

Type of changes

  • Refactoring (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I am familiar with the contributing guidelines
  • I have followed the code style of the project
  • I have added tests to cover my changes
  • I have updated the documentation accordingly
  • This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

  • I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

@acerathereinspirative-nhs-nvir
Copy link
Contributor

acerathereinspirative-nhs-nvir commented Mar 25, 2025

Might be worth adding something to the README about this? I'm not sure how to run it!

(Or am I just missing it?)

@acerathereinspirative-nhs-nvir
Copy link
Contributor

Running make convert-postman from the project root gives me

Step 4/5 : COPY ../eligibility-signposting-api.yaml .
COPY failed: forbidden path outside the build context: ../eligibility-signposting-api.yaml ()

Copy link
Contributor

@ivma1-nhs ivma1-nhs left a comment

Choose a reason for hiding this comment

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

Reviewed and tested! Approved

@eddalmond1 eddalmond1 merged commit 07b1b9d into main Apr 8, 2025
23 checks passed
@eddalmond1 eddalmond1 deleted the feature/eja-eli-173-create-postman-collection-automagically branch May 21, 2025 13:47
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