Skip to content

docs: Provide example curl requests to CODE/PROD #16377

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.

Sign up for GitHub

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

Open
akash1810 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Provide example curl requests to CODE/PROD #16377

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions dotcom-rendering/docs/contributing/how-to.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,31 @@ To make requests to the API from your local machine, use the [SOCKS proxy](https
2. Run the `browse-with-socks-proxy` script from the [`guardian/platform` repo](https://github.com/guardian/platform/blob/main/scripts/browse-with-socks-proxy):
This will start a new instance of the Chrome browser with a SOCKS proxy configured to route request via an EC2 instance in the VPC.
You can now browse the DCR API on CODE/PROD from this browser instance.

### Using `curl`

It is worth mentioning the CORS configuration of DCR in CODE/PROD limits what can be done in the browser; `curl` might be better for your use-case.

For example, to interact with a `POST` endpoint, first connect to the SOCKS proxy instance with [guardian/ssm-scala](https://github.com/guardian/ssm-scala):

@adamnfish-gu adamnfish-gu Jul 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The DevX/Security team are actively deprecating this tol as we speak. Can we document the native AWS SSM version of this instead?

@akash1810 akash1810 Jul 14, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Can we document the native AWS SSM version of this instead?

Sure! Does this already exist as part of the deprecation plan?

@akash1810 akash1810 Jul 15, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I'm not sure this needs to be blocking?


```bash
ssm ssh -t frontend,INFRA,socks-proxy --user ec2-user --newest --profile frontend -x
```

Then make a request:

```bash
curl -s "https://www.theguardian.com/tone/minutebyminute.json?dcr=true" | \
curl -X POST https://tag-page-rendering.code.dev-guardianapis.com/TagPage -H "Content-Type: application/json" -d @-
```

To discard the response body and show the response headers:

```bash
curl -s "https://www.theguardian.com/tone/minutebyminute.json?dcr=true" | \
curl -s -X POST https://tag-page-rendering.code.dev-guardianapis.com/TagPage \
-H "Content-Type: application/json" \
-d @- \
-D - \
-o /dev/null
```
Loading