openapi-directory/api/weber-gesamtausgabe.de.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"⚠️<b>DEPRECATION WARNING</b>⚠️<br/>This version of the WeGA API specification is outdated and superseded by [version 1.1.0](https://weber-gesamtausgabe.de/api/v1/openapi.json).  <br/> <br/> For feedback or requests about this API please contact stadler@weber-gesamtausgabe.de or start the discussion at https://github.com/Edirom/WeGA-WebApp","title":"WeGA API","version":"1.0.0","x-apisguru-categories":["open_data"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://web.archive.org/web/20180313153846im_/https://weber-gesamtausgabe.de/resources/img/logo_weber.png"},"x-origin":[{"format":"swagger","url":"https://weber-gesamtausgabe.de/api/v1/swagger.json","version":"2.0"}],"x-providerName":"weber-gesamtausgabe.de"},"tags":[{"description":"Access to the documents of the WeGA digital edition","name":"Documents"},{"description":"Access to search functions of the WeGA digital edition","name":"Search"},{"description":"Access to encoding features","name":"Code Samples"},{"description":"Access to application settings","name":"Application"},{"description":"Access to facets for filtering result sets","name":"Facets"}],"paths":{"/application/newID":{"get":{"description":"","parameters":[{"$ref":"#/components/parameters/docTypeRequiredParam"}],"responses":{"200":{"description":"A single object with a fresh WeGA ID","content":{"application/json":{"schema":{"properties":{"docID":{"description":"The WeGA ID","pattern":"^A[A-F0-9]{6}$","type":"string"},"docType":{"description":"The WeGA document type","type":"string"}},"type":"object"}}}},"403":{"description":"The creation of new IDs is only available in the development environment","content":{"application/json":{"schema":{"properties":{"code":{"default":403,"format":"int32","type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Create a new WeGA ID","tags":["Application"]}},"/application/status":{"get":{"description":"","responses":{"200":{"description":"Healthy – A single object with status information","content":{"application/json":{"schema":{"properties":{"deployment":{"description":"The datetime of the deployment of the WeGA-WebApp","format":"date-time","type":"string"},"status":{"default":"healthy","description":"Status (healthy|unhealthy) of the currently running WeGA-WebApp","type":"string"},"svnRevision":{"description":"The Subversion revision of the currently installed WeGA-data","type":"integer"},"version":{"pattern":"^\\d+\\.\\d+\\.\\d+$","type":"string"}},"type":"object"}}}},"500":{"description":"Unhealthy – A single object with status information","content":{"application/json":{"schema":{"properties":{"deployment":{"description":"The datetime of the deployment of the WeGA-WebApp","format":"date-time","type":"string"},"status":{"default":"unhealthy","description":"Status (healthy|unhealthy) of the currently running WeGA-WebApp","type":"string"},"svnRevision":{"description":"The Subversion revision of the currently installed WeGA-data","type":"integer"},"version":{"pattern":"^\\d+\\.\\d+\\.\\d+$","type":"string"}},"type":"object"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Get status information about the running WeGA-WebApp","tags":["Application"]}},"/code/findByElement/{element}":{"get":{"description":"","parameters":[{"description":"The XML element to search for","in":"path","name":"element","required":true,"schema":{"type":"string"}},{"description":"The element namespace. Defaults to the TEI namespace","in":"query","name":"namespace","required":false,"schema":{"type":"string","default":"http://www.tei-c.org/ns/1.0"}},{"$ref":"#/components/parameters/docTypeParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/limitParam"}],"responses":{"200":{"description":"An array of documents","headers":{"totalrecordcount":{"description":"The total size of the result set","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CodeSample"},"type":"array"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Finds code samples by XML element","tags":["Code Samples"]}},"/documents":{"get":{"description":"The Documents endpoint returns a list of all documents from the WeGA digital edition.\n","parameters":[{"$ref":"#/components/parameters/docTypeParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/limitParam"}],"responses":{"200":{"description":"An array of documents","headers":{"totalrecordcount":{"description":"The total size of the result set","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Lists all documents","tags":["Documents"]}},"/documents/findByAuthor/{authorID}":{"get":{"description":"This endpoint returns a list of documents by a given author – optionally filtered by document type \n","parameters":[{"description":"The author ID to search for. Accepted ID formats are WeGA, e.g. A002068 or http://weber-gesamtausgabe.de/A002068, VIAF, e.g. http://viaf.org/viaf/14959938, or  GND, e.g. http://d-nb.info/gnd/118629662\n","in":"path","name":"authorID","required":true,"schema":{"type":"string","default":"A002068"}},{"$ref":"#/components/parameters/docTypeParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/limitParam"}],"responses":{"200":{"description":"An array of documents","headers":{"totalrecordcount":{"description":"The total size of the result set","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Finds documents by author","tags":["Documents"]}},"/documents/findByDate":{"get":{"description":"This endpoint returns a list of documents related to the given date – optionally filtered by document type. \n","parameters":[{"description":"The min date to search for","in":"query","name":"fromDate","required":true,"schema":{"type":"string","format":"date","default":"2025-04-15T13:49:52.653Z"}},{"description":"The max date to search for","in":"query","name":"toDate","required":false,"schema":{"type":"string","format":"date"}},{"$ref":"#/components/parameters/docTypeParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/limitParam"}],"responses":{"200":{"description":"An array of documents","headers":{"totalrecordcount":{"description":"The total size of the result set","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Finds documents by date","tags":["Documents"]}},"/documents/findByMention/{docID}":{"get":{"description":"This endpoint returns a list of documents that reference a particular docID – optionally filtered by document type. \n","parameters":[{"description":"The document ID that is to be mentioned. Accepted ID formats are WeGA, e.g. A002068 or http://weber-gesamtausgabe.de/A002068, VIAF, e.g. http://viaf.org/viaf/14959938, or  GND, e.g. http://d-nb.info/gnd/118629662\n","in":"path","name":"docID","required":true,"schema":{"type":"string","default":"A002068"}},{"$ref":"#/components/parameters/docTypeParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/limitParam"}],"responses":{"200":{"description":"An array of documents","headers":{"totalrecordcount":{"description":"The total size of the result set","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Finds documents by reference","tags":["Documents"]}},"/documents/{docID}":{"get":{"description":"This endpoint returns documents, indicated by an ID.\n Accepted ID formats are WeGA, e.g. A002068 or http://weber-gesamtausgabe.de/A002068, VIAF, e.g. http://viaf.org/viaf/14959938, or  GND, e.g. http://d-nb.info/gnd/118629662\n","parameters":[{"description":"The document identifier to search for","in":"path","name":"docID","required":true,"schema":{"type":"string","default":"A002068"}}],"responses":{"200":{"description":"An array of documents","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns documents by ID","tags":["Documents"]}},"/facets/{facet}":{"get":{"description":"","parameters":[{"description":"The facet to search for","in":"path","name":"facet","required":true,"schema":{"type":"string","enum":["sender","addressee"]}},{"description":"The scope of the result set, i.e. 'indices' or a WeGA ID","in":"query","name":"scope","required":true,"schema":{"type":"string","pattern":"^(indices)|(A[A-F0-9]{6})$"}},{"description":"The search term to be looked for in the facet's label","in":"query","name":"term","schema":{"type":"string"}},{"$ref":"#/components/parameters/docTypeRequiredParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/limitParam"}],"responses":{"200":{"description":"An array of facets","headers":{"totalrecordcount":{"description":"The total size of the result set","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Facet"},"type":"array"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Returns facets","tags":["Facets"]}},"/search/entity":{"get":{"description":"This endpoint returns the search results for an entity's name or title.\n","parameters":[{"$ref":"#/components/parameters/docTypeParam"},{"$ref":"#/components/parameters/qParam"},{"$ref":"#/components/parameters/offsetParam"},{"$ref":"#/components/parameters/limitParam"}],"responses":{"200":{"description":"An array of documents","headers":{"totalrecordcount":{"description":"The total size of the result set","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"}}}},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"summary":"Search for a WeGA entity","tags":["Search"]}}},"servers":[{"url":"http://localhost:8080/exist/apps/WeGA-WebApp/api/v1"}],"components":{"parameters":{"docTypeParam":{"description":"The WeGA document type","in":"query","name":"docType","style":"form","explode":false,"schema":{"type":"array","items":{"enum":["biblio","diaries","documents","letters","news","orgs","persons","places","thematicCommentaries","var","works","writings"],"type":"string"}}},"docTypeRequiredParam":{"description":"The WeGA document type","in":"query","name":"docType","required":true,"style":"form","explode":false,"schema":{"type":"array","items":{"enum":["biblio","diaries","documents","letters","news","orgs","persons","places","thematicCommentaries","var","works","writings"],"type":"string"}}},"fromDateParam":{"description":"The earliest date","in":"query","name":"fromDate","schema":{"type":"string","format":"date"}},"limitParam":{"description":"Number of items to retrieve (200 max)","in":"query","name":"limit","schema":{"type":"integer","format":"int32","maximum":200,"default":10}},"offsetParam":{"description":"Position of first item to retrieve (starting from 1)","in":"query","name":"offset","schema":{"type":"integer","format":"int32","minimum":1,"default":1}},"qParam":{"description":"The query string","in":"query","name":"q","schema":{"type":"string"}},"toDateParam":{"description":"The latest date","in":"query","name":"toDate","schema":{"type":"string","format":"date"}}},"schemas":{"CodeSample":{"properties":{"codeSample":{"description":"The code snippet","type":"string"},"docID":{"description":"The WeGA document identifier representing a specific document","type":"string"},"uri":{"description":"Unique identifier representing a specific document","type":"string"}},"type":"object"},"Document":{"properties":{"docID":{"description":"The WeGA document identifier representing a specific document","type":"string"},"docType":{"description":"The WeGA document type","type":"string"},"title":{"description":"The title of the document","type":"string"},"uri":{"description":"Unique identifier representing a specific document","type":"string"}},"type":"object"},"Error":{"properties":{"code":{"format":"int32","type":"integer"},"fields":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Facet":{"properties":{"frequency":{"description":"The sum of occurences of the object for the current result set","type":"integer"},"label":{"description":"The name or title of the object","type":"string"},"value":{"description":"the WeGA ID","pattern":"^A[A-F0-9]{6}$","type":"string"}},"type":"object"}}}}