Closed Bug 1456418 Opened 7 years ago Closed 7 years ago

taskcluster-lib-api should automatically publish api-references.json somewhere, and use that location in generated schemas $schema property

Categories

(Taskcluster :: Services, enhancement)

enhancement
Not set
normal

Tracking

(Not tracked)

RESOLVED DUPLICATE of bug 1433672

People

(Reporter: pmoore, Unassigned)

Details

Currently taskcluster-lib-api generates schemas like: { "version": 0, "$schema": "http://schemas.taskcluster.net/base/v1/api-reference.json#", "title": "Authentication API", .... } with an embedded reference to "http://schemas.taskcluster.net/base/v1/api-reference.json#" (see above). The schema actually comes from: * https://raw.githubusercontent.com/taskcluster/taskcluster-lib-api/master/src/schemas/api-reference.json These two schemas are out of sync with each other, because there is no automatic publish, and humans routinely forget (or don't know) to update it. We need to make sure that the generated schemas refer to a URL which returns the correct api-reference.json document, in order not to be misleading. This schema validation is used in taskcluster client code generation.
I agree! I think having these stay in sync automatically is important. We should be able to publish on tag using travis to push a new copy of the schema live for each push of the master branch.
Ah, it looks like I've filed this before ... Sorry!
Status: NEW → RESOLVED
Closed: 7 years ago
Resolution: --- → DUPLICATE
Component: Platform Libraries → Services
You need to log in before you can comment on or make changes to this bug.