Skip to content

Commit 946feae

Browse files
committed
Complete switch to ApiDocServer 1.0
1 parent 93aae17 commit 946feae

File tree

4 files changed

+22
-52
lines changed

4 files changed

+22
-52
lines changed

CHANGELOG.md

+8-37
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,11 @@
22

33
## master
44

5-
## 1.0.2
6-
7-
* Fix translation loading error
8-
9-
## 1.0.1
10-
11-
* Support OAuth2 authentication
12-
* Support loading Swagger UI translations
13-
* Add return link for multiple API versions
14-
* Add `de` translation
15-
* Refactor helpers
16-
17-
## 1.0.0
18-
19-
* Rails 5 dependency. It is compatible with previous versions.
20-
* Support API versioning/multiple APIs definitions
21-
* Add basic HTTP auth support
22-
* Add `validator_enabled` configurable option
23-
* Refactor Configuration class definition
24-
* Refactor controllers
25-
* Redefine gem summary and description
26-
27-
## 0.0.5
28-
29-
* Support Swagger UI version 2.2.10
30-
* Add tests
31-
* Fix fonts not being loaded
32-
* Describe problem solved by this gem in README
33-
34-
## 0.0.4
35-
36-
* Improve configurable options
37-
* Fix assets errors
38-
39-
## 0.0.1-0.0.3
40-
41-
Initial releases supporting Swagger UI version 2.2.8
5+
## 1.0
6+
7+
- Use ReDoc (not SwaggerUI)
8+
- Doc how to update
9+
- Add rubocop
10+
- Run tests in random order
11+
- Support Rails 4.2
12+
- Rename SwaggeUiEngine to ApiDocServer

api_doc_server.gemspec

+12-13
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,21 @@ require 'api_doc_server/version'
55
Gem::Specification.new do |s|
66
s.name = 'api_doc_server'
77
s.version = ApiDocServer::VERSION
8-
s.authors = ['ZuzannaSt', '[email protected]']
9-
s.email = ['zuzannast@gmail.com']
10-
s.homepage = 'https://github.com/swipesense/api_doc_server'
11-
s.summary = 'Mountable Rails engine that serves Swagger UI for your API documentation written in YAML files.'
12-
s.description = 'Mount Swagger UI web console as Rails engine, configure it as you want and write your API documentation in simple YAML files.'
8+
s.authors = ['Benjamin Fleischer']
9+
s.email = ['github@benjaminfleischer.com']
10+
s.homepage = 'https://github.com/bf4/api_doc_server'
11+
s.summary = 'Mountable Rails engine that serves API Docs for your Swagger/OpenAPI docs.'
12+
s.description = s.summary
1313
s.license = 'MIT'
1414

15-
s.files = Dir[
16-
'{app,config,db,lib}/**/*',
17-
'MIT-LICENSE',
18-
'Rakefile',
19-
'README.rdoc',
20-
'CHANGELOG.md'
21-
]
15+
s.files = `git ls-files -z`.split("\x0")
16+
s.test_files = s.files.grep(%r{^(test|spec|features)/})
17+
s.require_paths = ['lib']
18+
s.executables = []
2219

23-
s.add_runtime_dependency 'rails', ['>= 4.2', '<= 5.2.0']
20+
s.required_ruby_version = '>= 2.1'
21+
22+
s.add_runtime_dependency 'rails', ['>= 4.2', '< 6']
2423

2524
s.add_development_dependency 'rubocop'
2625
end

lib/api_doc_server/version.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# frozen_string_literal: true
22

33
module ApiDocServer
4-
VERSION = '2.0.0' unless const_defined?(:VERSION)
4+
VERSION = '1.0.0' unless const_defined?(:VERSION)
55
def self.version
66
VERSION
77
end

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "api_doc_server",
33
"private": true,
4-
"repository": "[email protected]:swipesense/api_doc_server.git",
4+
"repository": "[email protected]:bf4/api_doc_server.git",
55
"license": "",
66
"dependencies": {
77
"redoc": "1.16.1"

0 commit comments

Comments
 (0)