Skip to content

Commit 320b9ca

Browse files
authored
chore: mention the new API docs in CONTRIBUTING.md (#1255)
1 parent 62c9729 commit 320b9ca

File tree

1 file changed

+2
-10
lines changed

1 file changed

+2
-10
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,9 @@ In [`./nginx.conf`](./nginx.conf) you can find the production version of the Ngi
4141

4242
### API reference
4343

44-
The `./sources/platform/api_v2` directory contains the source file for the API reference (<https://docs.apify.com/api/v2>) hosted on [Apiary](https://apiary.io/). The build script contained in the `./tools` folder automatically uploads the API docs to Apiary during the web deployment process.
44+
The API reference at (<https://docs.apify.com/api/v2>) is built directly from the OpenAPI specification of our API, versioned at https://github.com/apify/openapi.
4545

46-
#### Local testing
47-
48-
1. Install Apiary gem `gem install apiaryio`
49-
2. Open the generated doc with the command: `apiary preview --path="./sources/platform/api_v2/api_v2_reference.apib"`
50-
3. Log into [Apiary](https://apiary.io/) to get the document analyzed for warnings (there is no automatic linter)
51-
52-
#### Pre-release testing
53-
54-
After updating the API docs, you should ALWAYS log into [Apiary](https://apiary.io/), analyze the document, and make sure there are **no warnings**!
46+
For contribution details regarding the OpenAPI specification, consult the related [contribution guide](https://github.com/apify/openapi?tab=readme-ov-file#contribution-guide).
5547

5648
### Homepage
5749

0 commit comments

Comments
 (0)