diff --git a/.github/workflows/access.yml b/.github/workflows/access.yml index 1ed88d41ed..dd0810f8f1 100644 --- a/.github/workflows/access.yml +++ b/.github/workflows/access.yml @@ -46,6 +46,7 @@ on: - '["tier-to-delius"]' - '["unpaid-work-and-delius"]' - '["workforce-allocations-to-delius"]' + - '["accredited-programmes-and-oasys"]' # ^ add new projects here # GitHub Actions doesn't support dynamic choices, we must add each project here to enable manual deployments # See https://github.com/community/community/discussions/11795 diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ca1c7e0438..4f7226c5b7 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -69,6 +69,7 @@ jobs: - tier-to-delius - unpaid-work-and-delius - workforce-allocations-to-delius + - accredited-programmes-and-oasys # ^ add new projects here # GitHub Actions doesn't support dynamic choices, we must add each project here to enable manual deployments # See https://github.com/community/community/discussions/11795 diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index c22f54a0a5..06ff1dd5a6 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -60,6 +60,7 @@ on: - '["tier-to-delius"]' - '["unpaid-work-and-delius"]' - '["workforce-allocations-to-delius"]' + - '["accredited-programmes-and-oasys"]' # ^ add new projects here # GitHub Actions doesn't support dynamic choices, we must add each project here to enable manual deployments # See https://github.com/community/community/discussions/11795 diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 687f99c5d7..51691366f4 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -52,6 +52,7 @@ on: - '["tier-to-delius"]' - '["unpaid-work-and-delius"]' - '["workforce-allocations-to-delius"]' + - '["accredited-programmes-and-oasys"]' # ^ add new projects here # GitHub Actions doesn't support dynamic choices, we must add each project here to enable manual deployments # See https://github.com/community/community/discussions/11795 diff --git a/.idea/runConfigurations/accredited_programmes_and_oasys.xml b/.idea/runConfigurations/accredited_programmes_and_oasys.xml new file mode 100644 index 0000000000..c9a87cb328 --- /dev/null +++ b/.idea/runConfigurations/accredited_programmes_and_oasys.xml @@ -0,0 +1,12 @@ + + + + \ No newline at end of file diff --git a/doc/tech-docs/source/services.html.md.erb b/doc/tech-docs/source/services.html.md.erb index 698078b62f..64c4e28bb0 100644 --- a/doc/tech-docs/source/services.html.md.erb +++ b/doc/tech-docs/source/services.html.md.erb @@ -73,4 +73,5 @@ weight: 20 * [Prisoner Profile And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/prisoner-profile-and-delius) * [Prison Identifier And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/prison-identifier-and-delius) * [Assessment Summary And Delius](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/assessment-summary-and-delius) +* [Accredited Programmes And Oasys](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/accredited-programmes-and-oasys)
  • ^ add new projects here
    • diff --git a/projects/accredited-programmes-and-oasys/.trivyignore b/projects/accredited-programmes-and-oasys/.trivyignore new file mode 100644 index 0000000000..e69de29bb2 diff --git a/projects/accredited-programmes-and-oasys/README.md b/projects/accredited-programmes-and-oasys/README.md new file mode 100644 index 0000000000..f67e6ecfc1 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/README.md @@ -0,0 +1,3 @@ +# accredited-programmes-and-oasys + +// TODO Describe the service \ No newline at end of file diff --git a/projects/accredited-programmes-and-oasys/applicationinsights.json b/projects/accredited-programmes-and-oasys/applicationinsights.json new file mode 100644 index 0000000000..aeb6b52473 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/applicationinsights.json @@ -0,0 +1,62 @@ +{ + "role": { + "name": "accredited-programmes-and-oasys" + }, + "customDimensions": { + "service.version": "${VERSION}", + "service.team": "probation-integration" + }, + "instrumentation": { + "logging": { + "level": "DEBUG" + }, + "springScheduling": { + "enabled": false + } + }, + "selfDiagnostics": { + "destination": "console" + }, + "sampling": { + "percentage": 100 + }, + "preview": { + "sampling": { + "overrides": [ + { + "telemetryType": "request", + "attributes": [ + { + "key": "http.url", + "value": "https?://[^/]+/health/?.*", + "matchType": "regexp" + } + ], + "percentage": 0 + }, + { + "telemetryType": "dependency", + "attributes": [ + { + "key": "db.statement", + "value": ".*CLIENT_IDENTIFIER.*", + "matchType": "regexp" + } + ], + "percentage": 0 + }, + { + "telemetryType": "dependency", + "attributes": [ + { + "key": "db.operation", + "value": "SELECT", + "matchType": "strict" + } + ], + "percentage": 10 + } + ] + } + } +} \ No newline at end of file diff --git a/projects/accredited-programmes-and-oasys/build.gradle.kts b/projects/accredited-programmes-and-oasys/build.gradle.kts new file mode 100644 index 0000000000..c46e9e7721 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/build.gradle.kts @@ -0,0 +1,31 @@ +import uk.gov.justice.digital.hmpps.extensions.ClassPathExtension + +apply(plugin = "com.google.cloud.tools.jib") + +dependencies { + implementation(project(":libs:commons")) + implementation(project(":libs:oauth-client")) + implementation(project(":libs:oauth-server")) + + implementation("org.springframework.boot:spring-boot-starter-actuator") + implementation("org.springframework.boot:spring-boot-starter-security") + implementation("org.springframework.boot:spring-boot-starter-validation") + implementation("org.springframework.boot:spring-boot-starter-web") + implementation("org.jetbrains.kotlin:kotlin-reflect") + implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8") + implementation("com.fasterxml.jackson.module:jackson-module-kotlin") + implementation(libs.springdoc) + + dev(project(":libs:dev-tools")) + + testImplementation("org.springframework.boot:spring-boot-starter-test") + testImplementation(libs.bundles.mockito) +} + +configure { + jacocoExclusions = listOf( + "**/config/**", + "**/entity/**", + "**/AppKt.class" + ) +} diff --git a/projects/accredited-programmes-and-oasys/deploy/Chart.yaml b/projects/accredited-programmes-and-oasys/deploy/Chart.yaml new file mode 100644 index 0000000000..d00115b488 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/deploy/Chart.yaml @@ -0,0 +1,13 @@ +apiVersion: v2 +appVersion: '1.0' +description: A Helm chart for Kubernetes +name: accredited-programmes-and-oasys +version: 1.0.0 + +dependencies: + - name: generic-service + version: "2.8" + repository: https://ministryofjustice.github.io/hmpps-helm-charts + - name: generic-prometheus-alerts + version: "1.3" + repository: https://ministryofjustice.github.io/hmpps-helm-charts \ No newline at end of file diff --git a/projects/accredited-programmes-and-oasys/deploy/values-dev.yml b/projects/accredited-programmes-and-oasys/deploy/values-dev.yml new file mode 100644 index 0000000000..2d5cbb06f3 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/deploy/values-dev.yml @@ -0,0 +1,20 @@ +enabled: false # TODO set this to true when you're ready to deploy your service + +generic-service: + ingress: + host: accredited-programmes-and-oasys-dev.hmpps.service.justice.gov.uk + + scheduledDowntime: + enabled: true + + env: + SENTRY_ENVIRONMENT: dev + SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_JWK_SET_URI: https://sign-in-dev.hmpps.service.justice.gov.uk/auth/.well-known/jwks.json + SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_ISSUER_URI: https://sign-in-dev.hmpps.service.justice.gov.uk/auth/issuer + + INTEGRATIONS_ORDS_URL: https://t2.oasys.service.justice.gov.uk/eor/oasys + + LOGGING_LEVEL_UK_GOV_DIGITAL_JUSTICE_HMPPS: DEBUG + +generic-prometheus-alerts: + businessHoursOnly: true diff --git a/projects/accredited-programmes-and-oasys/deploy/values-preprod.yml b/projects/accredited-programmes-and-oasys/deploy/values-preprod.yml new file mode 100644 index 0000000000..9b3fc9464f --- /dev/null +++ b/projects/accredited-programmes-and-oasys/deploy/values-preprod.yml @@ -0,0 +1,18 @@ +enabled: false # TODO set this to true when you're ready to deploy your service + +generic-service: + ingress: + host: accredited-programmes-and-oasys-preprod.hmpps.service.justice.gov.uk + + scheduledDowntime: + enabled: true + + env: + SENTRY_ENVIRONMENT: preprod + SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_JWK_SET_URI: https://sign-in-preprod.hmpps.service.justice.gov.uk/auth/.well-known/jwks.json + SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_ISSUER_URI: https://sign-in-preprod.hmpps.service.justice.gov.uk/auth/issuer + + INTEGRATIONS_ORDS_OASYS_URL: https://bridge-pp-oasys.az.justice.gov.uk/eor/oasys + +generic-prometheus-alerts: + businessHoursOnly: true \ No newline at end of file diff --git a/projects/accredited-programmes-and-oasys/deploy/values-prod.yml b/projects/accredited-programmes-and-oasys/deploy/values-prod.yml new file mode 100644 index 0000000000..a773782cd4 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/deploy/values-prod.yml @@ -0,0 +1,12 @@ +enabled: false # TODO set this to true when you're ready to deploy your service + +generic-service: + ingress: + host: accredited-programmes-and-oasys.hmpps.service.justice.gov.uk + + env: + SENTRY_ENVIRONMENT: prod + SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_JWK_SET_URI: https://sign-in.hmpps.service.justice.gov.uk/auth/.well-known/jwks.json + SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_ISSUER_URI: https://sign-in.hmpps.service.justice.gov.uk/auth/issuer + + INTEGRATIONS_ORDS_URL: https://bridge-oasys.az.justice.gov.uk/eor/oasys diff --git a/projects/accredited-programmes-and-oasys/deploy/values.yaml b/projects/accredited-programmes-and-oasys/deploy/values.yaml new file mode 100644 index 0000000000..401e197efa --- /dev/null +++ b/projects/accredited-programmes-and-oasys/deploy/values.yaml @@ -0,0 +1,20 @@ +# Common values +generic-service: + nameOverride: accredited-programmes-and-oasys + + image: + repository: ghcr.io/ministryofjustice/hmpps-probation-integration-services/accredited-programmes-and-oasys + + ingress: + tlsSecretName: accredited-programmes-and-oasys-cert + + namespace_secrets: + accredited-programmes-and-oasys-client-credentials: + INTEGRATIONS_ORDS_CLIENT-ID: ORDS_CLIENT_ID + INTEGRATIONS_ORDS_CLIENT-SECRET: ORDS_CLIENT_SECRET + accredited-programmes-and-oasys-sentry: + SENTRY_DSN: SENTRY_DSN + +generic-prometheus-alerts: + targetApplication: accredited-programmes-and-oasys + diff --git a/projects/accredited-programmes-and-oasys/settings.gradle.kts b/projects/accredited-programmes-and-oasys/settings.gradle.kts new file mode 100644 index 0000000000..c561a4c0ff --- /dev/null +++ b/projects/accredited-programmes-and-oasys/settings.gradle.kts @@ -0,0 +1 @@ +rootProject.name = "accredited-programmes-and-oasys" diff --git a/projects/accredited-programmes-and-oasys/src/integrationTest/kotlin/uk/gov/justice/digital/hmpps/IntegrationTest.kt b/projects/accredited-programmes-and-oasys/src/integrationTest/kotlin/uk/gov/justice/digital/hmpps/IntegrationTest.kt new file mode 100644 index 0000000000..d9006c74c5 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/src/integrationTest/kotlin/uk/gov/justice/digital/hmpps/IntegrationTest.kt @@ -0,0 +1,30 @@ +package uk.gov.justice.digital.hmpps + +import org.junit.jupiter.api.Test +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc +import org.springframework.boot.test.context.SpringBootTest +import org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT +import org.springframework.boot.test.mock.mockito.MockBean +import org.springframework.test.web.servlet.MockMvc +import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get +import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status +import uk.gov.justice.digital.hmpps.test.MockMvcExtensions.withToken +import uk.gov.justice.digital.hmpps.telemetry.TelemetryService + +@AutoConfigureMockMvc +@SpringBootTest(webEnvironment = RANDOM_PORT) +internal class IntegrationTest { + @Autowired + lateinit var mockMvc: MockMvc + + @MockBean + lateinit var telemetryService: TelemetryService + + @Test + fun `API call retuns a success response`() { + mockMvc + .perform(get("/example/123").withToken()) + .andExpect(status().is2xxSuccessful) + } +} diff --git a/projects/accredited-programmes-and-oasys/src/main/kotlin/uk/gov/justice/digital/hmpps/App.kt b/projects/accredited-programmes-and-oasys/src/main/kotlin/uk/gov/justice/digital/hmpps/App.kt new file mode 100644 index 0000000000..c7faac5b26 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/src/main/kotlin/uk/gov/justice/digital/hmpps/App.kt @@ -0,0 +1,11 @@ +package uk.gov.justice.digital.hmpps + +import org.springframework.boot.autoconfigure.SpringBootApplication +import org.springframework.boot.runApplication + +@SpringBootApplication +class App + +fun main(args: Array) { + runApplication(*args) +} diff --git a/projects/accredited-programmes-and-oasys/src/main/kotlin/uk/gov/justice/digital/hmpps/controller/ApiController.kt b/projects/accredited-programmes-and-oasys/src/main/kotlin/uk/gov/justice/digital/hmpps/controller/ApiController.kt new file mode 100644 index 0000000000..e5f139965c --- /dev/null +++ b/projects/accredited-programmes-and-oasys/src/main/kotlin/uk/gov/justice/digital/hmpps/controller/ApiController.kt @@ -0,0 +1,17 @@ +package uk.gov.justice.digital.hmpps.controller + +import org.springframework.security.access.prepost.PreAuthorize +import org.springframework.web.bind.annotation.GetMapping +import org.springframework.web.bind.annotation.PathVariable +import org.springframework.web.bind.annotation.RestController + +@RestController +class ApiController { + @PreAuthorize("hasRole('ROLE_EXAMPLE')") + @GetMapping(value = ["/example/{inputId}"]) + fun handle( + @PathVariable("inputId") inputId: String + ) { + // TODO Not yet implemented + } +} diff --git a/projects/accredited-programmes-and-oasys/src/main/resources/application.yml b/projects/accredited-programmes-and-oasys/src/main/resources/application.yml new file mode 100644 index 0000000000..10f455cb7d --- /dev/null +++ b/projects/accredited-programmes-and-oasys/src/main/resources/application.yml @@ -0,0 +1,44 @@ +# Default config +server.shutdown: graceful +spring: + jackson: + default-property-inclusion: non_empty + parser: + allow-unquoted-control-chars: true + security.oauth2.client: + registration: + default: + provider: oasys-ords-auth + authorization-grant-type: client_credentials + client-id: ${integrations.ords.client-id} + client-secret: ${integrations.ords.client-secret} + provider: + oasys-ords-auth: + token-uri: ${integrations.ords.url}/oauth/token + threads.virtual.enabled: true + +management: + endpoints.web: + base-path: / + exposure.include: [ "health", "info" ] + endpoint.health.show-details: always + +--- +# Shared dev/test config +spring.config.activate.on-profile: [ "dev", "integration-test" ] + +context.initializer.classes: uk.gov.justice.digital.hmpps.wiremock.WireMockInitialiser + +jwt.authorities: + - ROLE_EXAMPLE + +integrations: + ords: + url: http://localhost:${wiremock.port}/eor/oasys + client-id: accredited-programmes-and-oasys + client-secret: accredited-programmes-and-oasys + +logging.level: + uk.gov.justice.digital.hmpps: DEBUG + org.hibernate.tool.schema: ERROR + org.apache.activemq: WARN diff --git a/projects/accredited-programmes-and-oasys/tech-docs/.gitignore b/projects/accredited-programmes-and-oasys/tech-docs/.gitignore new file mode 100644 index 0000000000..80d5de85a7 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/tech-docs/.gitignore @@ -0,0 +1,20 @@ +# See http://help.github.com/ignore-files/ for more about ignoring files. +# +# If you find yourself ignoring temporary files generated by your text editor +# or operating system, you probably want to add a global ignore instead: +# git config --global core.excludesfile ~/.gitignore_global + +# Ignore bundler config +/.bundle + +# Ignore the build directory +/build + +# Ignore cache +/.sass-cache +/.cache + +# Ignore .DS_store file +.DS_Store + +Staticfile.auth diff --git a/projects/accredited-programmes-and-oasys/tech-docs/.template_version b/projects/accredited-programmes-and-oasys/tech-docs/.template_version new file mode 100644 index 0000000000..57ff8862e1 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/tech-docs/.template_version @@ -0,0 +1,3 @@ +--- +:remote: https://github.com/alphagov/tech-docs-template.git +:revision: b37e894 \ No newline at end of file diff --git a/projects/accredited-programmes-and-oasys/tech-docs/Gemfile b/projects/accredited-programmes-and-oasys/tech-docs/Gemfile new file mode 100644 index 0000000000..afef363c09 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/tech-docs/Gemfile @@ -0,0 +1,12 @@ +# If you do not have OpenSSL installed, change +# the following line to use 'http://' +source 'https://rubygems.org' + +# For faster file watcher updates on Windows: +gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw, :x64_mingw] + +# Windows does not come with time zone data +gem 'tzinfo-data', platforms: [:mswin, :mingw, :x64_mingw, :jruby] + +# Include the tech docs gem +gem 'govuk_tech_docs' diff --git a/projects/accredited-programmes-and-oasys/tech-docs/Gemfile.lock b/projects/accredited-programmes-and-oasys/tech-docs/Gemfile.lock new file mode 100644 index 0000000000..a9ead249ac --- /dev/null +++ b/projects/accredited-programmes-and-oasys/tech-docs/Gemfile.lock @@ -0,0 +1,177 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (7.0.7.2) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 1.6, < 2) + minitest (>= 5.1) + tzinfo (~> 2.0) + addressable (2.8.4) + public_suffix (>= 2.0.2, < 6.0) + autoprefixer-rails (10.4.13.0) + execjs (~> 2) + backports (3.24.1) + chronic (0.10.2) + chunky_png (1.4.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.12.2) + commonmarker (0.23.10) + compass (1.0.3) + chunky_png (~> 1.2) + compass-core (~> 1.0.2) + compass-import-once (~> 1.0.5) + rb-fsevent (>= 0.9.3) + rb-inotify (>= 0.9) + sass (>= 3.3.13, < 3.5) + compass-core (1.0.3) + multi_json (~> 1.0) + sass (>= 3.3.0, < 3.5) + compass-import-once (1.0.5) + sass (>= 3.2, < 3.5) + concurrent-ruby (1.2.2) + contracts (0.17) + dotenv (2.8.1) + em-websocket (0.5.3) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0) + erubis (2.7.0) + eventmachine (1.2.7) + execjs (2.8.1) + fast_blank (1.0.1) + fastimage (2.2.6) + ffi (1.15.5) + govuk_tech_docs (3.3.1) + autoprefixer-rails (~> 10.2) + chronic (~> 0.10.2) + middleman (~> 4.0) + middleman-autoprefixer (~> 2.10.0) + middleman-compass (>= 4.0.0) + middleman-livereload + middleman-search-gds + middleman-sprockets (~> 4.0.0) + middleman-syntax (~> 3.2.0) + nokogiri + openapi3_parser (~> 0.9.0) + redcarpet (~> 3.5.1) + haml (5.2.2) + temple (>= 0.8.0) + tilt + hamster (3.0.0) + concurrent-ruby (~> 1.0) + hashie (3.6.0) + http_parser.rb (0.8.0) + i18n (1.6.0) + concurrent-ruby (~> 1.0) + kramdown (2.4.0) + rexml + listen (3.8.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + memoist (0.16.2) + middleman (4.4.3) + coffee-script (~> 2.2) + haml (>= 4.0.5, < 6.0) + kramdown (>= 2.3.0) + middleman-cli (= 4.4.3) + middleman-core (= 4.4.3) + middleman-autoprefixer (2.10.0) + autoprefixer-rails (>= 9.1.4) + middleman-core (>= 3.3.3) + middleman-cli (4.4.3) + thor (>= 0.17.0, < 2.0) + middleman-compass (4.0.1) + compass (>= 1.0.0, < 2.0.0) + middleman-core (>= 4.0.0) + middleman-core (4.4.3) + activesupport (>= 6.1, < 7.1) + addressable (~> 2.4) + backports (~> 3.6) + bundler (~> 2.0) + contracts (~> 0.13) + dotenv + erubis + execjs (~> 2.0) + fast_blank + fastimage (~> 2.0) + hamster (~> 3.0) + hashie (~> 3.4) + i18n (~> 1.6.0) + listen (~> 3.0) + memoist (~> 0.14) + padrino-helpers (~> 0.15.0) + parallel + rack (>= 1.4.5, < 3) + sassc (~> 2.0) + servolux + tilt (~> 2.0.9) + toml + uglifier (~> 3.0) + webrick + middleman-livereload (3.4.7) + em-websocket (~> 0.5.1) + middleman-core (>= 3.3) + rack-livereload (~> 0.3.15) + middleman-search-gds (0.11.2) + execjs (~> 2.6) + middleman-core (>= 3.2) + nokogiri (~> 1.6) + middleman-sprockets (4.0.0) + middleman-core (~> 4.0) + sprockets (>= 3.0) + middleman-syntax (3.2.0) + middleman-core (>= 3.2) + rouge (~> 3.2) + minitest (5.18.0) + multi_json (1.15.0) + nokogiri (1.14.3-x86_64-linux) + racc (~> 1.4) + openapi3_parser (0.9.2) + commonmarker (~> 0.17) + padrino-helpers (0.15.3) + i18n (>= 0.6.7, < 2) + padrino-support (= 0.15.3) + tilt (>= 1.4.1, < 3) + padrino-support (0.15.3) + parallel (1.22.1) + parslet (2.0.0) + public_suffix (5.0.1) + racc (1.6.2) + rack (2.2.6.4) + rack-livereload (0.3.17) + rack + rb-fsevent (0.11.2) + rb-inotify (0.10.1) + ffi (~> 1.0) + redcarpet (3.5.1) + rexml (3.2.5) + rouge (3.30.0) + sass (3.4.25) + sassc (2.4.0) + ffi (~> 1.9) + servolux (0.13.0) + sprockets (4.2.0) + concurrent-ruby (~> 1.0) + rack (>= 2.2.4, < 4) + temple (0.10.0) + thor (1.2.1) + tilt (2.0.11) + toml (0.3.0) + parslet (>= 1.8.0, < 3.0.0) + tzinfo (2.0.6) + concurrent-ruby (~> 1.0) + uglifier (3.2.0) + execjs (>= 0.3.0, < 3) + webrick (1.8.1) + +PLATFORMS + x86_64-linux + +DEPENDENCIES + govuk_tech_docs + tzinfo-data + wdm (~> 0.1.0) + +BUNDLED WITH + 2.3.26 diff --git a/projects/accredited-programmes-and-oasys/tech-docs/config.rb b/projects/accredited-programmes-and-oasys/tech-docs/config.rb new file mode 100644 index 0000000000..76c77d53dd --- /dev/null +++ b/projects/accredited-programmes-and-oasys/tech-docs/config.rb @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +require "govuk_tech_docs" + +GovukTechDocs.configure(self) + +activate :relative_assets +set :relative_links, true diff --git a/projects/accredited-programmes-and-oasys/tech-docs/config/tech-docs.yml b/projects/accredited-programmes-and-oasys/tech-docs/config/tech-docs.yml new file mode 100644 index 0000000000..7b818bc229 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/tech-docs/config/tech-docs.yml @@ -0,0 +1,44 @@ +# Host to use for canonical URL generation (without trailing slash) +host: https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/accredited-programmes-and-oasys + +# Header-related options +service_name: HMPPS Accredited Programmes And Oasys +service_link: https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/accredited-programmes-and-oasys + +# Links to show on right-hand-side of header +header_links: + Home: https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs + GitHub: https://github.com/ministryofjustice/hmpps-probation-integration-services#readme + Slack: https://mojdt.slack.com/archives/C02HQ4M2YQN # #probation-integration-tech channel + +# Enables search functionality. This indexes pages only and is not recommended for single-page sites. +enable_search: true + +# Tracking ID from Google Analytics (e.g. UA-XXXX-Y) +ga_tracking_id: + +# Enable multipage navigation in the sidebar +multipage_nav: true + +# Enable collapsible navigation in the sidebar +collapsible_nav: true + +# Table of contents depth – how many levels to include in the table of contents. +# If your ToC is too long, reduce this number and we'll only show higher-level +# headings. +max_toc_heading_level: 2 + +# Prevent robots from indexing (e.g. whilst in development) +prevent_indexing: false + +# Contribution +show_contribution_banner: true +github_repo: ministryofjustice/hmpps-probation-integration-services +github_branch: main + +# Slack +owner_slack_workspace: mojdt +default_owner_slack: '#probation-integration-tech' + +# OpenAPI +api_path: https://accredited-programmes-and-oasys-dev.hmpps.service.justice.gov.uk/v3/api-docs.yaml diff --git a/projects/accredited-programmes-and-oasys/tech-docs/source/api-reference.html.md.erb b/projects/accredited-programmes-and-oasys/tech-docs/source/api-reference.html.md.erb new file mode 100644 index 0000000000..00b08aa424 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/tech-docs/source/api-reference.html.md.erb @@ -0,0 +1,19 @@ +--- +title: API Reference +source_url: 'https://github.com/ministryofjustice/hmpps-probation-integration-services/blob/main/projects/accredited-programmes-and-oasys/tech-docs/source/api-reference.html.md.erb' +weight: 20 +--- + +
    + + API Reference +
    + + +The following documentation is also available in these formats: + +* [OpenAPI JSON](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/accredited-programmes-and-oasys/api-docs.json) +* [OpenAPI YAML](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/accredited-programmes-and-oasys/api-docs.yaml) +* [Swagger UI](https://accredited-programmes-and-oasys-dev.hmpps.service.justice.gov.uk/swagger-ui/index.html) + +api> diff --git a/projects/accredited-programmes-and-oasys/tech-docs/source/index.html.md.erb b/projects/accredited-programmes-and-oasys/tech-docs/source/index.html.md.erb new file mode 100644 index 0000000000..a0f489cbae --- /dev/null +++ b/projects/accredited-programmes-and-oasys/tech-docs/source/index.html.md.erb @@ -0,0 +1,7 @@ +--- +title: About +source_url: 'https://github.com/ministryofjustice/hmpps-probation-integration-services/blob/main/projects/accredited-programmes-and-oasys/tech-docs/source/index.html.md.erb' +weight: 10 +--- + +<%= URI.open('https://raw.githubusercontent.com/ministryofjustice/hmpps-probation-integration-services/main/projects/accredited-programmes-and-oasys/README.md').read.gsub(/tech-docs\/source\//, "./") %> \ No newline at end of file diff --git a/projects/accredited-programmes-and-oasys/tech-docs/source/javascripts/application.js b/projects/accredited-programmes-and-oasys/tech-docs/source/javascripts/application.js new file mode 100644 index 0000000000..8a5d80b842 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/tech-docs/source/javascripts/application.js @@ -0,0 +1 @@ +//= require govuk_tech_docs diff --git a/projects/accredited-programmes-and-oasys/tech-docs/source/stylesheets/print.css.scss b/projects/accredited-programmes-and-oasys/tech-docs/source/stylesheets/print.css.scss new file mode 100644 index 0000000000..82b181c017 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/tech-docs/source/stylesheets/print.css.scss @@ -0,0 +1,3 @@ +$is-print: true; + +@import "govuk_tech_docs"; diff --git a/projects/accredited-programmes-and-oasys/tech-docs/source/stylesheets/screen-old-ie.css.scss b/projects/accredited-programmes-and-oasys/tech-docs/source/stylesheets/screen-old-ie.css.scss new file mode 100644 index 0000000000..da90cca5b0 --- /dev/null +++ b/projects/accredited-programmes-and-oasys/tech-docs/source/stylesheets/screen-old-ie.css.scss @@ -0,0 +1,4 @@ +$is-ie: true; +$ie-version: 8; + +@import "govuk_tech_docs"; diff --git a/projects/accredited-programmes-and-oasys/tech-docs/source/stylesheets/screen.css.scss b/projects/accredited-programmes-and-oasys/tech-docs/source/stylesheets/screen.css.scss new file mode 100644 index 0000000000..f0456338fd --- /dev/null +++ b/projects/accredited-programmes-and-oasys/tech-docs/source/stylesheets/screen.css.scss @@ -0,0 +1 @@ +@import "govuk_tech_docs"; diff --git a/settings.gradle.kts b/settings.gradle.kts index 006e8e0648..9e100f5465 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -1,6 +1,7 @@ rootProject.name = "probation-integration-services" include( // ⌄ add new projects here + "accredited-programmes-and-oasys", "approved-premises-and-delius", "approved-premises-and-oasys", "arns-and-delius",