Update documentation

[ktunkiewicz]

• updates the documentation to use api.currencyfair, instead of xsapi.currencyfair.com.
• not using Amazon specific headers, as this documentation now describes direct access to our API, not using the proxy
• 2 versions of documentation, documenting the auth_token and authorization_code modes of operation

[Copilot]

🟡 Changes recommended

The rates scripts reference a missing specification file, and the documented npm command is invalid.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Updates API documentation for direct access through api.currencyfair.com and introduces rates-only documentation commands.

Changes:

• Removes API-key requirements from the OpenAPI specification.
• Adds rates-only serve, build, and lint scripts.
• Documents local startup commands.

File summaries

File	Description
Readme.md	Adds rates-only startup instructions.
package.json	Adds rates documentation scripts.
currencyfair.yaml	Updates hostname and authentication requirements.

Review details

Suppressed comments (2)

package.json:15

• The rates bundle also references the absent currencyfair-rates.yaml, so build-rates cannot produce the second documentation version described by this PR. Add that specification or target an existing file.

    "build-rates:docs": "redoc-cli bundle currencyfair-rates.yaml -t template/index.hbs --output dist/index.html --options.hideHostname=1 --options.noAutoAuth=1 --options.requiredPropsFirst=1 --options.theme.colors.primary.main=#6799b6 --options.theme.schema.linesColor=#eeeeee --options.theme.rightPanel.backgroundColor=#32323c --options.theme.typography.fontFamily=\"Post Grotesk,Tahoma,sans-serif;\" --options.theme.typography.headings.fontFamily=\"Post Grotesk Book,Tahoma,sans-serif;\" --options.theme.logo.gutter=\"15px 30px\" --options.theme.logo.maxWidth=\"90%\"",

package.json:18

• The new lint target points to the absent currencyfair-rates.yaml, causing lint-rates (and therefore build-rates) to fail before bundling. Add the specification or use an existing input file.

    "lint-rates": "openapi lint currencyfair-rates.yaml"

• Files reviewed: 3/3 changed files
• Comments generated: 3
• Review effort level: Balanced

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Copilot]

🟡 Changes recommended

The rates specification has incorrect authentication metadata and is not included in deployment workflows.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

Suppressed comments (1)

currencyfair.yaml:14

• Add the missing article and use the standard “RESTful” spelling.

    The CurrencyFair API is REST-ful API that allows approved API users to perform various operations on their CurrencyFair wallet.

• Files reviewed: 4/4 changed files
• Comments generated: 3
• Review effort level: Balanced

[ktunkiewicz]

Copilot comments are somehow valid, but don't matter in our case. The documentation renders correctly into HTML files, we don't plan to deploy the currencyfair-rates version. The auth section is also good-ish - we simply don't follow strict oauth spec with this endpoint.