Skip to content

Commit 3a009f9

Browse files
committed
DMP-5276-OpenapiValidator
Added open api validation
1 parent fa038ee commit 3a009f9

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,13 @@ Please see the separate [Dev environment](https://tools.hmcts.net/confluence/dis
393393
394394
This repo contains overrides for the default dev environment configuration, controlled by PR labels.
395395
396+
### Supported labels
397+
398+
| Label | Usages |
399+
|------------------------|--------------------------------------------------------------------------------------------------|
400+
| enable_darts_portal | Deploys a DARTS portal instance alongside the API in the dev environment |
401+
| enable_darts_fullstack | Not yet supported, but will deploy the full DARTS stack alongside the API in the dev environment |
402+
396403
## OpenAPI Specification and Data Schema Validation
397404
398405
This repository uses spectral to validate OpenAPI specifications. To install spectral, you can use npm or yarn:
@@ -409,7 +416,11 @@ Documentation: https://stoplight.io/open-source/spectral
409416
410417
## OpenAPI Validation
411418
412-
The application uses OpenAPI validation to ensure that incoming requests and outgoing responses conform to the OpenAPI specification.
419+
The application uses OpenAPI validation to ensure that incoming requests and outgoing responses conform to the OpenAPI specification. To install the IBM OpenAPI
420+
validator, you can use npm or yarn:
421+
422+
https://github.com/IBM/openapi-validator?tab=readme-ov-file#installation
423+
413424
To enable OpenAPI validation, the following properties are set in the application configuration:
414425
415426
```bash
@@ -420,13 +431,6 @@ For more information on OpenAPI validation with IBM openapi validator, see the [
420431
421432
Validate the data payload JSON Schemas:
422433
423-
### Supported labels
424-
425-
| Label | Usages |
426-
|------------------------|--------------------------------------------------------------------------------------------------|
427-
| enable_darts_portal | Deploys a DARTS portal instance alongside the API in the dev environment |
428-
| enable_darts_fullstack | Not yet supported, but will deploy the full DARTS stack alongside the API in the dev environment |
429-
430434
## License
431435
432436
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

0 commit comments

Comments
 (0)