Skip to content

Commit

Permalink
Expand the contributing section
Browse files Browse the repository at this point in the history
  • Loading branch information
bbotella committed Jan 31, 2025
1 parent c005214 commit 623590c
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,18 @@ Within that project, the classes should all be named `Cassandra40*`, so `Cassand

### <a name="rest-apis"></a>REST APIs
The project maintains an Open API documentation of all the provided REST APIs, located in `server/src/main/resources/openAPI`.
When an API is modified or updated, this documentation needs to be maintained accordingly.
When an API is modified or updated, this documentation needs to be maintained accordingly. For that, please take a look at the folder structure
for the openAPI specification. The main file is called `sidecarApi.yaml`. There, all the endpoints are referenced. Let's take the health endpoint
as an example:
```yaml
paths:
/__health:
$ref: paths/__health.yaml
```
That references the definition of the health endpoint, which can be found on the `paths` folder. On those references, we can find further references
to their specific object schemas (which can be found under the `components/schemas` folder). For any common or shared parameters, please use
the `components/parameters folder`.

## <a name="source-code-style"></a>Source Code Style

Expand Down

0 comments on commit 623590c

Please sign in to comment.