Skip to content

[codex] Document live key organization config#261

Open
javorosas wants to merge 1 commit into
mainfrom
codex/live-key-organization-config-docs
Open

[codex] Document live key organization config#261
javorosas wants to merge 1 commit into
mainfrom
codex/live-key-organization-config-docs

Conversation

@javorosas
Copy link
Copy Markdown
Member

@javorosas javorosas commented May 28, 2026

Resumen

  • Documenta que una organización existente puede configurar sus datos operativos con su propia Live Secret Key (sk_live_*) o con User Secret Key.
  • Aclara que la Test Secret Key (sk_test_*) solo puede consultar la información de su propia organización y no modificar configuración.
  • Mantiene la User Secret Key como requisito para crear organizaciones, administrar usuarios/roles/invitaciones y administrar API keys.
  • Aclara que la suscripción se activa desde dashboard o el flujo de billing correspondiente.
  • Actualiza OpenAPI v2 en español e inglés para reflejar las credenciales permitidas por endpoint.
  • Agrega documentación OpenAPI para subir FIEL por API y aclara que FIEL es para descarga masiva de CFDI, no para crear CFDI.

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 typecheck
  • yarn --cwd website build
  • git diff --check

@javorosas javorosas force-pushed the codex/live-key-organization-config-docs branch 2 times, most recently from 99ab4f3 to e996f03 Compare May 28, 2026 11:14
@javorosas javorosas requested a review from Copilot May 28, 2026 12:16
@javorosas javorosas marked this pull request as ready for review May 28, 2026 12:16
@javorosas javorosas force-pushed the codex/live-key-organization-config-docs branch from e996f03 to 84a7ab8 Compare May 28, 2026 12:20
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 SecretTestKey from 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}/fiel endpoint allowing SecretLiveKey/SecretUserKey, including a cURL sample and me alias 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.

Comment thread website/openapi_v2.yaml Outdated
Comment thread website/openapi_v2.en.yaml Outdated
@javorosas javorosas requested a review from raul-facturapi May 28, 2026 12:23
@javorosas javorosas self-assigned this May 28, 2026
@javorosas javorosas force-pushed the codex/live-key-organization-config-docs branch from 84a7ab8 to e4dfa0f Compare May 28, 2026 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants