refactor: improve api schema #2109

suhailkakar · 2024-03-22T08:45:09Z

What does this pull request do? Explain your changes. (required)

fixes many issues and improves the api schema file

Specific updates (required)

format yaml file
add operationId to all endpoints
marked rooms api as deprected
categories endpoints by tags
- stream
- asset
- webhook
- multistream
- session
- room
- transcode
- metrics
- playback
- access control
moved unused components to db-schema
add examples to many components
override name for sdk generation (so response method will always be res.data instead of res.classes or res.object
override operation name for sdk generation (to make sdk methods a lot nices like livepeer.asset.create or livepeer.stream.get

How did you test each of these updates (required)

Does this pull request close any open issues?

Screenshots (optional)

Checklist

I have read the CONTRIBUTING document.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.

vercel · 2024-03-22T08:45:14Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
livepeer-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 23, 2024 0:58am

packages/api/src/schema/api-schema.yaml

0xcadams

LGTM, some tiny nits

packages/api/src/schema/api-schema.yaml

victorges

Awesome!!

packages/api/src/schema/api-schema.yaml

packages/api/src/schema/db-schema.yaml

Co-authored-by: Victor Elias <victor@livepeer.org>

…schema-fix

victorges

LGTM!

victorges · 2024-04-22T23:09:04Z

packages/api/src/compile-schemas.js

@@ -72,7 +72,17 @@ const data = _.merge({}, apiData, dbData);
  const indexPath = path.resolve(validatorDir, "index.js");
  write(indexPath, indexStr);

-  const typeStr = types.join("\n");
+  const typeDefinition = `export type InputCreatorId =


So weird that this was necessary. Did you get to understand why it was being generated twice?

victorges · 2024-04-22T23:12:15Z

packages/api/src/schema/api-schema.yaml

    input-creator-id:
      oneOf:
-        - $ref: "#/components/schemas/creator-id"


Can we keep the inline $ref given the fix on compile-schemas.js? Or is this part of the fix?

packages/api/src/schema/api-schema.yaml

victorges · 2024-04-22T23:17:25Z

packages/api/src/schema/api-schema.yaml

+        objectStoreId:
+          type: string
+          description: Object store ID where the asset is stored
+          writeOnly: true
+          example: 09F8B46C-61A0-4254-9875-F71F4C605BC7
+        catalystPipelineStrategy:
+          $ref: "#/components/schemas/task/properties/params/properties/upload/properties/catalystPipelineStrategy"


I think these 2 fields should be moved to db-schema since they're somewhat internal

* Stick to the pull host while triggering the catalyst pull start (#2138) * Revert "Stick to the pull host while triggering the catalyst pull start (#2138)" (#2141) This reverts commit 29ad25a. * Stick to the pull host while triggering the catalyst pull start (#2142) * api: ingest: direct base & playback (#2139) * api: ingest: direct base & playback * fix * fix * implement for a specific hardcoded id for tests * fix * fix * api: Handle active cleanup from pull lock API (#2144) * refactor: improve api schema (#2109) * format yaml * add operationId to all endpoints * marked rooms api as deprecated * add tags to each endpoints * moved unused components to db-schema * add examples * override name for sdk generation * override operation name for sdk generatino * run prettier & fix typo * Update packages/api/src/schema/api-schema.yaml Co-authored-by: Victor Elias <victor@livepeer.org> * Update packages/api/src/schema/api-schema.yaml Co-authored-by: Victor Elias <victor@livepeer.org> * Update packages/api/src/schema/api-schema.yaml Co-authored-by: Victor Elias <victor@livepeer.org> * Update api-schema.yaml * fix: build error * revert: add new-asset-from-url-payload to api-schema.yaml * Update api-schema.yaml * fix build issue * hardcoded inputcreator filter * fix: create stream and loosening schema (#2134) * Update compile-schemas.js * fix: tsconfig * fix: revert additionalproperties * fix: remove InputCreatorId unknown * fix: api schema * fix: api schema * fix: revert changes to additional properties * fix: fixes from review * fix: lint --------- Co-authored-by: Victor Elias <victor@livepeer.org> Co-authored-by: Chase Adams <c@cadams.io> * api: Query isHealthy field as a string to handle JSOnull (#2143) * api: Query isHealthy field as a string to handle JSOnull * api: Add check on boolean fields filter value * api: moved objectStoreId and catalystPipelineStrategy to db schema (#2146) * api: moved params to db schema * Update db-schema.yaml * remove url * api: fix direct playback api (#2147) * fix june trigger (#2145) * fix sending track multiple times * add missing imports * replace track with page method --------- Co-authored-by: Rafał Leszko <rafal@livepeer.org> Co-authored-by: gioelecerati <50955448+gioelecerati@users.noreply.github.com> Co-authored-by: Victor Elias <victor@livepeer.org> Co-authored-by: Chase Adams <c@cadams.io>

suhailkakar added 8 commits March 21, 2024 20:32

format yaml

068c21e

add operationId to all endpoints

46ae0c7

marked rooms api as deprecated

b81cfad

add tags to each endpoints

d06d507

moved unused components to db-schema

347c46c

add examples

eedee68

override name for sdk generation

7480851

override operation name for sdk generatino

f14d6aa

suhailkakar requested a review from a team as a code owner March 22, 2024 08:45

hjpotter92 reviewed Mar 22, 2024

View reviewed changes

packages/api/src/schema/api-schema.yaml Outdated Show resolved Hide resolved

suhailkakar marked this pull request as draft March 22, 2024 08:54

run prettier & fix typo

bbe28b9

vercel bot had a problem deploying to Preview March 22, 2024 09:01 Failure

suhailkakar requested review from 0xcadams and victorges March 22, 2024 15:24

0xcadams approved these changes Mar 22, 2024

View reviewed changes

packages/api/src/schema/api-schema.yaml Outdated Show resolved Hide resolved

packages/api/src/schema/api-schema.yaml Outdated Show resolved Hide resolved

packages/api/src/schema/api-schema.yaml Show resolved Hide resolved

victorges approved these changes Mar 22, 2024

View reviewed changes

suhailkakar and others added 3 commits April 9, 2024 21:37

Update packages/api/src/schema/api-schema.yaml

7278f8c

Co-authored-by: Victor Elias <victor@livepeer.org>

Update packages/api/src/schema/api-schema.yaml

58492d3

Co-authored-by: Victor Elias <victor@livepeer.org>

Update packages/api/src/schema/api-schema.yaml

eb80500

Co-authored-by: Victor Elias <victor@livepeer.org>

vercel bot had a problem deploying to Preview April 9, 2024 16:11 Failure

adamsoffer marked this pull request as ready for review April 9, 2024 20:05

suhailkakar added 2 commits April 10, 2024 01:47

Update api-schema.yaml

c784035

Merge branch 'master' into schema-fix

cc9d080

vercel bot had a problem deploying to Preview April 9, 2024 20:21 Failure

suhailkakar added 2 commits April 10, 2024 01:58

fix: build error

ea487c0

Merge branch 'schema-fix' of https://github.com/livepeer/studio into …

ff2a865

…schema-fix

vercel bot had a problem deploying to Preview April 9, 2024 20:32 Failure

revert: add new-asset-from-url-payload to api-schema.yaml

a5c7413

vercel bot had a problem deploying to Preview April 9, 2024 20:36 Failure

fix build issue

a7cc13c

vercel bot deployed to Preview April 12, 2024 08:31 View deployment

hardcoded inputcreator filter

096e38f

vercel bot deployed to Preview April 12, 2024 10:47 View deployment

fix: create stream and loosening schema (#2134)

bf96c1e

vercel bot had a problem deploying to Preview April 16, 2024 22:02 Failure

Update compile-schemas.js

376be92

vercel bot had a problem deploying to Preview April 16, 2024 22:08 Failure

fix: tsconfig

bbc51d8

suhailkakar requested a review from a team as a code owner April 17, 2024 22:17

vercel bot had a problem deploying to Preview April 17, 2024 22:17 Failure

fix: revert additionalproperties

db5a78a

vercel bot had a problem deploying to Preview April 17, 2024 22:24 Failure

fix: remove InputCreatorId unknown

22fada2

vercel bot had a problem deploying to Preview April 17, 2024 22:27 Failure

fix: api schema

d0c044c

vercel bot deployed to Preview April 17, 2024 23:19 View deployment

fix: api schema

946268c

vercel bot deployed to Preview April 19, 2024 20:43 View deployment

fix: revert changes to additional properties

2722696

vercel bot deployed to Preview April 19, 2024 21:08 View deployment

victorges approved these changes Apr 22, 2024

View reviewed changes

fix: fixes from review

cce32a1

vercel bot deployed to Preview April 23, 2024 00:52 View deployment

fix: lint

8122ff5

vercel bot deployed to Preview April 23, 2024 00:58 View deployment

0xcadams merged commit 47dbc3c into master Apr 23, 2024
13 checks passed

0xcadams deleted the schema-fix branch April 23, 2024 15:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: improve api schema #2109

refactor: improve api schema #2109

suhailkakar commented Mar 22, 2024

vercel bot commented Mar 22, 2024 •

edited

0xcadams left a comment

victorges left a comment

victorges left a comment

victorges Apr 22, 2024

victorges Apr 22, 2024

victorges Apr 22, 2024

refactor: improve api schema #2109

refactor: improve api schema #2109

Conversation

suhailkakar commented Mar 22, 2024

vercel bot commented Mar 22, 2024 • edited

0xcadams left a comment

Choose a reason for hiding this comment

victorges left a comment

Choose a reason for hiding this comment

victorges left a comment

Choose a reason for hiding this comment

victorges Apr 22, 2024

Choose a reason for hiding this comment

victorges Apr 22, 2024

Choose a reason for hiding this comment

victorges Apr 22, 2024

Choose a reason for hiding this comment

vercel bot commented Mar 22, 2024 •

edited