Skip to content

add docs for staged configs phase 2 #489

New issue

Have a question about this project? No Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “No Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? No Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

vivki
Copy link
Contributor

@vivki vivki commented May 2, 2025

Proposed changes

Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:

Problem: Give a brief overview of the problem or feature being addressed.

Solution: Explain the approach you took to implement the solution, highlighting any significant design decisions or
considerations.

Testing: Describe any testing that you did.

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

If this PR addresses an issue on GitHub, ensure that you link to it here:

Closes #ISSUE

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

@vivki vivki requested a review from a team as a code owner May 2, 2025 16:42
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 2, 2025
@vivki vivki marked this pull request as draft May 2, 2025 16:42
"type": "boolean",
"default": false
},
"description": "Optional flag to control how the request is processed.\n - When `false` or omitted (by default), the request creates a Staged Config directly. (`StagedConfigCreateResponse`)\n - When `true`, the request parses the import and returns metadata you can use to create a Staged Config through a POST. ( `StagedConfigCreateRequest`) \n",
Copy link
Contributor

Choose a reason for hiding this comment

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

returns metadata you can use to create a Staged Config through a POST.

This raises questions:

  • Which POST? (which endpoint)
  • How would you use the metadata to create a Staged Config? (Would it be enough to enter the metadata as a part fo the REST call, or do you have to do more?)

@mjang
Copy link
Contributor

mjang commented May 2, 2025

@vivki Thanks for the draft. I see (at least most) of what you're doing for import/export with the following "flag": "staged-configs-phase-2"

I presume that feature flag still blocks what's shown in the API docs. (You can see for yourself. Take your repo, and follow the steps in https://github.com/nginx/documentation/blob/main/CONTRIBUTING_DOCS.md. Run the make watch command, and you'll have a local build in localhost:1313.

No Sign up for free to join this conversation on GitHub. Already have an account? No Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants