Updating internal network domain and documentation - #13
Merged
Conversation
Copilot created this pull request from a session on behalf of
Pmaster-dev
August 2, 2026 09:28
View session
Pmaster-dev
marked this pull request as ready for review
August 2, 2026 09:42
Owner
|
@copilot please fix the merge conflicts in this pull request. |
There was a problem hiding this comment.
Pull request overview
This PR rebrands the OpenAPI documentation to the “Magicians VR4Deaf Platform” domain and substantially expands the documented API surface (new internal platform endpoints, schemas, and headers), alongside updating the Node/Redocly project metadata.
Changes:
- Update README and OpenAPI
info,servers, tags, and auth descriptions to usemagicians.vr4deaf.organdinternal.magicians.vr4deaf.org. - Add new OpenAPI paths for internal platform capabilities (network, registry, vendors, rate, rules, npx, ingress, db) plus related schemas/headers and a new webhook.
- Rename the npm package and add a
package-lock.json.
Reviewed changes
Copilot reviewed 35 out of 36 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Rewritten project documentation (base URLs, auth, dev workflow, file layout). |
| package.json | Renames the npm package to magicians-platform-api. |
| package-lock.json | Introduces npm lockfile for the Redocly CLI dependency set. |
| openapi/openapi.yaml | Rebrands the root spec metadata and adds many new paths/tags/scopes/security schemes/webhooks. |
| openapi/paths/users_{username}.yaml | Updates example email domain. |
| openapi/paths/network.yaml | Adds network node listing endpoint. |
| openapi/paths/network_status.yaml | Adds network aggregated status endpoint. |
| openapi/paths/registry.yaml | Adds registry list/publish endpoints. |
| openapi/paths/registry_{package}.yaml | Adds registry package detail/unpublish endpoint. |
| openapi/paths/vendors.yaml | Adds vendor list/register endpoints. |
| openapi/paths/vendors_{vendorId}.yaml | Adds vendor get/update/delete endpoints. |
| openapi/paths/rate.yaml | Adds rate policy list/create endpoints. |
| openapi/paths/rate_{resource}.yaml | Adds rate policy get/update/delete endpoints. |
| openapi/paths/rules.yaml | Adds rules list/create endpoints. |
| openapi/paths/rules_{ruleId}.yaml | Adds rule get/update/delete endpoints. |
| openapi/paths/rules_{ruleId}_evaluate.yaml | Adds rule evaluation endpoint. |
| openapi/paths/npx.yaml | Adds NPX job list/submit endpoints. |
| openapi/paths/npx_{jobId}.yaml | Adds NPX job status/cancel endpoints. |
| openapi/paths/ingress.yaml | Adds ingress route list/create endpoints. |
| openapi/paths/ingress_{routeId}.yaml | Adds ingress route get/update/delete endpoints. |
| openapi/paths/db.yaml | Adds database schema list endpoint. |
| openapi/paths/db_{schema}.yaml | Adds database schema detail/update endpoint. |
| openapi/components/schemas/User.yaml | Updates externalDocs URL for user ID. |
| openapi/components/schemas/Email.yaml | Updates email example domain. |
| openapi/components/schemas/Vendor.yaml | Adds Vendor schema for vendor integration endpoints. |
| openapi/components/schemas/Rule.yaml | Adds Rule schema for rules engine endpoints. |
| openapi/components/schemas/RuleEvent.yaml | Adds RuleEvent schema for the new webhook payload. |
| openapi/components/schemas/RegistryPackage.yaml | Adds RegistryPackage schema for registry endpoints. |
| openapi/components/schemas/RatePolicy.yaml | Adds RatePolicy schema for rate management endpoints. |
| openapi/components/schemas/NpxJob.yaml | Adds NpxJob schema for NPX endpoints. |
| openapi/components/schemas/NetworkNode.yaml | Adds NetworkNode schema for network endpoints. |
| openapi/components/schemas/IngressRoute.yaml | Adds IngressRoute schema for ingress management endpoints. |
| openapi/components/schemas/DatabaseSchema.yaml | Adds DatabaseSchema schema for db proxy endpoints. |
| openapi/components/headers/Rate-Limit-Limit.yaml | Adds reusable rate-limit header component. |
| openapi/components/headers/Rate-Limit-Remaining.yaml | Adds reusable rate-limit header component. |
| openapi/components/headers/Rate-Limit-Reset.yaml | Adds reusable rate-limit header component. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Prerequisites | ||
|
|
||
| ### Schemas | ||
| - [Node.js](https://nodejs.org/) ≥ 18 |
Comment on lines
+7
to
+10
| security: | ||
| - service_token: [] | ||
| - main_auth: | ||
| - 'read:users' |
Comment on lines
+7
to
+10
| security: | ||
| - service_token: [] | ||
| - main_auth: | ||
| - 'read:users' |
| @@ -0,0 +1,85 @@ | |||
| get: | |||
| @@ -0,0 +1,27 @@ | |||
| get: | |||
Comment on lines
+105
to
+112
| '/network': | ||
| $ref: 'paths/network.yaml' | ||
| '/network/status': | ||
| $ref: 'paths/network_status.yaml' | ||
| '/registry': | ||
| $ref: 'paths/registry.yaml' | ||
| '/registry/{package}': | ||
| $ref: 'paths/registry_{package}.yaml' |
Contributor
Author
Fixed in |
Owner
|
@copilot Fix the code for all comments in this review thread. When a review comment includes a suggested change, apply the suggestion exactly. Do not make changes beyond what is described in the linked review thread. |
Contributor
Author
Fixed in |
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull request created by AI Agent