fix: update OpenAPI externalDocs URL

fixes #3091
PostgREST · Jul 11, 2024 · 1452720 · 1452720
1 parent 6be5906
commit 1452720
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
  - #3644, Show number of timezones in schema cache load report - @wolfgangwalther
  - #3644, List correct enum options in OpenApi output when multiple types with same name are present - @wolfgangwalther
  - #3523, Fix schema cache loading retry without backoff - @steve-chavez
+ - #3091, Broken link in OpenAPI description `externalDocs` - @salim-b
 
 ### Changed
 

diff --git a/src/PostgREST/Response/OpenAPI.hs b/src/PostgREST/Response/OpenAPI.hs
@@ -402,7 +402,7 @@ postgrestSpec (prettyVersion, docsVersion) rels pds ti (s, h, p, b) sd allowSecu
  & description ?~ fromMaybe "This is a dynamic API generated by PostgREST" dDesc)
  & externalDocs ?~ ((mempty :: ExternalDocs)
  & description ?~ "PostgREST Documentation"
- & url .~ URL ("https://postgrest.org/en/" <> docsVersion <> "/api.html"))
+ & url .~ URL ("https://postgrest.org/en/" <> docsVersion <> "/references/api.html"))
  & host .~ h'
  & definitions .~ fromList (makeTableDef rels <$> ti)
  & parameters .~ fromList (makeParamDefs ti)

diff --git a/test/spec/Feature/OpenApi/OpenApiSpec.hs b/test/spec/Feature/OpenApi/OpenApiSpec.hs
@@ -42,7 +42,7 @@ spec = describe "OpenAPI" $ do
 
  let docsUrl = r ^? key "externalDocs" . key "url"
 
- liftIO $ docsUrl `shouldBe` Just (String ("https://postgrest.org/en/" <> docsVersion <> "/api.html"))
+ liftIO $ docsUrl `shouldBe` Just (String ("https://postgrest.org/en/" <> docsVersion <> "/references/api.html"))
 
  describe "schema" $ do