Skip to content

Commit c8d2085

Browse files
[GPCAPIM-304] Update repo documentation (#106)
<!-- markdownlint-disable-next-line first-line-heading --> ## Description Update the repository's documentation. ## Context Given we are at the end of Steel Thread, a number of documents need to be updated to better reflect the current behaviours and technologies. ## Type of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply. --> - [x] 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 <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [x] I have followed the code style of the project - [ ] I have added tests to cover my changes - [x] I have updated the documentation accordingly - [ ] This PR is a result of pair or mob programming - [ ] Exceptions/Exclusions to coding standards (e.g. #noqa or #NOSONAR) are included within this Pull Request. --- ## 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)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public) 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. - [x] I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.
1 parent bbadb98 commit c8d2085

38 files changed

Lines changed: 691 additions & 2813 deletions

.github/instructions/copilot-instructions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ The container must be running in order to successfully run any of the test suite
2424

2525
The schema for this API can be found in `gateway-api/openapi.yaml`.
2626

27+
## Code reviews
28+
29+
When reviewing code, ensure you compare the changes made to files to all README.md containing directory structures, and update the directory structures accordingly.
30+
2731
## Docstrings and comments
2832

2933
- Use precise variable and function names to reduce the need for comments

README.md

Lines changed: 149 additions & 71 deletions
Large diffs are not rendered by default.

bruno/README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,38 @@
11
# Bruno
22

3+
## Bruno/ Structure
4+
5+
```text
6+
bruno/
7+
├── README.md
8+
└── gateway-api/
9+
├── workspace.yml # Bruno workspace configuration
10+
└── collections/
11+
├── Steel_Thread/ # Steel Thread request collection
12+
│ ├── bruno.json # Bruno collection metadata
13+
│ ├── collection.bru # Collection-level headers, auth config
14+
│ ├── .env.template # Template for required env vars (see below)
15+
│ ├── Access_Structured_Record.bru # Request: POST $gpc.getstructuredrecord
16+
│ └── environments/ # Per-target environment configs
17+
│ ├── local.bru # Points at local container
18+
│ └── PR_Proxy.bru # Points at Apigee PR proxy
19+
```
20+
21+
> **Note:** `.env` files are git-ignored and must be created locally from the `.env.template`.
22+
323
## `gateway-api` Workspace
424

525
### Steel Thread Collection
626

727
#### Environment Setup
828

9-
The collection pulls in secrets from a `.env` file from the top level of the collection, `bruno/gateway-api/preview-env`. To reference these variables within the collection you use `{{process.env.<key>}}`, where `<key>` is the environment variable name in `.env`.
29+
The collection pulls in secrets from a `.env` file at the top level of the collection (`bruno/gateway-api/collections/Steel_Thread/.env`). To reference these variables within the collection you use `{{process.env.<key>}}`, where `<key>` is the environment variable name in `.env`.
1030

11-
There is a template `.env` file, `bruno/gateway-api/collections/preview-env/.env.template`, to fill in as described below.
31+
There is a template `.env` file, `bruno/gateway-api/collections/Steel_Thread/.env.template`, to fill in as described below.
1232

1333
##### Test application
1434

15-
The proxy for Gateway API is hosted in Apigee. In order to call an Apigee proxy, a consumer of the API needs an Apigee application. As such, we need an Apigee application through which we can test our API. A static test application has been created for this purpose. You can view its details by going through In order to view its details, go to [the Clinical Data Sharing APIs applications](https://dos-internal.ptl.api.platform.nhs.uk/). when making a call to the API through the proxy, the test applications API key and secret are fed in to the OAuth 2.0 journey as the `CLIENT_KEY` and `CLIENT_SECRET` respectively. As such, you will need a `bruno/gateway-api/preview-preview-env/.env` file containing
35+
The proxy for Gateway API is hosted in Apigee. To call this proxy, you need an Apigee application. A static test application has been created for this purpose. You can view its details in [the Clinical Data Sharing APIs applications](https://dos-internal.ptl.api.platform.nhs.uk/). When making a call to the API through the proxy, the test application's API key and secret are fed into the OAuth 2.0 journey as the `CLIENT_KEY` and `CLIENT_SECRET` respectively. As such, you will need a `bruno/gateway-api/collections/Steel_Thread/.env` file containing
1636

1737
```plaintext
1838
CLIENT_ID=<test application's api key>

docs/adr/ADR-001_Use_git_hook_and_GitHub_action_to_check_the_editorconfig_compliance.md

Lines changed: 0 additions & 148 deletions
This file was deleted.

docs/adr/ADR-002_Scan_repository_for_hardcoded_secrets.md

Lines changed: 0 additions & 149 deletions
This file was deleted.

0 commit comments

Comments
 (0)