triannon 2.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +8 -7
  3. data/lib/triannon/version.rb +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 0a7836e167aa59510f75b69435f06de72d75a4c6
4
- data.tar.gz: efc5bc0bff62bfc9347590b2a13c0e144688e2ed
3
+ metadata.gz: ebfe9c918d54957dd9840f3cca19729075b1f0e9
4
+ data.tar.gz: aa9007f6543d8604a0be0a0b876c33e65be2168d
5
5
  SHA512:
6
- metadata.gz: 04a8c245627c35a0c1d099a40c1d71138e25964f91f8f329c36b628beddd13eca016ef86cfccac88ec98b8dde7d280c79d19a869062752e901e01146fa862918
7
- data.tar.gz: 67c3f60fa650ddbcaf6763582f1faf634d4b8766d56ebd3ae505894e96397eab2604d578d92bdb57c6f40da794a55398bdbf3047a8cfb26aad18e7cc9fbbd6e9
6
+ metadata.gz: 55ce6508e866549664f1c359cb311d479054319377fad1f8af2a17dcea20dc097b2a3b1e30f016e4cea33900d76c4477c31e2803d0822f4410b350e2a1ece7a1
7
+ data.tar.gz: 492c6fac232ae72b213ebc339bc9b519c4b39b4ca22ccd8e8724e7ecbd764209519524b9232dc3b08022ed4067184f88ecb016eb1870abcfab01131097292bd1
data/README.md CHANGED
@@ -83,6 +83,7 @@ Search Parameters:
83
83
  * `bodyExact` - matches body characters exactly
84
84
  * `bodyKeyword` - matches terms in body characters
85
85
  * `motivatedBy` - matches fragment part of motivation predicate URI, e.g. commenting, tagging, painting
86
+ * `anno_root` - matches the root container of the result annos
86
87
 
87
88
  * use HTTP `Accept` header with mime type to indicate desired format
88
89
  * default: jsonld
@@ -93,7 +94,7 @@ Search Parameters:
93
94
  ### Get a list of annos in a particular root container
94
95
  as a IIIF Annotation List (see http://iiif.io/api/presentation/2.0/#other-content-resources)
95
96
 
96
- * `GET`: `http://(host)/annotations/(root container name)/search?targetUri=some.url.org`
97
+ * `GET`: `http://(host)/annotations/(root container)/search?targetUri=some.url.org`
97
98
 
98
99
  Search Parameters as above.
99
100
 
@@ -128,17 +129,17 @@ The correct way:
128
129
  * `Accept`: `application/ld+json; profile="http://www.w3.org/ns/oa-context-20130208.json"`
129
130
  * `Accept`: `application/ld+json; profile="http://iiif.io/api/presentation/2/context.json"`
130
131
 
131
- You can also use either of these methods (with the correct HTTP Accept header):
132
+ You can also use this method (with the correct HTTP Accept header):
132
133
 
133
- * `GET`: `http://(host)/annotations/iiif/(anno_id)`
134
- * `GET`: `http://(host)/annotations/(anno_id)?jsonld_context=iiif`
135
-
136
- * `GET`:` http://(host)/annotations/oa/(anno_id)`
137
- * `GET`: `http://(host)/annotations/(anno_id)?jsonld_context=oa`
134
+ * `GET`: `http://(host)/annotations/(root)/(anno_id)?jsonld_context=iiif`
135
+ * `GET`: `http://(host)/annotations/(root)/(anno_id)?jsonld_context=oa`
138
136
 
139
137
  Note that OA (Open Annotation) is the default context if none is specified.
140
138
 
141
139
  ### Create an anno
140
+
141
+ Note that annos must be created in an existing root container.
142
+
142
143
  `POST`: `http://(host)/annotations/(root container)`
143
144
  * the body of the HTTP request should contain the annotation, as jsonld, turtle, or rdfxml
144
145
  * Wrap the annotation in an object, as such:
@@ -1,3 +1,3 @@
1
1
  module Triannon
2
- VERSION = "2.0.0"
2
+ VERSION = "2.0.1"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: triannon
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.0
4
+ version: 2.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Naomi Dushay