Skip to content
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.

Commit

Permalink
Merge pull request #195 from apiaryio/opichals/update-docs-apiary-io-…
Browse files Browse the repository at this point in the history
…domains

docs: update domains to *.docs.apiary.io
  • Loading branch information
Ladislav Prskavec authored Feb 24, 2021
2 parents 8bae559 + 8c1b592 commit f544580
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 13 deletions.
5 changes: 5 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ workflows:
- test-2.5
- test-2.6
- test-2.7
- test-3.0
jobs:
test-2.4: &test-template
docker:
Expand Down Expand Up @@ -45,3 +46,7 @@ jobs:
<<: *test-template
docker:
- image: circleci/ruby:2.7-browsers
test-3.0:
<<: *test-template
docker:
- image: circleci/ruby:3.0-browsers
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
strategy:
matrix:
os: ["windows-latest", "ubuntu-latest"]
ruby: ["2.7.x", "2.6.x", "2.5.x", "2.4.x"]
ruby: ["3.0.x", "2.7.x", "2.6.x", "2.5.x"]
steps:
- uses: actions/checkout@v2
- name: Set up Ruby
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ export APIARY_API_KEY=<your_token>
```
$ apiary help
Commands:
apiary fetch --api-name=API_NAME # Fetch API Description Document from API_NAME.apiary.io
apiary fetch --api-name=API_NAME # Fetch API Description Document from API_NAME.docs.apiary.io
apiary help [COMMAND] # Describe available commands or one specific command
apiary preview # Show API documentation in browser or write it to file
apiary publish --api-name=API_NAME # Publish API Description Document on docs.API_NAME.apiary.io (API Description must exist on apiary.io)
apiary publish --api-name=API_NAME # Publish API Description Document on API_NAME.docs.apiary.io (API Description must exist on apiary.io)
apiary styleguide # Check API Description Document against styleguide rules (Apiary.io pro plan is required - https://apiary.io/plans )
apiary version # Show version
Expand All @@ -79,7 +79,7 @@ Options:
--api-name=API_NAME
[--output=FILE] # Write API Description Document into specified file
Fetch API Description Document from API_NAME.apiary.io
Fetch API Description Document from API_NAME.docs.apiary.io
```

#### preview
Expand Down Expand Up @@ -117,7 +117,7 @@ Options:
# Default: true
--api-name=API_NAME
Publish API Description Document on docs.API_NAME.apiary.io (API Description must exist on apiary.io)
Publish API Description Document on API_NAME.docs.apiary.io (API Description must exist on apiary.io)
```

#### styleguide
Expand Down
4 changes: 2 additions & 2 deletions features/publish.feature
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Feature: Publish apiary.apib on docs.API_NAME.apiary.io
Feature: Publish apiary.apib on API_NAME.docs.apiary.io

# This is integration testing you have to set APIARY_API_KEY
@needs_apiary_api_key
Scenario: Publish apiary.apib on docs.API_NAME.apiary.io
Scenario: Publish apiary.apib on API_NAME.docs.apiary.io

# expected to fail
When I run `apiary publish --path=apiary.apib --api-name 1111apiaryclienttest`
Expand Down
2 changes: 1 addition & 1 deletion features/styleguide.feature
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Feature: Styleguide apiary.apib on docs.API_NAME.apiary.io
Feature: Styleguide apiary.apib on API_NAME.docs.apiary.io

# This is integration testing you have to set APIARY_API_KEY
@needs_apiary_api_key
Expand Down
4 changes: 2 additions & 2 deletions lib/apiary/cli.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

module Apiary
class CLI < Thor
desc 'fetch', 'Fetch API Description Document from API_NAME.apiary.io'
desc 'fetch', 'Fetch API Description Document from API_NAME.docs.apiary.io'
method_option :api_name, type: :string, required: true
method_option :api_host, type: :string, banner: 'HOST', desc: 'Specify apiary host', hide: true
method_option :output, type: :string, banner: 'FILE', desc: 'Write API Description Document into specified file'
Expand All @@ -34,7 +34,7 @@ def preview
cmd.execute
end

desc 'publish', 'Publish API Description Document on docs.API_NAME.apiary.io (API Description must exist on apiary.io)'
desc 'publish', 'Publish API Description Document on API_NAME.docs.apiary.io (API Description must exist on apiary.io)'
method_option :message, type: :string, banner: 'COMMIT_MESSAGE', desc: 'Publish with custom commit message'
method_option :path, type: :string, desc: 'Specify path to API Description Document. When given a directory, it will look for `apiary.apib` and `swagger.yaml` file'
method_option :json, type: :boolean, desc: 'Specify that Swagger API Description Document is in json format. Document will be converted to yaml before processing'
Expand Down
2 changes: 1 addition & 1 deletion lib/apiary/command/fetch.rb
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ def execute

def fetch_from_apiary
unless @options.api_name
abort 'Please provide an api-name option (subdomain part from your http://docs.<api-name>.apiary.io/)'
abort 'Please provide an api-name option (subdomain part from your https://<api-name>.docs.apiary.io/)'
end

unless @options.api_key
Expand Down
2 changes: 1 addition & 1 deletion lib/apiary/command/publish.rb
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def execute

def publish_on_apiary
unless @options.api_name
abort 'Please provide an api-name option (subdomain part from your http://docs.<api-name>.apiary.io/)'
abort 'Please provide an api-name option (subdomain part from your https://<api-name>.docs.apiary.io/)'
end

unless @options.api_key
Expand Down
2 changes: 1 addition & 1 deletion spec/apiary/command/fetch_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
it 'pass command without params' do
opts = {}
command = Apiary::Command::Fetch.new(opts)
expect { command.fetch_from_apiary }.to raise_error('Please provide an api-name option (subdomain part from your http://docs.<api-name>.apiary.io/)')
expect { command.fetch_from_apiary }.to raise_error('Please provide an api-name option (subdomain part from your https://<api-name>.docs.apiary.io/)')
end

it 'pass command only with api_name', api_key: true do
Expand Down

0 comments on commit f544580

Please sign in to comment.