From 97902c46353513281f9bfb83b1147963d05651bf Mon Sep 17 00:00:00 2001 From: Sabela Date: Fri, 28 Sep 2018 14:53:05 +0200 Subject: [PATCH 1/2] Update Contributing.md to reflect OpenAPI conventions (issue #7). --- CONTRIBUTING.md | 34 +--------------------------------- 1 file changed, 1 insertion(+), 33 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 67744e6..d24631a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,39 +40,7 @@ The project will strive for full consensus on everything until it runs into a pr ## Syntax Style and Conventions -The current code conventions for the source files are as follows: - -- Use two-space indentation, and no tabs. -- Hard-wrap code to 80 characters per line. -- Use `UpperCamelCase` for object or record names. -- Use `lowerCamelCase` for attribute or method names. -- Use `CONSTANT_CASE` for global and constant values. -- Comments: - - Comments should be indented at the same level as the surrounding code. - - Comments should precede the code that they make a comment on. Documentation comments will not work otherwise. - - Documentation comments, which are intended to be processed by avrodoc and displayed in the user-facing API documentation, must use the `/** ... */` style, and must not have a leading `*` on each internal line: - - /** - This documentation comment will be - processed correctly by avrodoc. - */ - - /** - * This documentation comment will have a - * bullet point at the start of every line - * when processed by avrodoc. - */ - - - Block and multi-line non-documentation comments, intended for schema developers only, must use the `/* ... */` style. - - /* - This multi-line comment will not appear in the - avrodoc documentation and is intended for - schema developers. - */ - - - All multi-line comments should have the comment text at the same indent level as the comment delimeters. - - One-line non-documentation comments, intended for schema developers only, must use the `// ...` style. +The code should conform to the [OpenAPI specification](https://github.com/OAI/OpenAPI-Specification/tree/master/versions). ## Gitflow Workflow From 874f7efc5f7608a8db4d9444086b8d4502e5258e Mon Sep 17 00:00:00 2001 From: Sabela Date: Fri, 28 Sep 2018 14:54:04 +0200 Subject: [PATCH 2/2] Fix missing branch in swagger-api repo. Use tag instead --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 5054f73..27e36d6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,7 +9,7 @@ before_install: # This setup will not be needed once the online version of validator-badge supports OAS 3.0. Until then we'll need to set up a local version. Since there isn't a release supporting OAS 3.0 yet, we unfortunately need to build some snapshot dependencies. These steps should be gradually removed as releases come out. # build swagger-core - - git clone --branch=2.0 https://github.com/swagger-api/swagger-core.git + - git clone --branch=v2.0.2 https://github.com/swagger-api/swagger-core.git - cd swagger-core - git reset --hard 5336adb9945cfdf6eddbb61f15b28a1509e0b267 - mvn install -DskipTests=true -Dmaven.javadoc.skip=true -B -V