Skip to content

Commit

Permalink
docs(FCL-283): improve the description provided in the OpenAPI docume…
Browse files Browse the repository at this point in the history
…ntation
  • Loading branch information
jacksonj04 committed Sep 10, 2024
1 parent 26fbdf2 commit 6a011f4
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion doc/openapi/public_api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,15 @@ openapi: 3.1.0
info:
title: "National Archives Find Case Law: Public API"
version: 0.1.3
description: "An API for interacting with and retrieving data from the [Find Case Law service](https://caselaw.nationalarchives.gov.uk/), operated by the National Archives."
description: |-
Our API provides access to judgments and decisions held by Find Case Law that have been converted from Microsoft Word documents into XML. These have been automatically marked up according to the [international data standard, LegalDocML](https://groups.oasis-open.org/communities/tc-community-home2?CommunityKey=3425f20f-b704-4076-9fab-018dc7d3efbe), and validated by our legal editorial team. This data includes:
- Neutral Citation
- Court / Chamber
- Date
- Case Name
- Party Names
- Judges Names
termsOfService: "https://caselaw.nationalarchives.gov.uk/terms-of-use"
contact:
email: [email protected]
Expand All @@ -11,6 +19,7 @@ info:
license:
name: Open Justice Licence
url: "https://caselaw.nationalarchives.gov.uk/open-justice-licence"
summary: "The Find Case Law API allows you to access court judgments and tribunal decisions held in the [Find Case Law service](https://caselaw.nationalarchives.gov.uk/), operated by the National Archives."
servers:
- url: "https://caselaw.nationalarchives.gov.uk"
description: ""
Expand Down

0 comments on commit 6a011f4

Please sign in to comment.