Provide swagger with longer API description (#221)

Co-authored-by: Jason Paige <[email protected]>
hmcts · Jan 25, 2024 · e025045 · e025045
1 parent f7860fb
commit e025045
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/pre-api-stg.yaml b/pre-api-stg.yaml
@@ -1511,7 +1511,7 @@ externalDocs:
   url: 'https://github.com/hmcts/pre-api'
 host: 'sds-api-mgmt.staging.platform.hmcts.net'
 info:
-  description: PRE API
+  description: 'PRE API - Used for managing courts, bookings, recordings and permissions.'
   license:
     name: MIT
     url: 'https://opensource.org/licenses/MIT'

diff --git a/src/main/java/uk/gov/hmcts/reform/preapi/config/OpenAPIConfiguration.java b/src/main/java/uk/gov/hmcts/reform/preapi/config/OpenAPIConfiguration.java
@@ -22,7 +22,7 @@ public class OpenAPIConfiguration {
     public OpenAPI openAPI() {
         return new OpenAPI()
             .info(new Info().title("PRE API")
-                      .description("PRE API")
+                      .description("PRE API - Used for managing courts, bookings, recordings and permissions.")
                       .version("v0.0.1")
                       .license(new License().name("MIT").url("https://opensource.org/licenses/MIT")))
             .externalDocs(new ExternalDocumentation()