# Latitude 10 Registry API (1.0.0) The API a Latitude 10 project's CI calls: push a version of the project's OpenAPI document and read its readiness report and breaking-change diff, get rules-only fixes as JSON Patch, push the project's docs, and generate its TypeScript and Python SDKs. Every request carries a project key, `Authorization: Bearer l10p_…`, created on the project page under CI keys. The key names the project, so no workspace or project appears in a URL. Quotas are per plan; a request over one answers 429 with `resetsAt`, and retrying before then won't help. Base URL: https://latitude10.tech/api/registry/v1 ## Authentication - projectKey: http, bearer. A project key (l10p_…) from the project page's CI keys. It names the project and can push to it, so keep it in your CI's secrets. ## Versions The project's OpenAPI document, one version per push. ### GET /versions List the project's versions Lists every version of the project's OpenAPI document that the plan keeps, newest first, each with its readiness score and diff counts. The list isn't paginated; a plan keeps at most a few hundred versions. Responses: - 200: The versions, newest first. - 401: No project key was sent, or it was revoked. - 503: The registry is unavailable right now. Try again later. ### POST /versions Push a version of the OpenAPI document Pushes the project's OpenAPI document (3.0 or 3.1, YAML or JSON, bundled into one file) as the request body. The registry scores it with the readiness rules and diffs it against the latest version. Answers 201 with the new version, or 200 with the latest version when the bytes are the same as the latest's, so pushing the same document twice keeps one version. Every push counts toward the daily push quota, the repeated one too. Parameters: - `label` (query, string): A label shown beside the version, such as a short commit SHA or a release tag. Longer than 100 characters, it is cut to 100. Without one, the document's info.version is the label. - `git_sha` (query, string): The Git commit the document was pushed from. - `git_ref` (query, string): The Git ref the document was pushed from. Request body: application/json, required. The OpenAPI document, as YAML or JSON text, up to the plan's document size. Responses: - 200: The document is the same as the latest version's; that version is answered and no new one is made. - 201: The new version. - 401: No project key was sent, or it was revoked. - 403: The project is read-only, because the workspace has more projects than its plan includes. - 409: Another version was pushed at the same moment. Push again. - 413: The document is larger than the plan keeps. - 422: The body isn't an OpenAPI 3.0 or 3.1 document, or it has an external $ref. - 429: A quota of the plan is reached for this period. Wait until resetsAt; retrying sooner answers the same. - 503: The registry is unavailable right now. Try again later. ### GET /versions/latest Get the latest version Answers the newest version of the project's document with its readiness score, its finding count and its breaking-change counts against the version before it. Answers 404 when nothing has been pushed yet. Responses: - 200: The latest version. - 401: No project key was sent, or it was revoked. - 404: This project has no versions yet. - 503: The registry is unavailable right now. Try again later. ### GET /versions/{seq}/report Get a version's readiness report Answers the readiness report stored when the version was pushed, with the score, the rules version, and every rule with its findings and suggested fix. Use it to show why a version scored what it did. Parameters: - `seq` (path, required, string): The version's number, as listed by listVersions. Responses: - 200: The stored report. - 400: seq isn't a version number. - 401: No project key was sent, or it was revoked. - 404: There is no version with that number. - 503: The registry is unavailable right now. Try again later. ### GET /versions/{seq}/source Download a version's document as pushed Answers the version's OpenAPI document byte for byte as it was pushed, as application/json when it was pushed as JSON and application/yaml otherwise. Use it to restore or compare a version. Parameters: - `seq` (path, required, string): The version's number, as listed by listVersions. Responses: - 200: The document as pushed. - 400: seq isn't a version number. - 401: No project key was sent, or it was revoked. - 404: There is no version with that number. - 503: The registry is unavailable right now. Try again later. ### GET /diff Compare two versions Lists what changed between any two versions of the project's document, each change marked breaking, warning or info. The diff stored on push answers when the pair is a version and the one before it; any other pair is computed on request. Parameters: - `from` (query, required, string): The older version's number. - `to` (query, required, string): The newer version's number. Responses: - 200: The changes from one version to the other. - 400: from or to is missing or isn't a version number. - 401: No project key was sent, or it was revoked. - 404: There is no version with that number. - 503: The registry is unavailable right now. Try again later. ## Fixes Rules-only fixes for a document, as JSON Patch. ### POST /fixes Get rules-only fixes for a document Scores the OpenAPI document in the body with the readiness rules and answers the fixes that raise its score, as a JSON Patch to apply to the document, with the score before and after. The fixes come from the rules alone; no model is called, so the same document always gets the same patch. Each call counts toward the workspace's monthly fix runs. Paid plans only. Request body: application/json, required. The OpenAPI document, as YAML or JSON text. Responses: - 200: The fixes, as JSON Patch. - 401: No project key was sent, or it was revoked. - 403: Suggested fixes are part of the paid plans. - 413: The document is larger than the plan reads. - 422: The body isn't an OpenAPI 3.0 or 3.1 document, or it has an external $ref. - 429: A quota of the plan is reached for this period. Wait until resetsAt; retrying sooner answers the same. - 503: The registry is unavailable right now. Try again later. ## Docs The project's hosted docs, pushed as a folder. ### POST /docs Push the docs folder Pushes the project's docs folder as a .tar.gz and builds the hosted docs from it. Without version or preview, the push replaces the production site, and only from the project's docs branch (the first branch pushed, until changed in the workspace). With version=