Skip to content

Commit

Permalink
Update server specs
Browse files Browse the repository at this point in the history
  • Loading branch information
matsbov committed Jun 26, 2024
1 parent 576617f commit e114900
Show file tree
Hide file tree
Showing 4 changed files with 1,767 additions and 194 deletions.
1 change: 0 additions & 1 deletion src/specs/collections
Original file line number Diff line number Diff line change
Expand Up @@ -1915,5 +1915,4 @@ components:
clientCredentials:
scopes: {}
authorizationCode:
authorizationUrl: https://auth.biodiversitydata.se/cas/oidc
scopes: {}
74 changes: 37 additions & 37 deletions src/specs/images
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ info:
license:
name: Mozilla Public License 1.1
url: https://www.mozilla.org/en-US/MPL/1.1/
version: 2.0.4
version: 3.0.0
servers:
- url: https://images.biodiversitydata.se
paths:
Expand Down Expand Up @@ -208,7 +208,7 @@ paths:
tags:
- BatchUpdate
summary: Upload zipped AVRO files for loading
description: 'Upload zipped AVRO files for loading. Required scopes: ''image-service/write''.'
description: "Upload zipped AVRO files for loading. Required scopes: 'image-service/write'."
operationId: upload
parameters:
- name: dataResourceUid
Expand Down Expand Up @@ -271,7 +271,7 @@ paths:
/image/details:
get:
tags:
- Access to image derivatives (e.g. thumbnails, tiles and originals)
- "Access to image derivatives (e.g. thumbnails, tiles and originals)"
summary: Get original image.
description: Get original image.
operationId: details
Expand Down Expand Up @@ -337,9 +337,9 @@ paths:
/image/{id}/original:
get:
tags:
- Access to image derivatives (e.g. thumbnails, tiles and originals)
summary: Get original image, sound or video file.
description: Get original image, sound or video file.
- "Access to image derivatives (e.g. thumbnails, tiles and originals)"
summary: "Get original image, sound or video file."
description: "Get original image, sound or video file."
operationId: getOriginalFile
parameters:
- name: id
Expand Down Expand Up @@ -388,7 +388,7 @@ paths:
/image/{id}/thumbnail:
get:
tags:
- Access to image derivatives (e.g. thumbnails, tiles and originals)
- "Access to image derivatives (e.g. thumbnails, tiles and originals)"
summary: Get image thumbnail.
description: Get image thumbnail.
operationId: proxyImageThumbnail
Expand Down Expand Up @@ -439,7 +439,7 @@ paths:
/image/{id}/large:
get:
tags:
- Access to image derivatives (e.g. thumbnails, tiles and originals)
- "Access to image derivatives (e.g. thumbnails, tiles and originals)"
summary: Get image thumbnail large version.
description: Get image thumbnail large version.
operationId: proxyImageThumbnailType
Expand Down Expand Up @@ -490,7 +490,7 @@ paths:
/image/{id}/tms/{z}/{x}/{y}.png:
get:
tags:
- Access to image derivatives (e.g. thumbnails, tiles and originals)
- "Access to image derivatives (e.g. thumbnails, tiles and originals)"
summary: Get image tile - for use with tile mapping service clients such as
LeafletJS or Openlayers.
description: Get image tile - for use with tile mapping service clients such
Expand Down Expand Up @@ -563,7 +563,7 @@ paths:
tags:
- Tag services
summary: Tag an image
description: 'Tag an image. Required scopes: ''image-service/write''.'
description: "Tag an image. Required scopes: 'image-service/write'."
operationId: attachTagToImageWS
parameters:
- name: tagId
Expand Down Expand Up @@ -645,7 +645,7 @@ paths:
tags:
- Tag services
summary: Detach tag from image
description: 'Detach tag from image. Required scopes: ''image-service/write''.'
description: "Detach tag from image. Required scopes: 'image-service/write'."
operationId: detachTagFromImageWS
parameters:
- name: tagId
Expand Down Expand Up @@ -728,7 +728,7 @@ paths:
tags:
- Image metadata
summary: Bulk Add User Metadata To Image
description: 'Bulk Add User Metadata To Image. Required scopes: ''image-service/write''.'
description: "Bulk Add User Metadata To Image. Required scopes: 'image-service/write'."
operationId: bulkAddUserMetadataToImage_1
parameters:
- name: id
Expand Down Expand Up @@ -791,7 +791,7 @@ paths:
tags:
- Tile jobs
summary: Cancel Tile Job
description: 'Cancel Tile Job. Required scopes: ''image-service/write''.'
description: "Cancel Tile Job. Required scopes: 'image-service/write'."
operationId: cancelTileJob
parameters:
- name: jobTicket
Expand Down Expand Up @@ -847,7 +847,7 @@ paths:
tags:
- Tag services
summary: Create tag by path
description: 'Create tag by path. Required scopes: ''image-service/write''.'
description: "Create tag by path. Required scopes: 'image-service/write'."
operationId: createTagByPathWS
parameters:
- name: tagPath
Expand Down Expand Up @@ -1044,7 +1044,7 @@ paths:
tags:
- JSON services for accessing and updating metadata
summary: Delete image
description: 'Delete image. Required scopes: ''image-service/write''.'
description: "Delete image. Required scopes: 'image-service/write'."
operationId: deleteImageService
parameters:
- name: imageID
Expand Down Expand Up @@ -1140,7 +1140,7 @@ paths:
tags:
- Tag services
summary: Delete tag
description: 'Delete tag. Required scopes: ''image-service/write''.'
description: "Delete tag. Required scopes: 'image-service/write'."
operationId: deleteTagWS
parameters:
- name: tagId
Expand Down Expand Up @@ -1522,8 +1522,8 @@ paths:
description: Find image by original filename (URL).
operationId: findImagesByOriginalFilename
requestBody:
description: JSON Document of with a single field, filenames, which contains
a list of file names.
description: "JSON Document of with a single field, filenames, which contains\
\ a list of file names."
content:
application/json:
schema:
Expand Down Expand Up @@ -1585,8 +1585,8 @@ paths:
tags:
- Upload
summary: Get batch status for a batch upload of images
description: 'Get batch status for a batch upload of images. Required scopes:
''image-service/read''.'
description: "Get batch status for a batch upload of images. Required scopes:\
\ 'image-service/read'."
operationId: getBatchStatus
parameters:
- name: batchId
Expand Down Expand Up @@ -1666,8 +1666,8 @@ paths:
description: Get images for a list of image IDs.
operationId: getImageInfoForIdList
requestBody:
description: JSON Document of with a single field, imageIds, which contains
a list of image ids.
description: "JSON Document of with a single field, imageIds, which contains\
\ a list of image ids."
content:
application/json:
schema:
Expand Down Expand Up @@ -1956,7 +1956,7 @@ paths:
tags:
- Tag services
summary: Get tag model
description: 'Get tag model. Required scopes: ''image-service/write''.'
description: "Get tag model. Required scopes: 'image-service/write'."
operationId: getTagModelWS
responses:
"200":
Expand Down Expand Up @@ -2148,7 +2148,7 @@ paths:
tags:
- Tag services
summary: Move tag
description: 'Move tag. Required scopes: ''image-service/write''.'
description: "Move tag. Required scopes: 'image-service/write'."
operationId: moveTagWS
parameters:
- name: targetTagId
Expand Down Expand Up @@ -2248,7 +2248,7 @@ paths:
tags:
- Image metadata
summary: Remove User Metadata from Image
description: 'Remove User Metadata from Image. Required scopes: ''image-service/write''.'
description: "Remove User Metadata from Image. Required scopes: 'image-service/write'."
operationId: removeUserMetadataFromImageWS
parameters:
- name: id
Expand Down Expand Up @@ -2331,7 +2331,7 @@ paths:
tags:
- Tag services
summary: Rename tag
description: 'Rename tag. Required scopes: ''image-service/write''.'
description: "Rename tag. Required scopes: 'image-service/write'."
operationId: renameTagWS
parameters:
- name: tagID
Expand Down Expand Up @@ -2414,7 +2414,7 @@ paths:
tags:
- JSON services for accessing and updating metadata
summary: Schedule artifact generation
description: 'Schedule artifact generation. Required scopes: ''image-service/write''.'
description: "Schedule artifact generation. Required scopes: 'image-service/write'."
operationId: scheduleArtifactGenerationWS
parameters:
- name: id
Expand Down Expand Up @@ -2504,7 +2504,7 @@ paths:
tags:
- JSON services for accessing and updating metadata
summary: Schedule keyword generation
description: 'Schedule keyword generation. Required scopes: ''image-service/write''.'
description: "Schedule keyword generation. Required scopes: 'image-service/write'."
operationId: scheduleKeywordRegenerationWS
parameters:
- name: id
Expand Down Expand Up @@ -2598,7 +2598,7 @@ paths:
tags:
- JSON services for accessing and updating metadata
summary: Schedule thumbnail generation
description: 'Schedule thumbnail generation. Required scopes: ''image-service/write''.'
description: "Schedule thumbnail generation. Required scopes: 'image-service/write'."
operationId: scheduleThumbnailGenerationWS
parameters:
- name: id
Expand Down Expand Up @@ -2846,7 +2846,7 @@ paths:
tags:
- Tag services
summary: Create Subimage
description: 'Create Subimage. Required scopes: ''image-service/write''.'
description: "Create Subimage. Required scopes: 'image-service/write'."
operationId: subimage
parameters:
- name: id
Expand Down Expand Up @@ -2972,7 +2972,7 @@ paths:
tags:
- JSON services for accessing and updating metadata
summary: Update image metadata using a JSON payload.
description: 'Update image metadata using a JSON payload. Required scopes: ''image-service/write''.'
description: "Update image metadata using a JSON payload. Required scopes: 'image-service/write'."
operationId: updateMetadata
parameters:
- name: imageIdentifier
Expand All @@ -2983,7 +2983,7 @@ paths:
type: string
- name: metadata
in: query
description: Metadata as a JSON document, encoded as a POST param
description: "Metadata as a JSON document, encoded as a POST param"
schema:
type: string
- name: tags
Expand Down Expand Up @@ -3082,7 +3082,7 @@ paths:
parameters:
- name: metadata
in: query
description: Metadata as a JSON document, encoded as a POST param
description: "Metadata as a JSON document, encoded as a POST param"
schema:
type: string
- name: tags
Expand All @@ -3094,13 +3094,13 @@ paths:
type: string
- name: imageUrl
in: query
description: An URL to be used to load the image from, use in lieu of sending
a multipart upload
description: "An URL to be used to load the image from, use in lieu of sending\
\ a multipart upload"
schema:
type: string
requestBody:
description: Multipart file upload, use image for the part name - TODO This
needs properties for the multipart
description: "Multipart file upload, use image for the part name - TODO This\
\ needs properties for the multipart"
content:
multipart/form-data:
schema:
Expand Down
2 changes: 1 addition & 1 deletion src/specs/records

Large diffs are not rendered by default.

Loading

0 comments on commit e114900

Please sign in to comment.