SG-43389 - Add OpenAPI 3.0.3 spec for the Python API

[camiloleal-globant]

SG-43389

What was done:

Added docs/openapi/spec.yaml an OpenAPI 3.0.3 description of the Flow Production Tracking
Python API (shotgun_api3). Content is sourced directly from the
API Reference documentation.

Test:

• Validated syntax with npx @redocly/cli lint docs/openapi/spec.yaml. 0 errors
• Rendered interactive docs with npx @redocly/cli build-docs docs/openapi/spec.yaml to verify output
• Alternatively, paste the file into editor.swagger.io or redocly.com/editor for a visual review

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.66%. Comparing base (921114c) to head (8078ab0).

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #447   +/-   ##
=======================================
  Coverage   78.66%   78.66%           
=======================================
  Files           7        7           
  Lines        1842     1842           
=======================================
  Hits         1449     1449           
  Misses        393      393           

Flag	Coverage Δ
Linux	78.66% <ø> (ø)
Python-3.10	78.61% <ø> (ø)
Python-3.11	78.61% <ø> (ø)
Python-3.13	78.61% <ø> (ø)
Python-3.9	78.59% <ø> (ø)
Windows	78.75% <ø> (ø)
macOS	78.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[julien-lang]

I think the real name is "Flow Production Tracking API3" or FlowPT API3.
Python API is just the name of this repository

[julien-lang]

Ok does that mean we need to update that field every time we release a new version to this library?

Basically, is this file describing the client library or the API? If it's the API, it might not be the best place to put it.