[codex] Document live key organization config#261
Open
javorosas wants to merge 1 commit into
Open
Conversation
99ab4f3 to
e996f03
Compare
e996f03 to
84a7ab8
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Documents that an organization's Live Secret Key (sk_live_*) can configure its own operational data (using me as alias), restricts the Test Secret Key to read-only access of its own organization, and keeps the User Secret Key as the required credential for organization/user/role/invite/API-key administration. Updates OpenAPI v2 (Spanish + English) security blocks accordingly and adds a new PUT /organizations/{organization_id}/fiel endpoint.
Changes:
- Remove
SecretTestKeyfrom organization configuration endpoints and from User-only administration endpoints in both OpenAPI specs; clarify Live API Key endpoint semantics (Crear/Create Live API Key). - Add a new
PUT /organizations/{organization_id}/fielendpoint allowingSecretLiveKey/SecretUserKey, including a cURL sample andmealias documentation. - Update conceptual docs (concepts, organizations, organization-onboarding) in Spanish and English to reflect the new credential capabilities and FIEL purpose (bulk CFDI downloads).
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| website/openapi_v2.yaml | Adjusts security blocks across organization endpoints, adds FIEL endpoint, refines Live API Key copy, updates Organization.fiel description. |
| website/openapi_v2.en.yaml | English mirror of the OpenAPI changes above. |
| website/docs/getting-started/concepts.md | Clarifies role and secret-key capabilities (Live can configure own org; Test is read-only for its org). |
| website/i18n/en/docusaurus-plugin-content-docs/current/getting-started/concepts.md | English equivalent of the concepts updates. |
| website/docs/guides/organizations.mdx | Explains User vs Live Key responsibilities and me alias usage. |
| website/i18n/en/docusaurus-plugin-content-docs/current/guides/organizations.mdx | English equivalent of the organizations guide updates. |
| website/docs/getting-started/organization-onboarding.mdx | Documents API automation with User/Live Keys and CSD vs FIEL distinction. |
| website/i18n/en/docusaurus-plugin-content-docs/current/getting-started/organization-onboarding.mdx | English equivalent of the onboarding guide updates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
84a7ab8 to
e4dfa0f
Compare
raul-facturapi
approved these changes
Jun 2, 2026
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.
Resumen
sk_live_*) o con User Secret Key.sk_test_*) solo puede consultar la información de su propia organización y no modificar configuración.Relacionado
Validación
ruby -e 'require "yaml"; YAML.load_file("website/openapi_v2.yaml"); YAML.load_file("website/openapi_v2.en.yaml")'yarn --cwd website typecheckyarn --cwd website buildgit diff --check