Skip to content

Commit

Permalink
fix sample links
Browse files Browse the repository at this point in the history
  • Loading branch information
YuriyDurov committed Sep 29, 2023
1 parent f7ff084 commit 57d6189
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/1.introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ We hope you find this documentation helpful, and we welcome your feedback and co

The OCPI.Net package is a .NET implementation for the the Open Charge Point Interface (OCPI) protocol, which is used for communication between electric vehicle charging stations and charging station operators.

Make sure to check out this [Sample application](sample/OCPI.Net.Sample) for a working example of how to use the package.
Make sure to check out this [Sample application](/sample/OCPI.Net.Sample) for a working example of how to use the package.


## Benefits of using OCPI.Net
Expand Down
2 changes: 1 addition & 1 deletion docs/3.implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Previous topic:

# Implementation

You can always refer to the [Sample application](sample/OCPI.Net.Sample) for a working example of how to use the package.
You can always refer to the [Sample application](/sample/OCPI.Net.Sample) for a working example of how to use the package.

## How to implement OCPI modules using OCPI.Net

Expand Down
2 changes: 1 addition & 1 deletion docs/4.versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Refer to the [Implementation](3.implementation.md) section for more information

After you have marked your OCPI controllers with the `OcpiEndpoint` attribute, the package becomes aware of the OCPI versions supported by each controller. The package will automatically generate a list of supported OCPI versions for each module.

An [example](sample/OCPI.Net.Sample/Controllers/OcpiVersionsController.cs) of how to implement the OCPI Versions module is provided in the [Sample application](sample/OCPI.Net.Sample).
An [example](/sample/OCPI.Net.Sample/Controllers/OcpiVersionsController.cs) of how to implement the OCPI Versions module is provided in the [Sample application](sample/OCPI.Net.Sample).

In your Versions Module controller, inject the `IOcpiVersionsService` service and use it to retrieve the list of supported OCPI versions for each module:

Expand Down
2 changes: 1 addition & 1 deletion docs/6.pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Previous topic:

The OCPI.Net package uses some classes from the [BitzArt.Pagination](https://github.com/BitzArt/Pagination) nuget package to handle paginated endpoints. Refer to it for guidance on how to use the pagination functionality.

There is an [example](/sample/OCPI.Net.Sample/Controllers/OcpiLocationsSenderController.cs) controller with a paginated OCPI method in this reposiory. Refer to it if having trouble implementing OCPI paginated endpoints.
There is an [example](/sample/OCPI.Net.Sample/Controllers/OcpiLocationsSenderController.cs) controller with a paginated OCPI method in this reposiory. Refer to it if you are having trouble implementing OCPI paginated requests.

Make sure you call the `SetMaxLimit(pageRequest, maxLimit);` method in your paginated request implementations. This will ensure that the client cannot request more than the maximum allowed number of items per page. This is required by OCPI in order to set the `X-Limit` response header.

Expand Down

0 comments on commit 57d6189

Please sign in to comment.