Skip to content

docs(api): clarify Server API path prefixes (Issue #51) #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Richardpwe wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(api): clarify Server API path prefixes (Issue #51) #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions v1/specification/docs/Specification_Server_API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,15 @@ The OGraf Server API is defined as an [OpenAPI](https://www.openapis.org/) defin

## Additional notes

### Base URL and path prefixes

A Server MAY expose the OGraf Server API under any base URL and path prefix.
All paths defined in the OpenAPI document are relative to that base URL.

For example, if the base URL is `https://example.com/my/prefix/ograf/v1`, the OpenAPI path `/graphics` is available at `https://example.com/my/prefix/ograf/v1/graphics`.

The `/ograf/v1` path prefix used in examples is allowed, but not required.

### Security (optional)

* The current version of the Server API doesn't specify any security measures.
Expand Down