Skip to content
New issue

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

By clicking “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? Sign in to your account

Doc fixes; API specs data source versions fix #147

Merged
merged 1 commit into from
Aug 2, 2024

Conversation

joshbeard
Copy link
Contributor

While Doc slugs cannot be set or updated through the API, the provider has a workaround for re-associating a doc in state with a doc in ReadMe when its slug is changed in the web UI.

  • readme_api_specifications data source: fix version filtering by setting the version in the request options to request specs of a certain ReadMe version
    • BREAKING (we're still v0; will increment minor version): Update the version attribute to accept a version number, not ID.
    • This didn't work at all previously, so perhaps not so breaking
  • Allow a doc slug to be set in frontmatter to match
    • This enables the attribute to be set when creating docs in a loop
  • Don't trigger a re-creation of a doc when the value of the slug is changed.
  • Address issue where the bodyClean attribute would report a change after apply
  • Add a few additional log statements

While Doc slugs cannot be set or updated through the API, the provider
has a workaround for re-associating a doc in state with a doc in ReadMe
when its slug is changed in the web UI.

* `readme_api_specifications` data source: fix version filtering by
  setting the version in the request options to request specs of a
  certain ReadMe version
  * BREAKING: Update the `version` attribute to accept a version number, not ID.
  * This didn't work at all previously, so perhaps not so breaking
* Allow a doc slug to be set in frontmatter to match
  * This enables the attribute to be set when creating docs in a loop
* Don't trigger a re-creation of a doc when the value of the slug is changed.
* Address issue where the `bodyClean` attribute would report a change after apply
* Add a few additional log statements
@joshbeard joshbeard self-assigned this Aug 2, 2024
@joshbeard joshbeard requested a review from a team as a code owner August 2, 2024 06:41
@joshbeard joshbeard added bug Something isn't working enhancement New feature or request labels Aug 2, 2024
@joshbeard joshbeard removed the request for review from a team August 2, 2024 06:42
@joshbeard joshbeard marked this pull request as draft August 2, 2024 06:42
@joshbeard joshbeard marked this pull request as ready for review August 2, 2024 06:43
@joshbeard joshbeard requested a review from bdwellons August 2, 2024 06:45
@joshbeard joshbeard merged commit 427baba into LiveOakLabs:main Aug 2, 2024
15 checks passed
@joshbeard joshbeard deleted the doc-slug-fixes branch August 2, 2024 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants