Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

first pass at services compatibility table #2106

Draft
wants to merge 1 commit into
base: annex-migration-services
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions source/registry/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,38 @@ The process for having an entry included in one of the IIIF extension registries

# Registries

## Table of Services and Extensions

This table summarizes the services and extensions available and in which APIs they may be used.

| Icon | Meaning |
| -------------------------- | ----------- |
| ![required][icon3-req] | Required |
| ![recommended][icon3-rec] | Recommended |
| ![optional][icon3-opt] | Optional |
| ![not allowed][icon3-na] | Not Allowed |
{: .api-table #table-reqs-icons}

| Service/Extension | Type | Image 2 API | Image 3 API | Presentation 2 API | Presentation 3 API |
| ----------------- | ---------- | ----------- | ----------- | ------------------ | ------------------ |
| [Image 2 API][image21] | service | N/A | N/A | ![recommended][icon3-rec] | ![recommended][icon3-rec] |
| [Image 3 API][image-api] | service | N/A | N/A | ![optional][icon3-opt] | ![recommended][icon3-rec] |
| Image Information | service | N/A | N/A | ![recommended][icon3-rec] | ![recommended][icon3-rec] |
| Search 1 | service | N/A | N/A | ![recommended][icon3-rec] | ![optional][icon3-opt] (prefer search2) |
| Search 2 (in development) | service | N/A | N/A | ![not allowed][icon3-na] | ![recommended][icon3-rec] |
| PhysDim | service | ![recommended][icon3-rec] | ![not allowed][icon3-na] | ![recommended][icon3-rec] | ![not allowed][icon3-na] |
| PhysDim | extension | ![not allowed][icon3-na] | ![recommended][icon3-rec] | ![not allowed][icon3-na] | ![recommended][icon3-rec] |
| GeoJSON | service | ![recommended][icon3-rec] | ![not allowed][icon3-na] | ![recommended][icon3-rec] | ![not allowed][icon3-na] |
| navPlace | extension | ![not allowed][icon3-na] | ![recommended][icon3-rec] | ![not allowed][icon3-na] | ![recommended][icon3-rec] |
| Text Granularity | extension | N/A | N/A | ![not allowed][icon3-na] | ![recommended][icon3-rec] |
| [IIIF Authentication API 1.0][auth10] | service | ![recommended][icon3-rec] | | | |
| Auth 2 (in development) | service | ![not allowed][icon3-na] | ![recommended][icon3-rec] | ![not allowed][icon3-na] | ![recommended][icon3-rec] |
| [IIIF Change Discovery API][discovery-stable-version] | service | N/A | N/A | ![recommended][icon3-rec]| ![recommended][icon3-rec] |
| [IIIF Content State API][contentstate03] | service | | | ![not allowed][icon3-na] | ![recommended][icon3-rec] |
| Image API Selector | extension | | | ![recommended][icon3-rec] | ![recommended][icon3-rec] |
| Point Selector | extension | ![not allowed][icon3-na] | ![not allowed][icon3-na] | ![not allowed][icon3-na] | ![recommended][icon3-rec] |
| Content Selectors | extension | ![not allowed][icon3-na] | ![not allowed][icon3-na] | ![not allowed][icon3-na] | ![recommended][icon3-rec] |

## Presentation API Registries

* [Behaviors][registry-behaviors]
Expand Down
4 changes: 2 additions & 2 deletions source/registry/services/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The process for having a new entry added to this registry is [described here][re

## 3. Registry

This table summarizes the services available and which APIs they may be used in. For the icons and their meanings, consult the [Summary of Property Requirements][prezi30-appendixa] icon table in the IIIF Presentation 3 API documentation.
This table summarizes the services available and in which APIs they may be used. For the icons and their meanings, consult the [Summary of Property Requirements][prezi30-appendixa] icon table in the IIIF Presentation 3 API documentation.

| Service | Image API | Presentation 2 API | Presentation 3 API |
| ------------------------------ |:-------------------------:|:-------------------------:|:-------------------------:|
Expand All @@ -75,8 +75,8 @@ The following names have been added as of version 3.0 of the Image and Presentat

| Value | Specification |
| -------------------- | ------------- |
| ImageService1 | [Image API version 1][image11] |
| ImageService2 | [Image API version 2][image21] |
| ImageService3 | [Image API version 3][image-api] |
| SearchService1 | [Search API version 1][search1] |
| SearchService2 | In development |
| AutoCompleteService1 | [Search API version 1][search1-autocomplete] |
Expand Down