Skip to content

Commit

Permalink
Merge pull request #1646 from folio-org/no-quotes-py-parameters
Browse files Browse the repository at this point in the history
Don't quote parameters of api_doc.py/api_lint.py
  • Loading branch information
dcrossleyau committed Apr 15, 2024
2 parents ed7f3e1 + dde4b3b commit 0dd0eae
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion guides/api-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ The Python script will search the configured directories to find relevant API de
By default it excludes certain well-known directories (such as `raml-util examples headers parameters`).
Use the option `--loglevel debug` to report what is being excluded.

Don't quote a space-separated list. Correct: `-e examples headers`. Wrong: `-e "examples headers"`. Wrong: `"-e examples headers"`.

See help for the full list (including the default output directory):

```
Expand All @@ -59,7 +61,7 @@ cd $GH_FOLIO/mod-eusage-reports
python3 ../folio-tools/api-doc/api_doc.py \
-t OAS \
-d src/main/resources/openapi \
-e headers
-e examples headers
```

Example for both RAML and OpenAPI (OAS), i.e. when preparing for transition:
Expand Down
4 changes: 3 additions & 1 deletion guides/api-lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ The Python script will search the configured directories to find relevant API de
* `-w,--warnings` -- Cause "warnings" to fail the workflow, in the absence of "violations".
Optional. By default, if there are no "violations", then the workflow is successful and so any "warnings" would not be displayed.

Don't quote a space-separated list. Correct: `-e examples headers`. Wrong: `-e "examples headers"`. Wrong: `"-e examples headers"`.

See help for the full list:

```
Expand All @@ -70,7 +72,7 @@ cd $GH_FOLIO/mod-eusage-reports
python3 ../folio-tools/api-lint/api_lint.py \
-t OAS \
-d src/main/resources/openapi \
-e headers
-e examples headers
```

Example for both RAML and OpenAPI (OAS), i.e. when preparing for transition:
Expand Down

0 comments on commit 0dd0eae

Please sign in to comment.