apipierails3 0.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.
- checksums.yaml +17 -0
- data/.gitignore +14 -0
- data/.rspec +2 -0
- data/.travis.yml +27 -0
- data/APACHE-LICENSE-2.0 +202 -0
- data/CHANGELOG.md +469 -0
- data/Gemfile +1 -0
- data/Gemfile.rails32 +6 -0
- data/Gemfile.rails41 +6 -0
- data/Gemfile.rails42 +11 -0
- data/Gemfile.rails50 +6 -0
- data/Gemfile.rails51 +7 -0
- data/MIT-LICENSE +20 -0
- data/NOTICE +4 -0
- data/PROPOSAL_FOR_RESPONSE_DESCRIPTIONS.md +244 -0
- data/README.rst +1874 -0
- data/Rakefile +13 -0
- data/apipierails3.gemspec +27 -0
- data/app/controllers/apipie/apipies_controller.rb +199 -0
- data/app/helpers/apipie_helper.rb +10 -0
- data/app/public/apipie/javascripts/apipie.js +6 -0
- data/app/public/apipie/javascripts/bundled/bootstrap-collapse.js +138 -0
- data/app/public/apipie/javascripts/bundled/bootstrap.js +1726 -0
- data/app/public/apipie/javascripts/bundled/jquery.js +5 -0
- data/app/public/apipie/javascripts/bundled/prettify.js +28 -0
- data/app/public/apipie/stylesheets/application.css +7 -0
- data/app/public/apipie/stylesheets/bundled/bootstrap-responsive.min.css +12 -0
- data/app/public/apipie/stylesheets/bundled/bootstrap.min.css +689 -0
- data/app/public/apipie/stylesheets/bundled/prettify.css +30 -0
- data/app/views/apipie/apipies/_disqus.html.erb +13 -0
- data/app/views/apipie/apipies/_errors.html.erb +23 -0
- data/app/views/apipie/apipies/_headers.html.erb +26 -0
- data/app/views/apipie/apipies/_languages.erb +6 -0
- data/app/views/apipie/apipies/_metadata.erb +1 -0
- data/app/views/apipie/apipies/_method_detail.erb +61 -0
- data/app/views/apipie/apipies/_params.html.erb +42 -0
- data/app/views/apipie/apipies/_params_plain.html.erb +20 -0
- data/app/views/apipie/apipies/apipie_404.html.erb +17 -0
- data/app/views/apipie/apipies/apipie_checksum.json.erb +1 -0
- data/app/views/apipie/apipies/getting_started.html.erb +6 -0
- data/app/views/apipie/apipies/index.html.erb +56 -0
- data/app/views/apipie/apipies/method.html.erb +41 -0
- data/app/views/apipie/apipies/plain.html.erb +77 -0
- data/app/views/apipie/apipies/resource.html.erb +80 -0
- data/app/views/apipie/apipies/static.html.erb +103 -0
- data/app/views/layouts/apipie/apipie.html.erb +27 -0
- data/config/locales/de.yml +28 -0
- data/config/locales/en.yml +32 -0
- data/config/locales/es.yml +28 -0
- data/config/locales/fr.yml +31 -0
- data/config/locales/it.yml +31 -0
- data/config/locales/ja.yml +31 -0
- data/config/locales/pl.yml +28 -0
- data/config/locales/pt-BR.yml +28 -0
- data/config/locales/ru.yml +28 -0
- data/config/locales/tr.yml +28 -0
- data/config/locales/zh-CN.yml +28 -0
- data/config/locales/zh-TW.yml +28 -0
- data/images/screenshot-1.png +0 -0
- data/images/screenshot-2.png +0 -0
- data/lib/apipie/apipie_module.rb +83 -0
- data/lib/apipie/application.rb +462 -0
- data/lib/apipie/configuration.rb +186 -0
- data/lib/apipie/dsl_definition.rb +607 -0
- data/lib/apipie/error_description.rb +44 -0
- data/lib/apipie/errors.rb +86 -0
- data/lib/apipie/extractor.rb +177 -0
- data/lib/apipie/extractor/collector.rb +117 -0
- data/lib/apipie/extractor/recorder.rb +166 -0
- data/lib/apipie/extractor/writer.rb +454 -0
- data/lib/apipie/helpers.rb +73 -0
- data/lib/apipie/markup.rb +48 -0
- data/lib/apipie/method_description.rb +273 -0
- data/lib/apipie/middleware/checksum_in_headers.rb +35 -0
- data/lib/apipie/param_description.rb +280 -0
- data/lib/apipie/railtie.rb +9 -0
- data/lib/apipie/resource_description.rb +124 -0
- data/lib/apipie/response_description.rb +131 -0
- data/lib/apipie/response_description_adapter.rb +200 -0
- data/lib/apipie/routes_formatter.rb +33 -0
- data/lib/apipie/routing.rb +16 -0
- data/lib/apipie/rspec/response_validation_helper.rb +192 -0
- data/lib/apipie/see_description.rb +39 -0
- data/lib/apipie/static_dispatcher.rb +69 -0
- data/lib/apipie/swagger_generator.rb +707 -0
- data/lib/apipie/tag_list_description.rb +11 -0
- data/lib/apipie/validator.rb +526 -0
- data/lib/apipie/version.rb +3 -0
- data/lib/apipierails3.rb +25 -0
- data/lib/generators/apipie/install/README +6 -0
- data/lib/generators/apipie/install/install_generator.rb +25 -0
- data/lib/generators/apipie/install/templates/initializer.rb.erb +7 -0
- data/lib/generators/apipie/views_generator.rb +11 -0
- data/lib/tasks/apipie.rake +345 -0
- data/rel-eng/packages/.readme +3 -0
- data/rel-eng/packages/rubygem-apipie-rails +1 -0
- data/rel-eng/tito.props +5 -0
- data/spec/controllers/api/v1/architectures_controller_spec.rb +29 -0
- data/spec/controllers/api/v2/architectures_controller_spec.rb +12 -0
- data/spec/controllers/api/v2/nested/resources_controller_spec.rb +11 -0
- data/spec/controllers/apipies_controller_spec.rb +273 -0
- data/spec/controllers/concerns_controller_spec.rb +42 -0
- data/spec/controllers/extended_controller_spec.rb +11 -0
- data/spec/controllers/users_controller_spec.rb +740 -0
- data/spec/dummy/Rakefile +7 -0
- data/spec/dummy/app/controllers/api/base_controller.rb +4 -0
- data/spec/dummy/app/controllers/api/v1/architectures_controller.rb +43 -0
- data/spec/dummy/app/controllers/api/v1/base_controller.rb +11 -0
- data/spec/dummy/app/controllers/api/v2/architectures_controller.rb +30 -0
- data/spec/dummy/app/controllers/api/v2/base_controller.rb +11 -0
- data/spec/dummy/app/controllers/api/v2/nested/architectures_controller.rb +32 -0
- data/spec/dummy/app/controllers/api/v2/nested/resources_controller.rb +33 -0
- data/spec/dummy/app/controllers/application_controller.rb +18 -0
- data/spec/dummy/app/controllers/concerns/extending_concern.rb +11 -0
- data/spec/dummy/app/controllers/concerns/sample_controller.rb +41 -0
- data/spec/dummy/app/controllers/concerns_controller.rb +8 -0
- data/spec/dummy/app/controllers/extended_controller.rb +14 -0
- data/spec/dummy/app/controllers/files_controller.rb +5 -0
- data/spec/dummy/app/controllers/overridden_concerns_controller.rb +31 -0
- data/spec/dummy/app/controllers/pets_controller.rb +408 -0
- data/spec/dummy/app/controllers/pets_using_auto_views_controller.rb +73 -0
- data/spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb +95 -0
- data/spec/dummy/app/controllers/tagged_cats_controller.rb +32 -0
- data/spec/dummy/app/controllers/tagged_dogs_controller.rb +15 -0
- data/spec/dummy/app/controllers/twitter_example_controller.rb +307 -0
- data/spec/dummy/app/controllers/users_controller.rb +297 -0
- data/spec/dummy/app/views/layouts/application.html.erb +21 -0
- data/spec/dummy/config.ru +4 -0
- data/spec/dummy/config/application.rb +49 -0
- data/spec/dummy/config/boot.rb +10 -0
- data/spec/dummy/config/database.yml +21 -0
- data/spec/dummy/config/environment.rb +8 -0
- data/spec/dummy/config/environments/development.rb +28 -0
- data/spec/dummy/config/environments/production.rb +52 -0
- data/spec/dummy/config/environments/test.rb +38 -0
- data/spec/dummy/config/initializers/apipie.rb +110 -0
- data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/dummy/config/initializers/inflections.rb +10 -0
- data/spec/dummy/config/initializers/mime_types.rb +5 -0
- data/spec/dummy/config/initializers/secret_token.rb +8 -0
- data/spec/dummy/config/initializers/session_store.rb +8 -0
- data/spec/dummy/config/locales/en.yml +5 -0
- data/spec/dummy/config/routes.rb +51 -0
- data/spec/dummy/db/.gitkeep +0 -0
- data/spec/dummy/doc/apipie_examples.json +1 -0
- data/spec/dummy/doc/users/desc_from_file.md +1 -0
- data/spec/dummy/public/404.html +26 -0
- data/spec/dummy/public/422.html +26 -0
- data/spec/dummy/public/500.html +26 -0
- data/spec/dummy/public/favicon.ico +0 -0
- data/spec/dummy/public/stylesheets/.gitkeep +0 -0
- data/spec/dummy/script/rails +6 -0
- data/spec/lib/application_spec.rb +49 -0
- data/spec/lib/extractor/extractor_spec.rb +9 -0
- data/spec/lib/extractor/middleware_spec.rb +44 -0
- data/spec/lib/extractor/writer_spec.rb +110 -0
- data/spec/lib/file_handler_spec.rb +18 -0
- data/spec/lib/method_description_spec.rb +98 -0
- data/spec/lib/param_description_spec.rb +345 -0
- data/spec/lib/param_group_spec.rb +60 -0
- data/spec/lib/rake_spec.rb +71 -0
- data/spec/lib/resource_description_spec.rb +48 -0
- data/spec/lib/swagger/openapi_2_0_schema.json +1607 -0
- data/spec/lib/swagger/rake_swagger_spec.rb +139 -0
- data/spec/lib/swagger/response_validation_spec.rb +104 -0
- data/spec/lib/swagger/swagger_dsl_spec.rb +658 -0
- data/spec/lib/validator_spec.rb +113 -0
- data/spec/lib/validators/array_validator_spec.rb +85 -0
- data/spec/spec_helper.rb +109 -0
- data/spec/support/rake.rb +21 -0
- metadata +415 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
!binary "U0hBMjU2":
|
|
3
|
+
metadata.gz: !binary |-
|
|
4
|
+
M2Q2OTBhNTg5MTA3MjliNzZjMTA3YzdmMTJiOGE5YTIwMjQ3OTE2YTYzMjUw
|
|
5
|
+
Y2UxMGY1MTJmNWI4ZGNlY2Q5OA==
|
|
6
|
+
data.tar.gz: !binary |-
|
|
7
|
+
M2IxMjg1ODAzOWFjNjllOGJkYzA2MGEwNGU2Yjg3ODc5ZTRlNjE5M2EwNmM1
|
|
8
|
+
MGQwYmU3OWQ0YThiOWFkNjZhZA==
|
|
9
|
+
SHA512:
|
|
10
|
+
metadata.gz: !binary |-
|
|
11
|
+
NGQzN2U5NDg4ZDkzMTFlMjJhYjU4YTdhNWZhOTc2NDE1MmI5ZWI3ZWI2ZDVj
|
|
12
|
+
MjEwM2MxYjBhNDZmMjQ1N2YyYzIzNzlhMzc4ZGRlZDRhNTc5M2Q5MDAzMzM4
|
|
13
|
+
ZTU5N2M0ODdkNDYyMDAzNmZmOWYzMjYyMjE0ODBlMWI4YzdlN2I=
|
|
14
|
+
data.tar.gz: !binary |-
|
|
15
|
+
Mzk5NWVjMjNiNGQyMTEyMzNhMjFjOGNhOGI3MWJjMTdhMWUwNjM0ZGQxMDY1
|
|
16
|
+
MjAyMjBkZTE5MTdjMGJiN2Y2MDdmYmZjMDUxOTA0Mjg0YWUyMjA1NWE3YmM4
|
|
17
|
+
NGU3ZTljM2UzYjk0NjJmNjE2ZTI0Y2YzNzkzMzdjNzcxZWM3YjU=
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
language: ruby
|
|
2
|
+
sudo: false
|
|
3
|
+
before_install: >-
|
|
4
|
+
if ruby -v | grep 'ruby 2.2'; then
|
|
5
|
+
gem install bundler -v '~> 1.17'
|
|
6
|
+
fi
|
|
7
|
+
rvm:
|
|
8
|
+
- 2.2.10
|
|
9
|
+
- 2.3.8
|
|
10
|
+
- 2.4.5
|
|
11
|
+
- 2.5.3
|
|
12
|
+
- 2.6.0
|
|
13
|
+
gemfile:
|
|
14
|
+
- Gemfile.rails41
|
|
15
|
+
- Gemfile.rails42
|
|
16
|
+
- Gemfile.rails50 # Min ruby 2.2.2
|
|
17
|
+
- Gemfile.rails51 # Min ruby 2.2.2
|
|
18
|
+
matrix:
|
|
19
|
+
exclude:
|
|
20
|
+
- rvm: 2.4.5
|
|
21
|
+
gemfile: Gemfile.rails41
|
|
22
|
+
- rvm: 2.5.3
|
|
23
|
+
gemfile: Gemfile.rails41
|
|
24
|
+
- rvm: 2.6.0
|
|
25
|
+
gemfile: Gemfile.rails41
|
|
26
|
+
- rvm: 2.6.0
|
|
27
|
+
gemfile: Gemfile.rails42
|
data/APACHE-LICENSE-2.0
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,469 @@
|
|
|
1
|
+
Changelog
|
|
2
|
+
===========
|
|
3
|
+
[v0.5.15](https://github.com/Apipie/apipie-rails/tree/v0.5.15) (2019-01-03)
|
|
4
|
+
--------
|
|
5
|
+
[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.14...v0.5.15)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
- Fix authorization of resources [\#655](https://github.com/Apipie/apipie-rails/pull/655) ([NielsKSchjoedt](https://github.com/NielsKSchjoedt))
|
|
9
|
+
- Use configured value when swagger\_content\_type\_input argument is not passed [\#648](https://github.com/Apipie/apipie-rails/pull/648) ([nullnull](https://github.com/nullnull))
|
|
10
|
+
- Fix "ArgumentError: string contains null byte" on malformed stings [\#477](https://github.com/Apipie/apipie-rails/pull/477) ([avokhmin](https://github.com/avokhmin))
|
|
11
|
+
|
|
12
|
+
v0.5.14
|
|
13
|
+
-------
|
|
14
|
+
- HTML escape validator values [\#645](https://github.com/Apipie/apipie-rails/pull/645) ([ekohl](https://github.com/ekohl))
|
|
15
|
+
- Support for adding new params via `update\_api` [\#642](https://github.com/Apipie/apipie-rails/pull/642) ([iNecas](https://github.com/iNecas))
|
|
16
|
+
- Allow the "null" JSON string to be used as a parameter in Apipie spec examples \(`show\_in\_doc`\) [\#641](https://github.com/Apipie/apipie-rails/pull/641) ([enrique-guillen](https://github.com/enrique-guillen))
|
|
17
|
+
- Fix examples recording for specific cases [\#640](https://github.com/Apipie/apipie-rails/pull/640) ([Marri](https://github.com/Marri))
|
|
18
|
+
- Add description section to response [\#639](https://github.com/Apipie/apipie-rails/pull/639) ([X1ting](https://github.com/X1ting))
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
v0.5.13
|
|
22
|
+
-------
|
|
23
|
+
- Fix swagger generation if a controller's parent doesn't define a resource_description [\#637](https://github.com/Apipie/apipie-rails/pull/637) ([enrique-guillen](https://github.com/enrique-guillen))
|
|
24
|
+
|
|
25
|
+
v0.5.12
|
|
26
|
+
-------
|
|
27
|
+
- Fix returns displaying [\#635](https://github.com/Apipie/apipie-rails/pull/635) ([X1ting](https://github.com/X1ting))
|
|
28
|
+
|
|
29
|
+
v0.5.11
|
|
30
|
+
-------
|
|
31
|
+
|
|
32
|
+
- Adds swagger tags in swagger output [\#634](https://github.com/Apipie/apipie-rails/pull/634) ([enrique-guillen](https://github.com/enrique-guillen))
|
|
33
|
+
- Generate swagger with headers [\#630](https://github.com/Apipie/apipie-rails/pull/630) ([Uysim](https://github.com/Uysim))
|
|
34
|
+
- Fix examples not being generated for Rails < 5.0.0 [\#633](https://github.com/Apipie/apipie-rails/pull/633) ([RomanKapitonov](https://github.com/RomanKapitonov))
|
|
35
|
+
|
|
36
|
+
v0.5.10
|
|
37
|
+
------
|
|
38
|
+
|
|
39
|
+
- Support response validation [\#626](https://github.com/Apipie/apipie-rails/pull/626) ([COzero](https://github.com/COzero))
|
|
40
|
+
|
|
41
|
+
v0.5.9
|
|
42
|
+
------
|
|
43
|
+
|
|
44
|
+
- Support response validation [\#619](https://github.com/Apipie/apipie-rails/pull/619) ([abenari](https://github.com/abenari))
|
|
45
|
+
- Expect :number to have type 'numeric' [\#614](https://github.com/Apipie/apipie-rails/pull/614) ([akofink](https://github.com/akofink))
|
|
46
|
+
- New validator - DecimalValidator [\#431](https://github.com/Apipie/apipie-rails/pull/431) ([kiddrew](https://github.com/kiddrew))
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
v0.5.8
|
|
50
|
+
------
|
|
51
|
+
|
|
52
|
+
- Swagger json includes apipie's description as swagger's description [\#615](https://github.com/Apipie/apipie-rails/pull/615) ([gogotanaka](https://github.com/gogotanaka))
|
|
53
|
+
- Fix api! issue by using underscore when appending `controller` to the default controller string [\#613](https://github.com/Apipie/apipie-rails/pull/613) ([kevinmarx](https://github.com/kevinmarx))
|
|
54
|
+
- Possibility to compress examples [\#600](https://github.com/Apipie/apipie-rails/pull/600) ([Haniyya](https://github.com/Haniyya))
|
|
55
|
+
- Possibility to describe responses [\#588](https://github.com/Apipie/apipie-rails/pull/588) ([elasti-ron](https://github.com/elasti-ron))
|
|
56
|
+
|
|
57
|
+
v0.5.7
|
|
58
|
+
------
|
|
59
|
+
|
|
60
|
+
- Fix example recording with Rails 5 [\#607](https://github.com/Apipie/apipie-rails/pull/607) ([adamruzicka](https://github.com/adamruzicka))
|
|
61
|
+
- Use SHA1 instead of MD5 to enable using APIPIE at FIPS-enables systems [\#605](https://github.com/Apipie/apipie-rails/pull/605) ([iNecas](https://github.com/iNecas))
|
|
62
|
+
- Replaced String\#constantize with String\#safe\_constantize so apipie won't break on a missing constant [\#575](https://github.com/Apipie/apipie-rails/pull/575) ([Haniyya](https://github.com/Haniyya))
|
|
63
|
+
- Added Swagger generation [\#569](https://github.com/Apipie/apipie-rails/pull/569) ([elasti-ron](https://github.com/elasti-ron))
|
|
64
|
+
|
|
65
|
+
v0.5.6
|
|
66
|
+
------
|
|
67
|
+
|
|
68
|
+
- Prevent missing translation span in title [\#571](https://github.com/Apipie/apipie-rails/pull/571) ([mbacovsky](https://github.com/mbacovsky))
|
|
69
|
+
- Clean up old generator code for CLI [\#572](https://github.com/Apipie/apipie-rails/pull/572) ([voxik](https://github.com/voxik))
|
|
70
|
+
- Added french locale [\#568](https://github.com/Apipie/apipie-rails/pull/568) ([giglemad](https://github.com/giglemad))
|
|
71
|
+
|
|
72
|
+
v0.5.5
|
|
73
|
+
------
|
|
74
|
+
|
|
75
|
+
- prevent lang in url when config.translate is false [\#562](https://github.com/Apipie/apipie-rails/pull/562) ([markmoser](https://github.com/markmoser))
|
|
76
|
+
- Allow for resource-level deprecations [\#567](https://github.com/Apipie/apipie-rails/pull/567) ([cross-p6](https://github.com/cross-p6))
|
|
77
|
+
|
|
78
|
+
v0.5.4
|
|
79
|
+
------
|
|
80
|
+
|
|
81
|
+
- Constantize controller class before calling superclass [\#558](https://github.com/Apipie/apipie-rails/pull/558) ([ydkn](https://github.com/ydkn))
|
|
82
|
+
|
|
83
|
+
v0.5.3
|
|
84
|
+
------
|
|
85
|
+
|
|
86
|
+
- Fix reloading when extending the apidoc from concern [\#557](https://github.com/Apipie/apipie-rails/pull/557) ([iNecas](https://github.com/iNecas))
|
|
87
|
+
- Fix example recording when using send\_file [\#504](https://github.com/Apipie/apipie-rails/pull/504) ([tdeo](https://github.com/tdeo))
|
|
88
|
+
|
|
89
|
+
v0.5.2
|
|
90
|
+
------
|
|
91
|
+
|
|
92
|
+
- A way to extend an exiting API via concern [\#554](https://github.com/Apipie/apipie-rails/pull/554) ([iNecas](https://github.com/iNecas))
|
|
93
|
+
- Fallback to apipie views when application override isn't present [\#552](https://github.com/Apipie/apipie-rails/pull/552) ([tstrachota](https://github.com/tstrachota))
|
|
94
|
+
- Updated setting default locale for api documentation [\#543](https://github.com/Apipie/apipie-rails/pull/543) ([DmitryKK](https://github.com/DmitryKK))
|
|
95
|
+
|
|
96
|
+
v0.5.1
|
|
97
|
+
------
|
|
98
|
+
|
|
99
|
+
- Use AD::Reloader on Rails 4, app.reloader only on Rails 5+ [\#541](https://github.com/Apipie/apipie-rails/pull/541) ([domcleal](https://github.com/domcleal))
|
|
100
|
+
- Recognize Rack Symbols as Status Codes [\#468](https://github.com/Apipie/apipie-rails/pull/468)([alex-tan](https://github.com/alex-tan))
|
|
101
|
+
|
|
102
|
+
v0.5.0
|
|
103
|
+
------
|
|
104
|
+
|
|
105
|
+
- Fix Rails 5.1 deprecations [\#530](https://github.com/Apipie/apipie-rails/pull/530) ([@Onumis](https://github.com/Onumis) [@sedx](https://github.com/sedx))
|
|
106
|
+
- **This release is no longer compatible with Ruby 1.9.x**
|
|
107
|
+
- Do not mutate strings passed as config options, fixes \#461 [\#537](https://github.com/Apipie/apipie-rails/pull/537) ([samphilipd](https://github.com/samphilipd))
|
|
108
|
+
- Added recursion for documentation, fixed bug in examples with paperclip [\#531](https://github.com/Apipie/apipie-rails/pull/531) ([blddmnd](https://github.com/blddmnd))
|
|
109
|
+
- Added locales/ja.yml for Japanese [\#529](https://github.com/Apipie/apipie-rails/pull/529) ([kikuchi0808](https://github.com/kikuchi0808))
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
v0.4.0
|
|
113
|
+
------
|
|
114
|
+
|
|
115
|
+
- Rails 5 compatibility [\#527](https://github.com/Apipie/apipie-rails/pull/527) ([iNecas](https://github.com/iNecas)) [\#420](https://github.com/Apipie/apipie-rails/pull/420) ([buren](https://github.com/buren)) [\#473](https://github.com/Apipie/apipie-rails/pull/473)([domcleal](https://github.com/domcleal))
|
|
116
|
+
- **This release is no longer compatible with Rails 3.x**
|
|
117
|
+
- Include delete request parmeters in generated documentation [\#524](https://github.com/Apipie/apipie-rails/pull/524) ([johnnaegle](https://github.com/johnnaegle))
|
|
118
|
+
- Allow a blank, not just nil, base\_url. [\#521](https://github.com/Apipie/apipie-rails/pull/521) ([johnnaegle](https://github.com/johnnaegle))
|
|
119
|
+
- Adds allow\_blank option [\#508](https://github.com/Apipie/apipie-rails/pull/508) ([MrLeebo](https://github.com/MrLeebo))
|
|
120
|
+
- Boolean Validator uses \<code\> instead of ' [\#502](https://github.com/Apipie/apipie-rails/pull/502) ([berfarah](https://github.com/berfarah))
|
|
121
|
+
- Fix type validator message [\#501](https://github.com/Apipie/apipie-rails/pull/501) ([cindygu-itglue](https://github.com/cindygu-itglue))
|
|
122
|
+
- Add IT locale [\#496](https://github.com/Apipie/apipie-rails/pull/496) ([alepore](https://github.com/alepore))
|
|
123
|
+
- Fix small typo on dsl\_definition data init [\#494](https://github.com/Apipie/apipie-rails/pull/494) ([begault](https://github.com/begault))
|
|
124
|
+
- Localize app info message [\#491](https://github.com/Apipie/apipie-rails/pull/491) ([belousovAV](https://github.com/belousovAV))
|
|
125
|
+
- Fix travis build [\#489](https://github.com/Apipie/apipie-rails/pull/489) ([mtparet](https://github.com/mtparet))
|
|
126
|
+
- Handle blank data when parsing a example's response [\#453](https://github.com/Apipie/apipie-rails/pull/453) ([stbenjam](https://github.com/stbenjam))
|
|
127
|
+
- Allow layouts to be overridable. Fixes a regression introduced in \#425. [\#447](https://github.com/Apipie/apipie-rails/pull/447) ([nilsojes](https://github.com/nilsojes))
|
|
128
|
+
|
|
129
|
+
v0.3.7
|
|
130
|
+
------
|
|
131
|
+
|
|
132
|
+
- Handle blank data when parsing a example's response [\#453](https://github.com/Apipie/apipie-rails/pull/453) ([stbenjam](https://github.com/stbenjam))
|
|
133
|
+
- Allow layouts to be overridable. Fixes a regression introduced in \#425. [\#447](https://github.com/Apipie/apipie-rails/pull/447) ([nilseriksson](https://github.com/nilseriksson))
|
|
134
|
+
|
|
135
|
+
v0.3.6
|
|
136
|
+
------
|
|
137
|
+
|
|
138
|
+
- Fixed to\_json encoding error that occurs with uploaded file parameters. [\#429](https://github.com/Apipie/apipie-rails/pull/429) ([hossenlopp](https://github.com/hossenlopp))
|
|
139
|
+
- Render enum param values as CODE [\#426](https://github.com/Apipie/apipie-rails/pull/426) ([febeling](https://github.com/febeling))
|
|
140
|
+
- Fix layout path \(Rails 4.2.5.1 compatibility\) [\#425](https://github.com/Apipie/apipie-rails/pull/425) ([halilim](https://github.com/halilim))
|
|
141
|
+
- Unify indentations across all locale files [\#423](https://github.com/Apipie/apipie-rails/pull/423) ([springerigor](https://github.com/springerigor))
|
|
142
|
+
- Fix typo in Action Aware Params section of readme [\#419](https://github.com/Apipie/apipie-rails/pull/419) ([ryanlabouve](https://github.com/ryanlabouve))
|
|
143
|
+
- Rails4.2 [\#413](https://github.com/Apipie/apipie-rails/pull/413) ([ferdinandrosario](https://github.com/ferdinandrosario))
|
|
144
|
+
- Add viewport meta tag. [\#412](https://github.com/Apipie/apipie-rails/pull/412) ([buren](https://github.com/buren))
|
|
145
|
+
- removed beta version [\#411](https://github.com/Apipie/apipie-rails/pull/411) ([ferdinandrosario](https://github.com/ferdinandrosario))
|
|
146
|
+
- updated patch [\#410](https://github.com/Apipie/apipie-rails/pull/410) ([ferdinandrosario](https://github.com/ferdinandrosario))
|
|
147
|
+
- Nerian layout fix [\#409](https://github.com/Apipie/apipie-rails/pull/409) ([Pajk](https://github.com/Pajk))
|
|
148
|
+
- Add Turkish translations [\#407](https://github.com/Apipie/apipie-rails/pull/407) ([halilim](https://github.com/halilim))
|
|
149
|
+
- Update README.rst [\#405](https://github.com/Apipie/apipie-rails/pull/405) ([type-face](https://github.com/type-face))
|
|
150
|
+
- add german locale [\#394](https://github.com/Apipie/apipie-rails/pull/394) ([mjansing](https://github.com/mjansing))
|
|
151
|
+
- Add custom message support for missing parameters [\#390](https://github.com/Apipie/apipie-rails/pull/390) ([jcalvert](https://github.com/jcalvert))
|
|
152
|
+
- A boolean parameters can be configured with both :bool and :boolean [\#124](https://github.com/Apipie/apipie-rails/pull/124) ([Nerian](https://github.com/Nerian))
|
|
153
|
+
|
|
154
|
+
v0.3.5
|
|
155
|
+
------
|
|
156
|
+
|
|
157
|
+
* Cleaning up unreachable code
|
|
158
|
+
[#385](https://github.com/Apipie/apipie-rails/pull/385) [@voxik][]
|
|
159
|
+
* Russian translation
|
|
160
|
+
[#352](https://github.com/Apipie/apipie-rails/pull/352) [@Le6ow5k1][]
|
|
161
|
+
* Ability to hide controller methods from documentation
|
|
162
|
+
[#356](https://github.com/Apipie/apipie-rails/pull/356) [@davidcollie][]
|
|
163
|
+
* Use doc_path configuration in rake tasks
|
|
164
|
+
[#358](https://github.com/Apipie/apipie-rails/pull/358) [@saneshark][]
|
|
165
|
+
* Chinese translation
|
|
166
|
+
[#363](https://github.com/Apipie/apipie-rails/pull/363) [@debbbbie][]
|
|
167
|
+
* Polish translation
|
|
168
|
+
[#375](https://github.com/Apipie/apipie-rails/pull/375) [@dbackowski][]
|
|
169
|
+
* Spanish translation
|
|
170
|
+
[#376](https://github.com/Apipie/apipie-rails/pull/376) [@isseu][]
|
|
171
|
+
* Add an alternative to action aware required param
|
|
172
|
+
[#377](https://github.com/Apipie/apipie-rails/pull/377) [@mourad-ifeelgoods][]
|
|
173
|
+
|
|
174
|
+
v0.3.4
|
|
175
|
+
------
|
|
176
|
+
|
|
177
|
+
* Fixing occasional NoMethodError with ActionDispatch::Reloader
|
|
178
|
+
[#348](https://github.com/Apipie/apipie-rails/pull/348) [@saneshark][]
|
|
179
|
+
* Portuguese translation
|
|
180
|
+
[#344](https://github.com/Apipie/apipie-rails/pull/344) [@dadario][]
|
|
181
|
+
|
|
182
|
+
v0.3.3
|
|
183
|
+
------
|
|
184
|
+
|
|
185
|
+
* Support for describing headers
|
|
186
|
+
[#341](https://github.com/Apipie/apipie-rails/pull/341) [@iliabylich][]
|
|
187
|
+
|
|
188
|
+
v0.3.2
|
|
189
|
+
------
|
|
190
|
+
|
|
191
|
+
* PATCH support for examples recording
|
|
192
|
+
[#332](https://github.com/Apipie/apipie-rails/pull/332) [@akenger][]
|
|
193
|
+
* Recursively search for API controllers by default for new projects
|
|
194
|
+
[#333](https://github.com/Apipie/apipie-rails/pull/333) [@baweaver][]
|
|
195
|
+
* Handling recursive route definitions with `api!` keyword
|
|
196
|
+
[#338](https://github.com/Apipie/apipie-rails/pull/338) [@stormsilver][]
|
|
197
|
+
* Support for eager-loaded controllers
|
|
198
|
+
[#329](https://github.com/Apipie/apipie-rails/pull/329) [@mtparet][]
|
|
199
|
+
|
|
200
|
+
v0.3.1
|
|
201
|
+
------
|
|
202
|
+
|
|
203
|
+
* Support for ``api!`` keyword in concerns
|
|
204
|
+
[#322](https://github.com/Apipie/apipie-rails/pull/322) [@iNecas][]
|
|
205
|
+
* More explicit ordering of the static dispatcher middleware
|
|
206
|
+
[#315](https://github.com/Apipie/apipie-rails/pull/315) [@iNecas][]
|
|
207
|
+
|
|
208
|
+
v0.3.0
|
|
209
|
+
------
|
|
210
|
+
This should be a backward compatible release. However, the number of new
|
|
211
|
+
significant features deserves new minor version bump.
|
|
212
|
+
|
|
213
|
+
* Rubocop-blessed Ruby 1.9 syntax for generated DSL documentation
|
|
214
|
+
[#318](https://github.com/Apipie/apipie-rails/pull/318) [@burnettk][]
|
|
215
|
+
* load API paths from routes.rb
|
|
216
|
+
[#187](https://github.com/Apipie/apipie-rails/pull/187) [@mtparet][] [@iNecas][]
|
|
217
|
+
* ability to use before_filter instead of overriding the action method
|
|
218
|
+
for validation
|
|
219
|
+
[#306](https://github.com/Apipie/apipie-rails/pull/306) [@dprice-fiksu][]
|
|
220
|
+
* support multi-part data when recording from tests
|
|
221
|
+
[#310](https://github.com/Apipie/apipie-rails/pull/310) [@bradrf][]
|
|
222
|
+
* validate_keys option to raise exception when passing undocumented option
|
|
223
|
+
[#122](https://github.com/Apipie/apipie-rails/pull/122) [@dfharmon][]
|
|
224
|
+
* handle static page generation when the doc_base_url has multiple folders
|
|
225
|
+
[#300](https://github.com/Apipie/apipie-rails/pull/300) [@ryanische][]
|
|
226
|
+
* add ability to markup validator description
|
|
227
|
+
[#282](https://github.com/Apipie/apipie-rails/pull/282) [@exAspArk][]
|
|
228
|
+
* don't specify protocol in Disqus script tag src
|
|
229
|
+
[#285](https://github.com/Apipie/apipie-rails/pull/285) [@chrise86][]
|
|
230
|
+
* fix BooleanValidator to set expected_type as boolean
|
|
231
|
+
[#286](https://github.com/Apipie/apipie-rails/pull/286) [@dustin-rh][]
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
v0.2.6
|
|
235
|
+
------
|
|
236
|
+
|
|
237
|
+
* better handling on cases where resource/method is not found when cache is turned off
|
|
238
|
+
[#284](https://github.com/Apipie/apipie-rails/pull/284) [@iNecas][]
|
|
239
|
+
* fix disqus integration
|
|
240
|
+
[#281](https://github.com/Apipie/apipie-rails/pull/281) [@RajRoR][]
|
|
241
|
+
|
|
242
|
+
v0.2.5
|
|
243
|
+
------
|
|
244
|
+
|
|
245
|
+
* Name substitution for referenced param_group defined in a concern
|
|
246
|
+
[#280](https://github.com/Apipie/apipie-rails/pull/280) [@tstrachota][]
|
|
247
|
+
* expected_type 'array' for ArrayValidator
|
|
248
|
+
[#276](https://github.com/Apipie/apipie-rails/pull/276) [@dustint-rh][]
|
|
249
|
+
|
|
250
|
+
THE FURTHER SUPPORT FOR RUBY 1.8.7 WILL NOT BE ENSURED IN THE MASTER
|
|
251
|
+
AND THE `>= 0.3.0` RELAEASES. We discourage anyone to keep using ruby
|
|
252
|
+
1.8.7 for anything. If you're aware of the issues and still willing to
|
|
253
|
+
take the risk, we are willing to keep the v0.2.x releases based on the
|
|
254
|
+
v0.2.x branch. However, we will not actively develop or backport any
|
|
255
|
+
new features to this branch neither will we accept there features that
|
|
256
|
+
are not in the master branch.
|
|
257
|
+
|
|
258
|
+
v0.2.4
|
|
259
|
+
------
|
|
260
|
+
|
|
261
|
+
* fix ruby 1.8.7 compatibility
|
|
262
|
+
[#272](https://github.com/Apipie/apipie-rails/pull/272) [@domcleal][]
|
|
263
|
+
|
|
264
|
+
v0.2.3
|
|
265
|
+
------
|
|
266
|
+
|
|
267
|
+
* add an option to flag an api route as deprecated
|
|
268
|
+
[#268](https://github.com/Apipie/apipie-rails/pull/268) [@komidore64][]
|
|
269
|
+
* add ability to pass additional options to apipie route
|
|
270
|
+
[#269](https://github.com/Apipie/apipie-rails/pull/269) [@exAspArk][]
|
|
271
|
+
* enhanced array validator
|
|
272
|
+
[#259](https://github.com/Apipie/apipie-rails/pull/259) [@mourad-ifeelgoods][]
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
v0.2.2
|
|
276
|
+
------
|
|
277
|
+
|
|
278
|
+
* prevent rspec 3 from being used. It is not compatible.
|
|
279
|
+
[#255](https://github.com/Apipie/apipie-rails/pull/255) [@lsylvester][]
|
|
280
|
+
* fixed extractor root route (handle nil path)
|
|
281
|
+
[#257](https://github.com/Apipie/apipie-rails/pull/257) [@ctria][]
|
|
282
|
+
* reduced rails dependency to development only
|
|
283
|
+
[#266](https://github.com/Apipie/apipie-rails/pull/266) [@klobuczek][]
|
|
284
|
+
* add more options to apipie:cache to generate only parts of the
|
|
285
|
+
static pages
|
|
286
|
+
[#262](https://github.com/Apipie/apipie-rails/pull/262) [@mbacovsky][]
|
|
287
|
+
|
|
288
|
+
v0.2.1
|
|
289
|
+
------
|
|
290
|
+
|
|
291
|
+
* fix typo in the localization string
|
|
292
|
+
[#244](https://github.com/Apipie/apipie-rails/pull/244) [@alem0lars][]
|
|
293
|
+
* fix syntax errors in 404 page
|
|
294
|
+
[#246](https://github.com/Apipie/apipie-rails/pull/246) [@richardsondx][]
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
v0.2.0
|
|
298
|
+
------
|
|
299
|
+
|
|
300
|
+
This is not full backward compatible release, as the format of storing
|
|
301
|
+
examples changed from YAML to JSON: the default location is at
|
|
302
|
+
`doc/apipie_examples.json`. The migration should be as easy as
|
|
303
|
+
running:
|
|
304
|
+
|
|
305
|
+
```
|
|
306
|
+
rake apipie:convert_examples
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
Also please not Rails 3.0 support was deprecated and the compatibility
|
|
310
|
+
wont be tracked anymore in next releases.
|
|
311
|
+
|
|
312
|
+
* dump examples as json
|
|
313
|
+
[#125](https://github.com/Apipie/apipie-rails/pull/125) [@johanneswuerbach][]
|
|
314
|
+
* support for localized API documentation
|
|
315
|
+
[#232](https://github.com/Apipie/apipie-rails/pull/232) [@mbacovsky][]
|
|
316
|
+
* configuration option to always record examples
|
|
317
|
+
[#239](https://github.com/Apipie/apipie-rails/pull/239) [@arathunku][]
|
|
318
|
+
* deprecate Rails 3.0
|
|
319
|
+
[#241](https://github.com/Apipie/apipie-rails/pull/241) [@iNecas][]
|
|
320
|
+
|
|
321
|
+
v0.1.3
|
|
322
|
+
------
|
|
323
|
+
|
|
324
|
+
* nested attributes showing in the documentation
|
|
325
|
+
[#230](https://github.com/Apipie/apipie-rails/pull/230) [@iNecas][]
|
|
326
|
+
|
|
327
|
+
v0.1.2
|
|
328
|
+
------
|
|
329
|
+
|
|
330
|
+
* reloading works correctly with to_prepare blocks in the app
|
|
331
|
+
[#228](https://github.com/Apipie/apipie-rails/pull/228) [@iNecas][]
|
|
332
|
+
* documentation bootstrapping now respects api_controllers_matcher
|
|
333
|
+
[#227](https://github.com/Apipie/apipie-rails/pull/227) [@clamoris][]
|
|
334
|
+
|
|
335
|
+
v0.1.1
|
|
336
|
+
------
|
|
337
|
+
|
|
338
|
+
* backward compatibility with Ruby 1.8 [#218](https://github.com/Apipie/apipie-rails/pull/218) [@mbacovsky][]
|
|
339
|
+
* checksum calculation is lazy and respect use_cache config [#220](https://github.com/Apipie/apipie-rails/pull/220) [@mbacovsky][]
|
|
340
|
+
* fix generating the cache in production environment [#223](https://github.com/Apipie/apipie-rails/pull/223) [@iNecas][]
|
|
341
|
+
* fix loading regression with SafeYAML [#224](https://github.com/Apipie/apipie-rails/pull/224) [@iNecas][]
|
|
342
|
+
|
|
343
|
+
v0.1.0
|
|
344
|
+
------
|
|
345
|
+
|
|
346
|
+
* middleware for computing Apipie checksum for [dynamic bindings](https://github.com/Apipie/apipie-bindings) [#215](https://github.com/Apipie/apipie-rails/pull/215) [@mbacovsky][]
|
|
347
|
+
* `api_base_url` inherited properly [#214](https://github.com/Apipie/apipie-rails/pull/214) [@mbacovsky][]
|
|
348
|
+
* ability to hide specific parameters [#208](https://github.com/Apipie/apipie-rails/pull/208) [@nathanhoel][]
|
|
349
|
+
* fix for SafeYAML compatibility [#207](https://github.com/Apipie/apipie-rails/pull/207) [@pivotalshiny][]
|
|
350
|
+
* option to show all examples in the documentation [#203](https://github.com/Apipie/apipie-rails/pull/203) [@pivotalshiny][]
|
|
351
|
+
* support for array of hashes validation [#189](https://github.com/Apipie/apipie-rails/pull/189) [@mtparet][]
|
|
352
|
+
* support for saving the values based on documentation into `@api_params` variable [#188](https://github.com/Apipie/apipie-rails/pull/188) [@mtparet][]
|
|
353
|
+
* support for json generated from rake task `rake apipie:static_json` [#186](https://github.com/Apipie/apipie-rails/pull/186) [@mtparet][]
|
|
354
|
+
* fix `undefined method 'has_key?' for nil:NilClass` when validating Hash against non-hash value [#185](https://github.com/Apipie/apipie-rails/pull/185) [@mtparet][]
|
|
355
|
+
* fix NoMethorError when validating Hash against non-hash value [#183](https://github.com/Apipie/apipie-rails/pull/183) [@nathanhoel][]
|
|
356
|
+
* support for metadata for params [#181](https://github.com/Apipie/apipie-rails/pull/181) [@tstrachota][]
|
|
357
|
+
* fix camelization of class names [#170](https://github.com/Apipie/apipie-rails/pull/170) [@yonpols][]
|
|
358
|
+
* new array class validator [#169](https://github.com/Apipie/apipie-rails/pull/169) [@mkrajewski][]
|
|
359
|
+
|
|
360
|
+
v0.0.24
|
|
361
|
+
-------
|
|
362
|
+
|
|
363
|
+
* fix DOS vulnerability for running in production without use_cache
|
|
364
|
+
* ability to load descriptions from external files
|
|
365
|
+
* improved examples extractor
|
|
366
|
+
* fixed deprecation warnings in Rails 4
|
|
367
|
+
* using StandardError instead of Exception for errors
|
|
368
|
+
|
|
369
|
+
v0.0.23
|
|
370
|
+
-------
|
|
371
|
+
|
|
372
|
+
* fix exceptions on unknown validator
|
|
373
|
+
* fix concerns substitution in parameters
|
|
374
|
+
* possibility to authenticate the API doc
|
|
375
|
+
* support for array in api_controllers_matcher
|
|
376
|
+
|
|
377
|
+
v0.0.22
|
|
378
|
+
-------
|
|
379
|
+
|
|
380
|
+
* fix "named_resources" option
|
|
381
|
+
* fix generating static files when concerns used
|
|
382
|
+
|
|
383
|
+
v0.0.21
|
|
384
|
+
-------
|
|
385
|
+
|
|
386
|
+
* fix RDoc 4.0 compatibility issue
|
|
387
|
+
* ``validate_value`` and ``validate_presence`` options for better
|
|
388
|
+
validation granularity
|
|
389
|
+
|
|
390
|
+
v0.0.20
|
|
391
|
+
-------
|
|
392
|
+
|
|
393
|
+
* namespaced resources - prevent collisions when one resource defined
|
|
394
|
+
in more modules
|
|
395
|
+
* ``Apipie::DSL::Concern`` for being able to use the DSL in module
|
|
396
|
+
that is included into controllers
|
|
397
|
+
|
|
398
|
+
v0.0.19
|
|
399
|
+
-------
|
|
400
|
+
|
|
401
|
+
* fix examples recording when resource_id is set
|
|
402
|
+
* use safe_yaml for loading examples file when available
|
|
403
|
+
|
|
404
|
+
v0.0.18
|
|
405
|
+
-------
|
|
406
|
+
|
|
407
|
+
* ``param_group`` and ``def_param_group`` keywords
|
|
408
|
+
* ``:action_aware`` options for reusing param groups for create/update actions
|
|
409
|
+
|
|
410
|
+
v0.0.17
|
|
411
|
+
-------
|
|
412
|
+
|
|
413
|
+
* support for multiple see links at action and ability to provide
|
|
414
|
+
description of see links
|
|
415
|
+
|
|
416
|
+
v0.0.16
|
|
417
|
+
-------
|
|
418
|
+
|
|
419
|
+
* Fix getting started being rendered even when documentation was available
|
|
420
|
+
|
|
421
|
+
v0.0.15
|
|
422
|
+
-------
|
|
423
|
+
|
|
424
|
+
* Fix case when there is no documentation yet: with link to how to
|
|
425
|
+
start
|
|
426
|
+
* Fix handling bad requests when cache is on
|
|
427
|
+
* Fix params extractor in case there is already some documentation
|
|
428
|
+
|
|
429
|
+
[@mbacovsky]: https://github.com/mbacovsky
|
|
430
|
+
[@tstrachota]: https://github.com/tstrachota
|
|
431
|
+
[@nathanhoel]: https://github.com/nathanhoel
|
|
432
|
+
[@pivotalshiny]: https://github.com/pivotalshiny
|
|
433
|
+
[@mtparet]: https://github.com/mtparet
|
|
434
|
+
[@yonpols]: https://github.com/yonpols
|
|
435
|
+
[@mkrajewski]: https://github.com/mkrajewski
|
|
436
|
+
[@iNecas]: https://github.com/iNecas
|
|
437
|
+
[@clamoris]: https://github.com/clamoris
|
|
438
|
+
[@arathunku]: https://github.com/arathunku
|
|
439
|
+
[@johanneswuerbach]: https://github.com/johanneswuerbach
|
|
440
|
+
[@richardsondx]: https://github.com/richardsondx
|
|
441
|
+
[@alem0lars]: https://github.com/alem0lars
|
|
442
|
+
[@lsylvester]: https://github.com/lsylverster
|
|
443
|
+
[@ctria]: https://github.com/ctria
|
|
444
|
+
[@klobuczek]: https://github.com/klobuczek
|
|
445
|
+
[@komidore64]: https://github.com/komidore64
|
|
446
|
+
[@exAspArk]: https://github.com/exAspArk
|
|
447
|
+
[@mourad-ifeelgoods]: https://github.com/mourad-ifeelgoods
|
|
448
|
+
[@domcleal]: https://github.com/domcleal
|
|
449
|
+
[@dustin-rh]: https://github.com/dustin-rh
|
|
450
|
+
[@RajRoR]: https://github.com/RajRoR
|
|
451
|
+
[@chrise86]: https://github.com/chrise86
|
|
452
|
+
[@ryanische]: https://github.com/ryanische
|
|
453
|
+
[@dfharmon]: https://github.com/dfharmon
|
|
454
|
+
[@bradrf]: https://github.com/bradrf
|
|
455
|
+
[@dprice-fiksu]: https://github.com/dprice-fiksu
|
|
456
|
+
[@burnettk]: https://github.com/burnettk
|
|
457
|
+
[@akenger]: https://github.com/akenger
|
|
458
|
+
[@baweaver]: https://github.com/baweaver
|
|
459
|
+
[@stormsilver]: https://github.com/stormsilver
|
|
460
|
+
[@iliabylich]: https://github.com/iliabylich
|
|
461
|
+
[@dadario]: https://github.com/dadario
|
|
462
|
+
[@saneshark]: https://github.com/saneshark
|
|
463
|
+
[@voxik]: https://github.com/voxik
|
|
464
|
+
[@Le6ow5k1]: https://github.com/Le6ow5k1
|
|
465
|
+
[@davidcollie]: https://github.com/davidcollie
|
|
466
|
+
[@saneshark]: https://github.com/saneshark
|
|
467
|
+
[@debbbbie]: https://github.com/debbbbie
|
|
468
|
+
[@dbackowski]: https://github.com/dbackowski
|
|
469
|
+
[@isseu]: https://github.com/isseu
|