feat(onboard): add apx onboard command for brownfield API onboarding - #44
Open
kfritchman46 wants to merge 1 commit into
Open
feat(onboard): add apx onboard command for brownfield API onboarding#44kfritchman46 wants to merge 1 commit into
kfritchman46 wants to merge 1 commit into
Conversation
Adds `apx onboard <api-id>` to scaffold the publish-on-change workflow for existing service repositories without restructuring them. Generated files: - apx.yaml: APX workspace config - .apx-publish.yaml: module manifest (supports proto, openapi, jsonschema, avro, parquet, crd formats) - Makefile fds target: buf or atlas-gentool based (skipped for non-FDS formats) - .github/workflows/api-catalog-pr.yml + api-catalog-publish.yml: thin reusable workflow callers, or fully inline workflows for atlas-gentool repos that need go mod vendor with private-repo auth before make fds - .gitignore: APX artifact entries Format-aware behaviour: - proto/openapi: emits fds_target, fds: field, Makefile target, and FDS gitignore entry; atlas-gentool + go.mod repos get inline workflows with GITPAT netrc auth kept alive for vendor-atlas during make fds - jsonschema/avro/parquet/crd: emits format-keyed schema field (e.g. jsonschema:), skips Makefile and fds gitignore entry, uses thin callers New flags: --schema-file, --go-private, --proto-file, --schema-dir, --swagger, --lifecycle, --audience, --fds-output, --canonical-repo, --default-branch, --org, --repo, --non-interactive Also adds brownfield onboarding doc and cross-links from quickstart, tutorial, and layout pages.
daniel-garcia
approved these changes
Aug 8, 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
2 participants
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.
Summary
apx onboard <api-id>command to scaffold the publish-on-change workflow for existing service repositories without restructuring themfdsMakefile target and FDS-based manifest; jsonschema/avro/parquet/crd repos get a<format>:schema field and skip the Makefile step entirelygo.modget fully inline workflows that keep GITPAT netrc auth alive acrossgo mod vendorandmake fds(needed forvendor-atlasMakefile prerequisite); all other repos get thin reusable workflow callersNew flags
--canonical-repo,--schema-file,--proto-file,--schema-dir,--swagger,--lifecycle,--audience,--fds-output,--default-branch,--go-private,--org,--repo,--non-interactiveTest plan
apx onboard proto/... --proto-file ...on an atlas-gentool repo — verify inline workflow with GITPAT netrc is generatedapx onboard jsonschema/... --schema-file ...— verifyjsonschema:field, no Makefile target, thin workflow callersapx onboard openapi/... --schema-dir ...(buf repo) — verify buf Makefile target and thin callers--non-interactivewith missing--canonical-reporeturns an error