publish_my_data 1.2.4 → 1.3.0
Sign up to get free protection for your applications and to get access to all the features.
- data/app/assets/stylesheets/publish_my_data/core/5000-styling.scss +33 -0
- data/app/helpers/publish_my_data/application_helper.rb +6 -0
- data/app/helpers/publish_my_data/documentation_helper.rb +70 -0
- data/app/views/layouts/publish_my_data/application.html.haml +11 -2
- data/app/views/layouts/publish_my_data/docs.html.haml +19 -0
- data/app/views/publish_my_data/content/_docs_index.html.haml +650 -939
- data/app/views/publish_my_data/docs/index.html.haml +1 -7
- data/lib/publish_my_data/version.rb +1 -1
- data/spec/dummy/app/views/layouts/application.html.erb +1 -3
- metadata +4 -6
- data/app/views/layouts/publish_my_data/pmd_layout.html.haml +0 -18
- data/app/views/publish_my_data/content/_docs_api_keys.html.haml +0 -64
- data/app/views/publish_my_data/docs/accessibility.html.haml +0 -11
- data/app/views/publish_my_data/docs/privacy.html.haml +0 -11
@@ -2,10 +2,4 @@
|
|
2
2
|
- set_page_title "Developer documentation"
|
3
3
|
- bodyclass 'docs'
|
4
4
|
|
5
|
-
|
6
|
-
=fullwidth do
|
7
|
-
= page_title("Developer documentation")
|
8
|
-
|
9
|
-
%section
|
10
|
-
=fullwidth do
|
11
|
-
= render 'publish_my_data/content/docs_index'
|
5
|
+
= render 'publish_my_data/content/docs_index'
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: publish_my_data
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.3.0
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -376,6 +376,7 @@ files:
|
|
376
376
|
- app/controllers/publish_my_data/vocabularies_controller.rb
|
377
377
|
- app/helpers/publish_my_data/application_helper.rb
|
378
378
|
- app/helpers/publish_my_data/datasets_helper.rb
|
379
|
+
- app/helpers/publish_my_data/documentation_helper.rb
|
379
380
|
- app/helpers/publish_my_data/resources_helper.rb
|
380
381
|
- app/helpers/publish_my_data/sample_data_helper.rb
|
381
382
|
- app/helpers/publish_my_data/sparql_helper.rb
|
@@ -402,22 +403,19 @@ files:
|
|
402
403
|
- app/models/publish_my_data/third_party/ontology.rb
|
403
404
|
- app/models/publish_my_data/vocabulary.rb
|
404
405
|
- app/views/layouts/publish_my_data/application.html.haml
|
406
|
+
- app/views/layouts/publish_my_data/docs.html.haml
|
405
407
|
- app/views/layouts/publish_my_data/error.html.haml
|
406
|
-
- app/views/layouts/publish_my_data/pmd_layout.html.haml
|
407
408
|
- app/views/publish_my_data/changelog/_log.html.haml
|
408
409
|
- app/views/publish_my_data/classes/show.html.haml
|
409
410
|
- app/views/publish_my_data/concept_schemes/show.html.haml
|
410
411
|
- app/views/publish_my_data/concepts/show.html.haml
|
411
|
-
- app/views/publish_my_data/content/_docs_api_keys.html.haml
|
412
412
|
- app/views/publish_my_data/content/_docs_index.html.haml
|
413
413
|
- app/views/publish_my_data/datasets/_example_resources.html.haml
|
414
414
|
- app/views/publish_my_data/datasets/_types_table.html.erb
|
415
415
|
- app/views/publish_my_data/datasets/index.html.haml
|
416
416
|
- app/views/publish_my_data/datasets/show.atom.builder
|
417
417
|
- app/views/publish_my_data/datasets/show.html.haml
|
418
|
-
- app/views/publish_my_data/docs/accessibility.html.haml
|
419
418
|
- app/views/publish_my_data/docs/index.html.haml
|
420
|
-
- app/views/publish_my_data/docs/privacy.html.haml
|
421
419
|
- app/views/publish_my_data/docs/publish_my_data.html.haml
|
422
420
|
- app/views/publish_my_data/docs/tools.html.haml
|
423
421
|
- app/views/publish_my_data/errors/not_found.html.haml
|
@@ -547,7 +545,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
547
545
|
version: '0'
|
548
546
|
segments:
|
549
547
|
- 0
|
550
|
-
hash:
|
548
|
+
hash: -4484494326852078410
|
551
549
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
552
550
|
none: false
|
553
551
|
requirements:
|
@@ -1,18 +0,0 @@
|
|
1
|
-
!!! 5
|
2
|
-
%html
|
3
|
-
= yield :head
|
4
|
-
|
5
|
-
%body{class:@bodyclass || ""}
|
6
|
-
|
7
|
-
= yield :global_header
|
8
|
-
|
9
|
-
%main.pmd
|
10
|
-
= render 'publish_my_data/stripes/subnav'
|
11
|
-
= render 'publish_my_data/stripes/status'
|
12
|
-
|
13
|
-
%article
|
14
|
-
= yield
|
15
|
-
= render 'publish_my_data/stripes/formats'
|
16
|
-
|
17
|
-
= render 'publish_my_data/stripes/footer'
|
18
|
-
= render 'publish_my_data/shared/google_analytics'
|
@@ -1,64 +0,0 @@
|
|
1
|
-
.subsection#api-keys
|
2
|
-
%h3
|
3
|
-
4.5
|
4
|
-
%strong API Keys
|
5
|
-
|
6
|
-
%h4
|
7
|
-
4.5.1
|
8
|
-
%strong Obtaining an API key
|
9
|
-
:markdown
|
10
|
-
You can #{link_to "register for an API key", publish_my_data_enterprise.new_user_registration_path} to obtain unthrottled access to our API, analytics, and announcements about upcoming API changes. Upon registering you will be logged in and taken to your profile page which displays your unique key. You should then use the API key with all requests to our API.
|
11
|
-
|
12
|
-
%h4
|
13
|
-
4.5.2
|
14
|
-
%strong Using the API Key
|
15
|
-
|
16
|
-
%p To use the API key, supply it in your requests to our API (including for SPARQL queries) via either:
|
17
|
-
|
18
|
-
%ul
|
19
|
-
%li the <code class='click_to_select'>X-PublishMyData-APIKey</code> HTTP header, or
|
20
|
-
%li the <code class='click_to_select'>api_key</code> query string parameter
|
21
|
-
%br
|
22
|
-
:markdown
|
23
|
-
Note that some corporate or goverment networks may strip non-standard HTTP headers, so in these situations we recommend using the query string parameter instead.
|
24
|
-
|
25
|
-
%h4
|
26
|
-
4.5.3
|
27
|
-
%strong Supplying the API Key in an HTTP header
|
28
|
-
|
29
|
-
:markdown
|
30
|
-
For example, using the cURL command line tool to supply the API key in an HTTP header.
|
31
|
-
|
32
|
-
%code.prettyprint
|
33
|
-
= preserve do
|
34
|
-
:escaped
|
35
|
-
curl -H "X-PublishMyData-APIKey: <your-api-key-here>" <request-url>
|
36
|
-
|
37
|
-
:markdown
|
38
|
-
Replace <your-api-key-here> with your actual API key. e.g.
|
39
|
-
|
40
|
-
%code.prettyprint
|
41
|
-
= preserve do
|
42
|
-
:escaped
|
43
|
-
curl -H "X-PublishMyData-APIKey: 1a3e2562d2466ecb9462ddfd723a4597" http://opendatacommunities.org/data/additional-affordable-dwellings.json
|
44
|
-
|
45
|
-
|
46
|
-
%h4
|
47
|
-
4.5.4
|
48
|
-
%string Supplying the API key in a query string parameter
|
49
|
-
|
50
|
-
:markdown
|
51
|
-
For example, using the cURL command line tool to supply the API key in the custom HTTP header.
|
52
|
-
|
53
|
-
%code.prettyprint
|
54
|
-
= preserve do
|
55
|
-
:escaped
|
56
|
-
curl http://opendatacommunities.org/data/affordable-housing?api_key=<your-api-key-here>
|
57
|
-
|
58
|
-
:markdown
|
59
|
-
Replace <your-api-key-here> with your actual API key. For example:
|
60
|
-
|
61
|
-
%code.prettyprint
|
62
|
-
= preserve do
|
63
|
-
:escaped
|
64
|
-
curl http://opendatacommunities.org/data/additional-affordable-dwellings.json?api_key=1a3e2562d2466ecb9462ddfd723a4597
|