feat: publish RFC 9727 api-catalog and homepage Link headers - #1407
Merged
Merged
Conversation
Served from Express on postcodes.io and api.postcodes.io. express.static skips dotfiles, so the catalog is a route rather than a static file.
Member
|
🎉 This issue has been resolved in version 20.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/.well-known/api-catalogon postcodes.io and api.postcodes.io: linkset pointing at the OpenAPI spec, API docs and/ready, withContent-Type: application/linkset+json; profile="https://www.rfc-editor.org/info/rfc9727"andLink: </.well-known/api-catalog>; rel="api-catalog"(GET and HEAD).Linkheader to the homepage (catalog, spec, docs).express.staticskips dotfiles. Kept inapi/config/well_known.tswith two lines inroutes.ts.Test plan
pnpm test(newtest/well_known.integration.ts: GET/HEAD catalog headers and shape, homepage Link)postcodes.io/if the homepage is edge-cached, thencurl -i https://postcodes.io/.well-known/api-catalogandcurl -I https://postcodes.io/POST https://isitagentready.com/api/scan {"url":"https://postcodes.io"}passesdiscovery.apiCataloganddiscoverability.linkHeadersNeed help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.