Skip to content

Commit 3b74741

Browse files
committed
fix more linters
1 parent 88437f4 commit 3b74741

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

openapi/openapi/paths/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,22 @@ You can adopt any organization you wish. We have some tips for organizing paths
1616

1717
Use a predefined "path separator" and keep all of your path files in the top level of the `paths` folder.
1818

19-
```
19+
```yaml
2020
# todo: insert tree view of paths folder
2121
```
2222

2323
Redocly recommends using the `@` character for this case.
2424

2525
In addition, Redocly recommends placing path parameters within `{}` curly braces if you adopt this style.
2626

27-
#### Motivations
27+
### Motivations
2828

2929
* Quickly see a list of all paths. Many people think in terms of the "number" of "endpoints" (paths), and not the "number" of "operations" (paths * http methods).
3030

3131
* Only the "file-per-path" option is semantically correct with the OpenAPI Specification 3.0.2. However, Redocly's openapi-cli will build valid bundles for any of the other options too.
3232

3333

34-
#### Drawbacks
34+
### Drawbacks
3535

3636
* This may require multiple definitions per http method within a single file.
3737
* It requires settling on a path separator (that is allowed to be used in filenames) and sticking to that convention.
@@ -57,7 +57,8 @@ You may name your files with some concatenation for the http method. For example
5757
### Use subfolders to mirror API path structure
5858

5959
Example:
60-
```
60+
61+
```http request
6162
GET /customers
6263
6364
/paths/customers/get.yaml
@@ -66,7 +67,8 @@ GET /customers
6667
In this case, the path id defined within subfolders which mirror the API URL structure.
6768

6869
Example with path parameter:
69-
```
70+
71+
```http request
7072
GET /customers/{id}
7173
7274
/paths/customers/{id}/get.yaml
@@ -91,8 +93,9 @@ paths:
9193
9294
If you have a lot of nested folders, it may be confusing to reference your schemas.
9395
94-
Example
95-
```
96+
Example:
97+
98+
```yaml
9699
file: /paths/customers/{id}/timeline/{messageId}/get.yaml
97100

98101
# excerpt of file
@@ -101,4 +104,5 @@ file: /paths/customers/{id}/timeline/{messageId}/get.yaml
101104
$ref: ../../../../../components/headers/Rate-Limit-Remaining.yaml
102105

103106
```
107+
104108
Notice the `../../../../../` in the ref which requires some attention to formulate correctly. While openapi-cli has a linter which suggests possible refs when there is a mistake, this is still a net drawback for APIs with deep paths.

sources/academy/platform/get_most_of_actors/actor_readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Aim for sections 1–6 below and try to include at least 300 words. You can move
4646
- This is calculated from carrying out several runs (or from runs saved in the DB).<!-- @Zuzka can help if needed. [Information in this table](https://docs.google.com/spreadsheets/d/1NOkob1eYqTsRPTVQdltYiLUsIipvSFXswRcWQPtCW9M/edit#gid=1761542436), tab "cost of usage". -->
4747
- Here’s an example for this section:
4848

49-
> ## How much will it cost me to scrape Google Maps reviews?
49+
> ## How much will it cost me to scrape Google Maps reviews?
5050
>
5151
> <br/> Apify provides you with $5 free usage credits to use every month on the Apify Free plan and you can get up to 100,000 reviews from this Google Maps Reviews Scraper for those credits. This means 100k results will be completely free!
5252
> <br/> But if you need to get more data or to get your data regularly you should grab an Apify subscription. We recommend our $49/month Starter plan - you can get up to 1 million Google Maps reviews every month with the $49 monthly plan! Or 10 million with the $499 Scale plan - wow!

0 commit comments

Comments
 (0)