LukeParke/plex-api-spec
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-api-spec.git synced 2025-12-06 12:37:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

swapped to general operation ID example

Browse Source
This commit is contained in:
Luke Hagar
2024-09-11 18:24:44 +00:00
parent 6e58229600
commit 86a1731051
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -53,7 +53,7 @@ The file should contain data in the following order:
- example # a list of tags that the endpoint belongs to, this is used for grouping in the documentation and SDKs - example # a list of tags that the endpoint belongs to, this is used for grouping in the documentation and SDKs
summary: a brief description of the endpoint summary: a brief description of the endpoint
description: a more detailed description of the endpoint description: a more detailed description of the endpoint
operationId: getLibrarySections # camel case summarizing the action being performed. operationId: anExampleOperationId # camel case summarizing the action being performed.
parameters: # parameters are defined in the /parameters directory, or inline if they are not reused very much parameters: # parameters are defined in the /parameters directory, or inline if they are not reused very much
- $ref: "../../parameters/..." # a reference to a parameter file in the /parameters directory - $ref: "../../parameters/..." # a reference to a parameter file in the /parameters directory
- name: example # a parameter that is not a reference - name: example # a parameter that is not a reference