Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

90 lines (56 loc) · 1.49 KB
Raw

Contributing

Important

  • Go into the Markdown Source Code to get the actual formatting
  • Only contribute if you actually know what you are doing and talking about on the API / Operation
  • If you modify multiple files dont make a commit for each file, rather for each service
  • Good Naming for PRs, Issues, Commits... (NOT modified file.md, say what you want / changed)
  • Markdown formatting (Visual Studio Code)
  • Include an example response (shortened)

APIs

[h2] {Service} - {Topic}: {What}

{optional_description}

URL: {URL}
Method: {Method}
Auth Required: {Yes/No} ({Permission})

[h2] Headers [if required]

<key>: <description>


[JSON Code Block] [if required]

<Body>

[h2] Path Parameters [if required]

<key>: <description>


[h2] Parameters [if required]

<key>: <description>


[h2] Query Parameters [if required]

<key>: <description>

--- Horizontal Line

*Example Response*

[JSON] Codeblock / Note which Status to expect if no content is returned

{
  "hello": "world"
}

MCP Operations

[h1] {Operation}

Description: {description}
Profiles: {profile_id_1}, {profile_id_2}

Body

[JS Code Block]

{
    "{property_name}": "{example_value}" // {property_description}
}

[Property Description]:

  • 1 Space after the Comment Start
  • Dont use all LowerCase e.g. "item guid" -> "Item GUID"
  • If its an enum, then include all possible values