{"note":"OpenAPI conversion -- returning structured metadata","name":"digitallinguistics-io","description":"DLx","version":"0.3.1","base_url":"https://api.digitallinguistics.io/v0","endpoints":18,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api DLx\n@base https://api.digitallinguistics.io/v0\n@version 0.3.1\n@auth ApiKey Authorization in header\n@endpoints 18\n@toc languages(12), lexemes(6)\n\n@group languages\n@endpoint GET /languages\n@desc Get all Languages\n@optional {continuation: any # The `dlx-continuation` header is used to send a continuation token with the request, when retrieving the next page of results., deleted: any # Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database. Otherwise requests for a resource marked for deletion will return a 410 error., ifModifiedSince: any # The `If-Modified-Since` header is used to retrieve only results modified since a given time. The value of this header must be a valid date string., maxItemCount: any # The `dlx-max-item-count` header is used to limit the number of results to a certain amount at a time (by default all results will be returned). If there are more results to be returned, a continuation token will also be sent in the `dlx-continuation` header., public: any # Set this parameter to `true` to include all publicly-accessible resources, not just those that the user is listed as an Owner, Contributor, or Viewer for.}\n@returns(200) 200: Operation successful.\n\n@endpoint POST /languages\n@desc Add a new Language\n@required {body: map # A database resource to upsert}\n@returns(201) 201: The resource was created successfully.\n\n@endpoint PUT /languages\n@desc Upsert (create or replace) a Language\n@required {body: map # A database resource to upsert}\n@optional {ifMatch: any # The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before updating or deleting it. The value of the `If-Match` header is the ETag (`_etag`) property of the resource. It is recommended that your application use this header whenever possible to avoid data conflicts.}\n@returns(201) 201: Upsert successful.\n\n@endpoint GET /languages/{languageID}\n@desc Retrieve a Language by ID\n@required {languageID: any # The ID of the Language to perform the operation on}\n@optional {deleted: any # Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database. Otherwise requests for a resource marked for deletion will return a 410 error., ifNoneMatch: any # If `If-None-Match` header is used with GET requests to check whether you already have the most up-to-date version of the resource, and therefore do not need the resource sent again. The value of the `If-None-Match` header is the ETag (`_etag`) property of the resource. It is recommended that your application use this header whenever possible to reduce bandwidth.}\n@returns(200) 200: Operation successful.\n@errors {304: 304: Not modified.}\n\n@endpoint DELETE /languages/{languageID}\n@desc Delete a Language by ID\n@required {languageID: any # The ID of the Language to perform the operation on}\n@optional {ifMatch: any # The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before updating or deleting it. The value of the `If-Match` header is the ETag (`_etag`) property of the resource. It is recommended that your application use this header whenever possible to avoid data conflicts.}\n@returns(204) 204: Delete operation successful.\n\n@endpoint PATCH /languages/{languageID}\n@desc Perform a partial update on a Language\n@required {languageID: any # The ID of the Language to perform the operation on, body: map # A database resource to upsert}\n@optional {ifMatch: any # The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before updating or deleting it. The value of the `If-Match` header is the ETag (`_etag`) property of the resource. It is recommended that your application use this header whenever possible to avoid data conflicts.}\n@returns(200) 200: Update successful.\n\n@endpoint GET /languages/{languageID}/lexemes\n@desc Get all Lexemes for a Language\n@required {languageID: any # The ID of the Language to perform the operation on}\n@optional {continuation: any # The `dlx-continuation` header is used to send a continuation token with the request, when retrieving the next page of results., deleted: any # Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database. Otherwise requests for a resource marked for deletion will return a 410 error., ifModifiedSince: any # The `If-Modified-Since` header is used to retrieve only results modified since a given time. The value of this header must be a valid date string., maxItemCount: any # The `dlx-max-item-count` header is used to limit the number of results to a certain amount at a time (by default all results will be returned). If there are more results to be returned, a continuation token will also be sent in the `dlx-continuation` header., public: any # Set this parameter to `true` to include all publicly-accessible resources, not just those that the user is listed as an Owner, Contributor, or Viewer for.}\n@returns(200) 200: Operation successful.\n\n@endpoint POST /languages/{languageID}/lexemes\n@desc Add a new Lexeme to a Language\n@required {languageID: any # The ID of the Language to perform the operation on}\n@returns(201) 201: The resource was created successfully.\n\n@endpoint PUT /languages/{languageID}/lexemes\n@desc Upsert (add or replace) a Lexeme\n@required {languageID: any # The ID of the Language to perform the operation on}\n@optional {ifMatch: any # The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before updating or deleting it. The value of the `If-Match` header is the ETag (`_etag`) property of the resource. It is recommended that your application use this header whenever possible to avoid data conflicts.}\n@returns(201) 201: Upsert successful.\n\n@endpoint GET /languages/{languageID}/lexemes/{lexemeID}\n@desc Get a Lexeme by ID\n@required {languageID: any # The ID of the Language to perform the operation on, lexemeID: any # The ID of the Lexeme to perform the operation on}\n@optional {deleted: any # Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database. Otherwise requests for a resource marked for deletion will return a 410 error., ifNoneMatch: any # If `If-None-Match` header is used with GET requests to check whether you already have the most up-to-date version of the resource, and therefore do not need the resource sent again. The value of the `If-None-Match` header is the ETag (`_etag`) property of the resource. It is recommended that your application use this header whenever possible to reduce bandwidth.}\n@returns(200) 200: Operation successful.\n@errors {304: 304: Not modified.}\n\n@endpoint DELETE /languages/{languageID}/lexemes/{lexemeID}\n@desc Delete a Lexeme by ID\n@required {languageID: any # The ID of the Language to perform the operation on, lexemeID: any # The ID of the Lexeme to perform the operation on}\n@optional {ifMatch: any # The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before updating or deleting it. The value of the `If-Match` header is the ETag (`_etag`) property of the resource. It is recommended that your application use this header whenever possible to avoid data conflicts.}\n@returns(204) 204: Delete operation successful.\n\n@endpoint PATCH /languages/{languageID}/lexemes/{lexemeID}\n@desc Perform a partial update on a Lexeme\n@required {languageID: any # The ID of the Language to perform the operation on, lexemeID: any # The ID of the Lexeme to perform the operation on}\n@optional {ifMatch: any # The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before updating or deleting it. The value of the `If-Match` header is the ETag (`_etag`) property of the resource. It is recommended that your application use this header whenever possible to avoid data conflicts.}\n@returns(200) 200: Update successful.\n\n@endgroup\n\n@group lexemes\n@endpoint GET /lexemes\n@desc Get all Lexemes\n@optional {continuation: any # The `dlx-continuation` header is used to send a continuation token with the request, when retrieving the next page of results., deleted: any # Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database. Otherwise requests for a resource marked for deletion will return a 410 error., ifModifiedSince: any # The `If-Modified-Since` header is used to retrieve only results modified since a given time. The value of this header must be a valid date string., languageID: any # The ID of the Language to perform the operation on, maxItemCount: any # The `dlx-max-item-count` header is used to limit the number of results to a certain amount at a time (by default all results will be returned). If there are more results to be returned, a continuation token will also be sent in the `dlx-continuation` header., public: any # Set this parameter to `true` to include all publicly-accessible resources, not just those that the user is listed as an Owner, Contributor, or Viewer for.}\n@returns(200) 200: Operation successful.\n\n@endpoint POST /lexemes\n@desc Add a new Lexeme\n@optional {languageID: any # The ID of the Language to perform the operation on}\n@returns(201) 201: The resource was created successfully.\n\n@endpoint PUT /lexemes\n@desc Upsert (add or replace) a Lexeme\n@optional {ifMatch: any # The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before updating or deleting it. The value of the `If-Match` header is the ETag (`_etag`) property of the resource. It is recommended that your application use this header whenever possible to avoid data conflicts., languageID: any # The ID of the Language to perform the operation on}\n@returns(201) 201: Upsert successful.\n\n@endpoint GET /lexemes/{lexemeID}\n@desc Get a Lexeme by ID\n@required {lexemeID: any # The ID of the Lexeme to perform the operation on}\n@optional {deleted: any # Setting the `deleted` option to `true` will return results that have been marked for deletion, but not yet deleted from the database. Otherwise requests for a resource marked for deletion will return a 410 error., ifNoneMatch: any # If `If-None-Match` header is used with GET requests to check whether you already have the most up-to-date version of the resource, and therefore do not need the resource sent again. The value of the `If-None-Match` header is the ETag (`_etag`) property of the resource. It is recommended that your application use this header whenever possible to reduce bandwidth.}\n@returns(200) 200: Operation successful.\n@errors {304: 304: Not modified.}\n\n@endpoint DELETE /lexemes/{lexemeID}\n@desc Delete a Lexeme by ID\n@required {lexemeID: any # The ID of the Lexeme to perform the operation on}\n@optional {ifMatch: any # The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before updating or deleting it. The value of the `If-Match` header is the ETag (`_etag`) property of the resource. It is recommended that your application use this header whenever possible to avoid data conflicts.}\n@returns(204) 204: Delete operation successful.\n\n@endpoint PATCH /lexemes/{lexemeID}\n@desc Perform a partial update on a Lexeme\n@required {lexemeID: any # The ID of the Lexeme to perform the operation on}\n@optional {ifMatch: any # The `If-Match` header is used with PUT and DELETE requests to check whether you have the most up-to-date version of the resource before updating or deleting it. The value of the `If-Match` header is the ETag (`_etag`) property of the resource. It is recommended that your application use this header whenever possible to avoid data conflicts.}\n@returns(200) 200: Update successful.\n\n@endgroup\n\n@end\n"}