You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: openapi/openapi/paths/README.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,22 +16,22 @@ You can adopt any organization you wish. We have some tips for organizing paths
16
16
17
17
Use a predefined "path separator" and keep all of your path files in the top level of the `paths` folder.
18
18
19
-
```
19
+
```yaml
20
20
# todo: insert tree view of paths folder
21
21
```
22
22
23
23
Redocly recommends using the `@` character for this case.
24
24
25
25
In addition, Redocly recommends placing path parameters within `{}` curly braces if you adopt this style.
26
26
27
-
####Motivations
27
+
### Motivations
28
28
29
29
* 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).
30
30
31
31
* 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.
32
32
33
33
34
-
####Drawbacks
34
+
### Drawbacks
35
35
36
36
* This may require multiple definitions per http method within a single file.
37
37
* 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
57
57
### Use subfolders to mirror API path structure
58
58
59
59
Example:
60
-
```
60
+
61
+
```http request
61
62
GET /customers
62
63
63
64
/paths/customers/get.yaml
@@ -66,7 +67,8 @@ GET /customers
66
67
In this case, the path id defined within subfolders which mirror the API URL structure.
67
68
68
69
Example with path parameter:
69
-
```
70
+
71
+
```http request
70
72
GET /customers/{id}
71
73
72
74
/paths/customers/{id}/get.yaml
@@ -91,8 +93,9 @@ paths:
91
93
92
94
If you have a lot of nested folders, it may be confusing to reference your schemas.
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.
Copy file name to clipboardExpand all lines: sources/academy/platform/get_most_of_actors/actor_readme.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ Aim for sections 1–6 below and try to include at least 300 words. You can move
46
46
- 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". -->
47
47
- Here’s an example for this section:
48
48
49
-
> ## How much will it cost me to scrape Google Maps reviews?
49
+
> ## How much will it cost me to scrape Google Maps reviews?
50
50
>
51
51
> <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!
52
52
> <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