Skip to content

Commit

Permalink
Merge pull request #61 from openpreserve/feat/openapi33
Browse files Browse the repository at this point in the history 
FEAT: Moved to OpenAPI 3.1
  • Loading branch information
@carlwilson
carlwilson authored May 3, 2023
2 parents 993c486 + 0879609 commit 853b029
Showing 1 changed file with 33 additions and 35 deletions.
68 changes: 33 additions & 35 deletions api/par-api.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
openapi: 3.0.1
openapi: 3.1.0
info:
title: PAR API
description: API to retrieve and update Business Rules, Preservation Actions etc
Expand Down Expand Up @@ -140,7 +140,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/BusinessRules'
example: |-
examples: |-
{
"businessRules" : [ {
"id" : {
Expand Down Expand Up @@ -535,7 +535,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/BusinessRule'
example: |-
examples: |-
{
"id" : {
"guid" : "85fb1396-7625-55ed-b25c-6f6e75e6b27a",
Expand Down Expand Up @@ -676,7 +676,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/BusinessRule'
example: |-
examples: |-
{
"id" : {
"guid" : "85fb1396-7625-55ed-b25c-6f6e75e6b27a",
Expand Down Expand Up @@ -829,7 +829,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/BusinessRule'
example: |-
examples: |-
{
"id" : {
"guid" : "85fb1396-7625-55ed-b25c-6f6e75e6b27a",
Expand Down Expand Up @@ -1036,7 +1036,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/FileFormats'
example: |-
examples: |-
{
"fileFormats" : [ {
"description" : "This is an outline record only, and requires further details, research or authentication to provide information that will enable users to further understand the format and to assess digital preservation risks associated with it if appropriate.",
Expand Down Expand Up @@ -1179,7 +1179,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/FileFormat'
example: |-
examples: |-
{
"description" : "With the release of Word 97, Microsoft revised the native binary word processing format, which is based on its generic OLE2 Compound Document Format. The format is proprietary and Microsoft does not make details of its structure public. The information here is derived primarily from OpenOffice.org's reverse-engineered documentation of the format and should not therefore be regarded as definitive. A Word document is stored as a ‘WordDocument’ stream within a Compound Document Format file. The format remained unchanged with the releases of Word 2000, 2002 and 2003. An alternative extension of .wbk refers to a backup file of a Word document, however there is no material or structural difference between a .wbk file and the .doc file it is a backup of.",
"externalSignatures" : [ {
Expand Down Expand Up @@ -1295,7 +1295,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/FileFormat'
example: |-
examples: |-
{
"description" : "With the release of Word 97, Microsoft revised the native binary word processing format, which is based on its generic OLE2 Compound Document Format. The format is proprietary and Microsoft does not make details of its structure public. The information here is derived primarily from OpenOffice.org's reverse-engineered documentation of the format and should not therefore be regarded as definitive. A Word document is stored as a ‘WordDocument’ stream within a Compound Document Format file. The format remained unchanged with the releases of Word 2000, 2002 and 2003. An alternative extension of .wbk refers to a backup file of a Word document, however there is no material or structural difference between a .wbk file and the .doc file it is a backup of.",
"externalSignatures" : [ {
Expand Down Expand Up @@ -1423,7 +1423,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/FileFormat'
example: |-
examples: |-
{
"description" : "With the release of Word 97, Microsoft revised the native binary word processing format, which is based on its generic OLE2 Compound Document Format. The format is proprietary and Microsoft does not make details of its structure public. The information here is derived primarily from OpenOffice.org's reverse-engineered documentation of the format and should not therefore be regarded as definitive. A Word document is stored as a ‘WordDocument’ stream within a Compound Document Format file. The format remained unchanged with the releases of Word 2000, 2002 and 2003. An alternative extension of .wbk refers to a backup file of a Word document, however there is no material or structural difference between a .wbk file and the .doc file it is a backup of.",
"externalSignatures" : [ {
Expand Down Expand Up @@ -1618,7 +1618,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/FormatFamilies'
example: |-
examples: |-
{
"formatFamilies" : [ {
"id" : {
Expand Down Expand Up @@ -1738,7 +1738,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/FormatFamily'
example: |-
examples: |-
{
"id" : {
"guid" : "92a903da-be38-5c0c-97f4-c6aff4c98abf",
Expand Down Expand Up @@ -1794,7 +1794,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/FormatFamily'
example: |-
examples: |-
{
"id" : {
"guid" : "92a903da-be38-5c0c-97f4-c6aff4c98abf",
Expand Down Expand Up @@ -1862,7 +1862,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/FormatFamily'
example: |-
examples: |-
{
"id" : {
"guid" : "92a903da-be38-5c0c-97f4-c6aff4c98abf",
Expand Down Expand Up @@ -1984,7 +1984,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PreservationActionTypes'
example: |-
examples: |-
{
"preservationActionTypes" : [ {
"id" : {
Expand Down Expand Up @@ -2031,7 +2031,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PreservationActionType'
example: |-
examples: |-
{
"id" : {
"guid" : "45bad06c-e2c0-5b46-b740-0cd2ed140a6f",
Expand Down Expand Up @@ -2067,7 +2067,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PreservationActionType'
example: |-
examples: |-
{
"id" : {
"guid" : "45bad06c-e2c0-5b46-b740-0cd2ed140a6f",
Expand Down Expand Up @@ -2114,7 +2114,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PreservationActionType'
example: |-
examples: |-
{
"id" : {
"guid" : "45bad06c-e2c0-5b46-b740-0cd2ed140a6f",
Expand Down Expand Up @@ -2242,7 +2242,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PreservationActions'
example: |-
examples: |-
{
"preservationActions" : [ {
"description" : "Property Extraction of video files using MediaInfo CLI and EBUCore Metadata",
Expand Down Expand Up @@ -2987,7 +2987,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PreservationAction'
example: |-
examples: |-
{
"description" : "Property Extraction of Nikon, Fujifilm, Olympus and Minolta RAW image files using ExifTool",
"example" : "exiftool -X ${inputFile}",
Expand Down Expand Up @@ -3278,7 +3278,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PreservationAction'
example: |-
examples: |-
{
"description" : "Property Extraction of Nikon, Fujifilm, Olympus and Minolta RAW image files using ExifTool",
"example" : "exiftool -X ${inputFile}",
Expand Down Expand Up @@ -3580,7 +3580,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/PreservationAction'
example: |-
examples: |-
{
"description" : "Property Extraction of Nikon, Fujifilm, Olympus and Minolta RAW image files using ExifTool",
"example" : "exiftool -X ${inputFile}",
Expand Down Expand Up @@ -3935,7 +3935,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ParProperties'
example: |-
examples: |-
{
"parProperties" : [ {
"id" : {
Expand Down Expand Up @@ -3985,7 +3985,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ParProperty'
example: |-
examples: |-
{
"id" : {
"guid" : "00bfe91a-eb9d-540c-8b00-0497701d773a",
Expand Down Expand Up @@ -4022,7 +4022,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ParProperty'
example: |-
examples: |-
{
"id" : {
"guid" : "00bfe91a-eb9d-540c-8b00-0497701d773a",
Expand Down Expand Up @@ -4071,7 +4071,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/ParProperty'
example: |-
examples: |-
{
"id" : {
"guid" : "00bfe91a-eb9d-540c-8b00-0497701d773a",
Expand Down Expand Up @@ -4206,7 +4206,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/RepresentationFormats'
example: |-
examples: |-
{
"representationFormats" : [{
"id": {
Expand Down Expand Up @@ -4316,7 +4316,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/RepresentationFormat'
example: ""
examples: ""
401:
$ref: '#/components/responses/Unauthorized'
403:
Expand Down Expand Up @@ -4344,7 +4344,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/RepresentationFormat'
example: |-
examples: |-
{
"id": {
"guid": "c9828123-71cc-57d0-97e2-489c71d457e0",
Expand Down Expand Up @@ -4411,7 +4411,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/RepresentationFormat'
example: ""
examples: ""
401:
$ref: '#/components/responses/Unauthorized'
403:
Expand Down Expand Up @@ -4502,7 +4502,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/Tools'
example: |-
examples: |-
{
"tools" : [ {
"id" : {
Expand Down Expand Up @@ -4556,7 +4556,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/Tool'
example: |-
examples: |-
{
"id" : {
"guid" : "835e539a-abe2-55c1-b58b-8e68da664d8f",
Expand Down Expand Up @@ -4595,7 +4595,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/Tool'
example: |-
examples: |-
{
"id" : {
"guid" : "835e539a-abe2-55c1-b58b-8e68da664d8f",
Expand Down Expand Up @@ -4646,7 +4646,7 @@ paths:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/Tool'
example: |-
examples: |-
{
"id" : {
"guid" : "835e539a-abe2-55c1-b58b-8e68da664d8f",
Expand Down Expand Up @@ -4790,8 +4790,6 @@ components:
type: string
byteSequenceValue:
type: string
encoding:
type: string
endianness:
type: string
indirectOffsetLength:
Expand Down

0 comments on commit 853b029

Please sign in to comment.