Skip to content
This repository has been archived by the owner on Jan 21, 2020. It is now read-only.

Commit

Permalink
Merging develop to master in preparation for 1.3.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
weierophinney committed May 7, 2018
2 parents 3cce5a3 + a3494e9 commit 9994e43
Show file tree
Hide file tree
Showing 97 changed files with 40,796 additions and 9,861 deletions.
2 changes: 2 additions & 0 deletions .coveralls.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
coverage_clover: clover.xml
json_path: coveralls-upload.json
15 changes: 9 additions & 6 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
/test export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.travis.yml export-ignore
phpcs.xml export-ignore
phpunit.xml.dist export-ignore
/.coveralls.yml export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/composer.lock export-ignore
/docs/ export-ignore
/phpcs.xml export-ignore
/phpunit.xml.dist export-ignore
/test/ export-ignore
9 changes: 6 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
vendor/
.idea/
phpunit.xml
/.idea/
/clover.xml
/coveralls-upload.json
/nbproject/
/phpunit.xml
/vendor/
46 changes: 29 additions & 17 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ language: php
cache:
directories:
- $HOME/.composer/cache
- vendor

env:
global:
- COMPOSER_ARGS="--no-interaction --ignore-platform-reqs"
- COMPOSER_ARGS="--no-interaction"
- COVERAGE_DEPS="php-coveralls/php-coveralls"

matrix:
fast_finish: true
include:
- php: 5.6
env:
- DEPS=lowest
- php: 5.6
env:
- DEPS=locked
- LEGACY_DEPS="phpunit/phpunit"
- php: 5.6
env:
- DEPS=latest
Expand All @@ -29,36 +29,48 @@ matrix:
- php: 7
env:
- DEPS=locked
- CS_CHECK=true
- LEGACY_DEPS="phpunit/phpunit"
- php: 7
env:
- DEPS=latest
- php: hhvm
- php: 7.1
env:
- DEPS=lowest
- php: hhvm
- php: 7.1
env:
- DEPS=locked
- php: hhvm
- CS_CHECK=true
- TEST_COVERAGE=true
- php: 7.1
env:
- DEPS=latest
- php: 7.2
env:
- DEPS=lowest
- php: 7.2
env:
- DEPS=locked
- php: 7.2
env:
- DEPS=latest
allow_failures:
- php: hhvm

notifications:
irc: "irc.freenode.org#apigility-dev"
email: false

before_install:
- if [[ $TEST_COVERAGE != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi
- travis_retry composer self-update

install:
- travis_retry composer install $COMPOSER_ARGS --ignore-platform-reqs
- if [[ $LEGACY_DEPS != '' ]]; then travis_retry composer update $COMPOSER_ARGS --with-dependencies $LEGACY_DEPS ; fi
- if [[ $DEPS == 'latest' ]]; then travis_retry composer update $COMPOSER_ARGS ; fi
- if [[ $DEPS == 'lowest' ]]; then travis_retry composer update --prefer-lowest --prefer-stable $COMPOSER_ARGS ; fi
- travis_retry composer install $COMPOSER_ARGS
- composer show
- if [[ $TEST_COVERAGE == 'true' ]]; then travis_retry composer require --dev $COMPOSER_ARGS $COVERAGE_DEPS ; fi
- stty cols 120 && composer show

script:
- composer test
- if [[ $TEST_COVERAGE == 'true' ]]; then composer test-coverage ; else composer test ; fi
- if [[ $CS_CHECK == 'true' ]]; then composer cs-check ; fi

after_script:
- if [[ $TEST_COVERAGE == 'true' ]]; then travis_retry php vendor/bin/php-coveralls -v ; fi

notifications:
email: false
17 changes: 13 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,39 @@

All notable changes to this project will be documented in this file, in reverse chronological order by release.

## 1.2.2 - TBD
## 1.3.0 - 2018-05-07

### Added

- Nothing.
- [#34](https://github.com/zfcampus/zf-apigility-documentation-swagger/pull/34) adds support for PHP 7.1 and 7.2.

### Changed

- [#28](https://github.com/zfcampus/zf-apigility-documentation-swagger/pull/28) updates the component to generate Swagger 2.2.6 / OpenAPI 2.0 documentation (instead of Swagger 1.3).

### Deprecated

- Nothing.

### Removed

- Nothing.
- [#34](https://github.com/zfcampus/zf-apigility-documentation-swagger/pull/34) removes support for HHVM.

### Fixed

- Nothing.
- [#29](https://github.com/zfcampus/zf-apigility-documentation-swagger/pull/29) fixes an issue that occurs when a field definition in an input filter
is not a `Field` instance; these are now skipped when generating field documentation.

## 1.2.1 - 2016-10-11

### Added

- Nothing.

### Changed

- Nothing.

### Deprecated

- Nothing.
Expand Down
80 changes: 0 additions & 80 deletions CONTRIBUTING.md

This file was deleted.

13 changes: 6 additions & 7 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
Copyright (c) 2014-2016, Zend Technologies USA, Inc.

Copyright (c) 2014-2018, Zend Technologies USA, Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
- Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

- Neither the name of Zend Technologies USA, Inc. nor the names of its
contributors may be used to endorse or promote products derived from this
Expand Down
27 changes: 10 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
Swagger Documentation Provider for Apigility
============================================
# Swagger Documentation Provider for Apigility

[![Build Status](https://travis-ci.org/zfcampus/zf-apigility-documentation-swagger.png)](https://travis-ci.org/zfcampus/zf-apigility-documentation-swagger)
[![Build Status](https://secure.travis-ci.org/zfcampus/zf-apigility-documentation-swagger.svg?branch=master)](https://secure.travis-ci.org/zfcampus/zf-apigility-documentation-swagger)
[![Coverage Status](https://coveralls.io/repos/github/zfcampus/zf-apigility-documentation-swagger/badge.svg?branch=master)](https://coveralls.io/github/zfcampus/zf-apigility-documentation-swagger?branch=master)

Introduction
------------
## Introduction

This module provides Apigility the ability to show API documentation through a
[Swagger UI](http://swagger.io/).
Expand All @@ -17,13 +16,11 @@ payload in the `application/vnd.swagger+json` media type; this resource is what
UI. You can access this representation by passing the media type `application/vnd.swagger+json` for
the `Accept` header via the path `/apigility/documentation/:module/:service`.

Requirements
------------
## Requirements

Please see the [composer.json](composer.json) file.

Installation
------------
## Installation

Run the following `composer` command:

Expand Down Expand Up @@ -60,8 +57,7 @@ return [
> If you use [zf-component-installer](https://github.com/zendframework/zf-component-installer),
> that plugin will install zf-apigility-documentation-swagger as a module for you.
Routes
------
## Routes

### /apigility/swagger

Expand All @@ -72,8 +68,7 @@ Shows the Swagger UI JavaScript application.
Various CSS, images, and JavaScript libraries required to deliver the Swagger UI client
application.

Configuration
-------------
## Configuration

### System Configuration

Expand Down Expand Up @@ -159,8 +154,7 @@ return [
];
```

ZF2 Events
----------
## ZF Events

### Listeners

Expand All @@ -171,8 +165,7 @@ to conditionally attach a view strategy to the view system in cases where the co
a `ZF\Apigility\Documentation\Swagger\ViewModel` view model (likely selected as the
content-negotiated view model based off of `Accept` media types).

ZF2 Services
------------
## ZF Services

### View Models

Expand Down
8 changes: 0 additions & 8 deletions asset/zf-apigility-documentation-swagger/css/custom.css

This file was deleted.

Loading

0 comments on commit 9994e43

Please sign in to comment.