Skip to content

eli-225 adding back in poetry, updating make and readme#7

Merged
eddalmond1 merged 19 commits intomainfrom
feature/eja-eli-225-fixing-make
May 1, 2025
Merged

eli-225 adding back in poetry, updating make and readme#7
eddalmond1 merged 19 commits intomainfrom
feature/eja-eli-225-fixing-make

Conversation

@eddalmond1
Copy link
Collaborator

@eddalmond1 eddalmond1 commented Apr 30, 2025

Description

Adding capabilities to construct and publish the specification for different environments.

Context

We need this for interaction with APIM infrastructure

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.

Copy link
Contributor

@jhadfield-NHS jhadfield-NHS left a comment

Choose a reason for hiding this comment

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

LGTM
Couple of thoughts/qs, but nothing blocking.

@@ -1 +1 @@
$ref: https://proxygen.ptl.api.platform.nhs.uk/components/securitySchemes/app-level0
$ref: https://proxygen.prod.api.platform.nhs.uk/components/securitySchemes/app-level0
Copy link
Contributor

Choose a reason for hiding this comment

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

Ultimately, I think we should remove any auth from the Sandbox version - but I'm not 100% certain.
Does the app-level0 do that for us?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It doesn't, it requires an API key in the header. I'll remove here and see what the generated specification looks like

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It becomes tricky as we've hardcoded some of the structure in the main spec, and setting an empty value/object/type here fails validation. Best way I can think to do right now is, when we generate the sandbox json file, remove the securityScheme section completely using yq

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added the change

@eddalmond1 eddalmond1 merged commit 10a994a into main May 1, 2025
23 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.

2 participants